| com.ivata.groupware.business.calendar.Calendar
All known Subclasses: com.ivata.groupware.business.calendar.CalendarImpl, com.ivata.groupware.business.calendar.CalendarBean,
| Calendar | | public interface Calendar (Code) | | The calendar provides functions for adding, amending, removing and viewing
events.
author:
Colin MacLeod
author:
colin.macleod@ivata.com
since:
ivata groupware 0.9 (24-Mar-2004)
version:
$Revision: 1.4 $ |
| Field Summary | |
| String | BUNDLE_PATH
Name used to identify calendar message resource strings. |
| Method Summary | |
| EventDO | addEvent(SecuritySession securitySession, EventDO eventDO)
Add a new event to the calendar.
Parameters:
securitySession - Used to check current user is allowed toadd the event.
Parameters:
eventDO - Event to be added. | | EventDO | amendEvent(SecuritySession securitySession, EventDO eventDO)
Amend an existing event in the calendar.
Parameters:
securitySession - Used to check current user is allowed toamend the event.
Parameters:
eventDO - Event to be amended. | | EventDO | findEventByPrimaryKey(SecuritySession securitySession, String id)
Locate an event by its unique identifier.
Parameters:
securitySession - Used to check current user is allowed toview the event.
Parameters:
id - Unique identifier of the event to be returned. | | Collection | findEventsForDay(SecuritySession securitySession, java.util.Calendar day)
Locate all events for a single day.
Parameters:
securitySession - Used to filter events for only those the currentuser is allowed to view.
Parameters:
day - Calendar day for which to return events. | | void | removeEvent(SecuritySession securitySession, EventDO eventDO)
Remove an event from the system. | | ValidationErrors | validate(SecuritySession securitySession, EventDO eventDO)
Confirm all of the elements of the event are present and valid.
Parameters:
securitySession - Used to check current user is allowed tovalidate the event.
Parameters:
eventDO - Data object to check for consistency andcompleteness. | | ValidationErrors | validate(SecuritySession securitySession, MeetingDO meetingDO)
Confirm all of the elements of the meeting and associated event are
present and valid.
Parameters:
securitySession - Used to check current user is allowed tovalidate the event.
Parameters:
meetingDO - Data object to check for consistency andcompleteness. |
| BUNDLE_PATH | | String BUNDLE_PATH(Code) | | Name used to identify calendar message resource strings.
|
| addEvent | | EventDO addEvent(SecuritySession securitySession, EventDO eventDO) throws SystemException(Code) | |
Add a new event to the calendar.
Parameters:
securitySession - Used to check current user is allowed toadd the event.
Parameters:
eventDO - Event to be added. Added event, with details exactly as they are stored in thesystem.
throws:
SystemException - If the event cannot be added for any reason. |
| amendEvent | | EventDO amendEvent(SecuritySession securitySession, EventDO eventDO) throws SystemException(Code) | |
Amend an existing event in the calendar.
Parameters:
securitySession - Used to check current user is allowed toamend the event.
Parameters:
eventDO - Event to be amended. Added event, with details exactly as they are stored in thesystem.
throws:
SystemException - If the event cannot be amended for any reason. |
| findEventByPrimaryKey | | EventDO findEventByPrimaryKey(SecuritySession securitySession, String id) throws SystemException(Code) | |
Locate an event by its unique identifier.
Parameters:
securitySession - Used to check current user is allowed toview the event.
Parameters:
id - Unique identifier of the event to be returned. Event matching this unique identifier.
throws:
SystemException - If the event cannot be retrieved for any reason. |
| findEventsForDay | | Collection findEventsForDay(SecuritySession securitySession, java.util.Calendar day) throws SystemException(Code) | |
Locate all events for a single day.
Parameters:
securitySession - Used to filter events for only those the currentuser is allowed to view.
Parameters:
day - Calendar day for which to return events. Collection containing EventDOinstances.
throws:
SystemException - If the events cannot be retrieved for any reason. |
| removeEvent | | void removeEvent(SecuritySession securitySession, EventDO eventDO) throws SystemException(Code) | |
Remove an event from the system.
Parameters:
securitySession - Used to check current user is allowed toremove the event.
Parameters:
eventDO - Event to be removed.
throws:
SystemException - If the event cannot be added for any reason. |
| validate | | ValidationErrors validate(SecuritySession securitySession, EventDO eventDO) throws SystemException(Code) | |
Confirm all of the elements of the event are present and valid.
Parameters:
securitySession - Used to check current user is allowed tovalidate the event.
Parameters:
eventDO - Data object to check for consistency andcompleteness. a collection of validation errors if any of themandatory fields are missing, or if fields contain invalid values.
throws:
SystemException - If the event cannot be validated for any reason. |
| validate | | ValidationErrors validate(SecuritySession securitySession, MeetingDO meetingDO) throws SystemException(Code) | | Confirm all of the elements of the meeting and associated event are
present and valid.
Parameters:
securitySession - Used to check current user is allowed tovalidate the event.
Parameters:
meetingDO - Data object to check for consistency andcompleteness. a collection of validation errors if any of themandatory fields are missing, or if fields contain invalid values.
throws:
SystemException - If the event cannot be validated for any reason. |
|
|