com.groiss.cal

Interface CalInfo

All Known Implementing Classes:

CalInfoAdapter

public interface CalInfo

Source for Calendar Events.

Method Summary

Modifier and Type	Method and Description
default String	getArguments() Return some argument string, if in one CalInfo implementation you want to distinguish different behaviours (return different event lists).
default List<Pair<String,String>>	getCaptions() Return all possible captions for this CalInfo.
default String	getClassName() return the classname of the cal-source - should be getClass().getName();
String	getName() Returns the name of this CalInfo.
default List<Pair<String,String>>	getPossibleViews(User u) Get all possible views for this user.
default CalView	getView(String id, User u) Returns the view with the given id for the user.
default MultiMap<Persistent,CalEvent>	listEvents(List<Persistent> objects, Date startDate, Date endDate) This function returns a bunch of dates for each passed object
default void	setArguments(String arguments) The arguments defined in getArguments are set to the instance.

Method Detail

listEvents

default MultiMap<Persistent,CalEvent> listEvents(List<Persistent> objects,
                                                 Date startDate,
                                                 Date endDate)

This function returns a bunch of dates for each passed object

Parameters:

objects - the objects the dates should be for

startDate - range startdate

endDate - range endtime

Returns:

MultiMap of dates occuring in the range of time

getName

String getName()

Returns the name of this CalInfo.

Returns:

the name

getClassName

default String getClassName()

return the classname of the cal-source - should be getClass().getName();

getCaptions

default List<Pair<String,String>> getCaptions()

Return all possible captions for this CalInfo.

Returns:

list of Pairs, first element: name of a css class, second element a description text.

getView

default CalView getView(String id,
                        User u)

Returns the view with the given id for the user.

Parameters:

id - the view's id

u - the current user

Returns:

the view

getPossibleViews

default List<Pair<String,String>> getPossibleViews(User u)

Get all possible views for this user. This is currently not used.

Parameters:

u - the current user

Returns:

a list with all possible views
Pair.first the view's id - getView(String, User) should be able to handle this id
Pair.second the view's name

getArguments

default String getArguments()

Return some argument string, if in one CalInfo implementation you want to distinguish different behaviours (return different event lists). For example, one instance returns 'all', another 'private'.

setArguments

default void setArguments(String arguments)

The arguments defined in getArguments are set to the instance. This is called before listEvents is called.

Parameters:

arguments -