com.stratelia.webactiv.almanach.control.ejb
Interface AlmanachBm

All Known Implementing Classes:

AlmanachBmEJB

public interface AlmanachBm

Method Summary

String	addEvent(EventDetail event, Collection<org.silverpeas.upload.UploadedFile> uploadedFiles) addEvent() add an event entry in the database.
String	addEvent(EventDetail event, Collection<org.silverpeas.upload.UploadedFile> uploadedFiles, com.silverpeas.pdc.model.PdcClassification withClassification) Adds the event in the almanach with the specified classification on the PdC.
void	addPeriodicityException(PeriodicityException exception)
void	createIndex(EventDetail detail)
Collection<EventDetail>	getAllEvents(EventPK pk) this method provide a collection of event
Collection<EventDetail>	getAllEvents(EventPK pk, String[] instanceIds) Get all events of instanceId Almanachs
Collection<org.silverpeas.attachment.model.SimpleDocument>	getAttachments(EventPK eventPK)
EventDetail	getEventDetail(EventPK pk) getEventDetail() returns the EventDetail represented by the pk
List<EventOccurrence>	getEventOccurrencesInPeriod(org.silverpeas.date.Period period, String... almanachIds) Gets the event occurrences that occur in the specified period and that are defined in the specified almanachs.
Collection<EventDetail>	getEvents(Collection<EventPK> pks)
String	getHTMLPath(EventPK eventPK)
net.fortuna.ical4j.model.Calendar	getICal4jCalendar(Collection<EventDetail> events, String language)
Collection<EventDetail>	getListRecurrentEvent(net.fortuna.ical4j.model.Calendar calendarAlmanach, Calendar currentDay, String spaceId, String instanceId, boolean yearScope)
List<EventOccurrence>	getNextEventOccurrences(String... almanachIds) Gets the next event occurrences that will occur andd that are defined in the specified almanachs.
int	getSilverObjectId(EventPK pk)
void	removeEvent(EventPK pk) removeEvent() remove the Event entry specified by the pk
void	updateEvent(EventDetail event) updateEvent() update the event entry, specified by the pk, in the database

Method Detail

getEventOccurrencesInPeriod

List<EventOccurrence> getEventOccurrencesInPeriod(org.silverpeas.date.Period period,
                                                  String... almanachIds)

Gets the event occurrences that occur in the specified period and that are defined in the specified almanachs.

Parameters:

period - the period in which the events occur.

almanachIds - the identifier of the almanachs in which the events are defined.

Returns:

a list of event occurrences.

getNextEventOccurrences

List<EventOccurrence> getNextEventOccurrences(String... almanachIds)

Gets the next event occurrences that will occur andd that are defined in the specified almanachs.

Parameters:

almanachIds - the identifier of the almanachs in which the events are defined.

Returns:

a list of event occurrences that will occur in the future.

getAllEvents

Collection<EventDetail> getAllEvents(EventPK pk)

this method provide a collection of event

Parameters:

: - EventPk pk, to obtain the space and component

getAllEvents

Collection<EventDetail> getAllEvents(EventPK pk,
                                     String[] instanceIds)

Get all events of instanceId Almanachs

Parameters:

pk -

instanceIds - String[] of instanceIds

Returns:

Collection of Events

getEvents

Collection<EventDetail> getEvents(Collection<EventPK> pks)

addEvent

String addEvent(EventDetail event,
                Collection<org.silverpeas.upload.UploadedFile> uploadedFiles)

addEvent() add an event entry in the database.

Parameters:

event - detail about the event to add in Silverpeas.

uploadedFiles - attached files.

Returns:

the unique identifier of the added event.

addEvent

String addEvent(EventDetail event,
                Collection<org.silverpeas.upload.UploadedFile> uploadedFiles,
                com.silverpeas.pdc.model.PdcClassification withClassification)

Adds the event in the almanach with the specified classification on the PdC.

Parameters:

event - detail about the event to add in Silverpeas.

uploadedFiles - attached files.

withClassification - the classificationwith which the event will be classified on the PdC.

Returns:

the unique identifier of the added event.

updateEvent

void updateEvent(EventDetail event)

updateEvent() update the event entry, specified by the pk, in the database

removeEvent

void removeEvent(EventPK pk)

removeEvent() remove the Event entry specified by the pk

getEventDetail

EventDetail getEventDetail(EventPK pk)

getEventDetail() returns the EventDetail represented by the pk

getSilverObjectId

int getSilverObjectId(EventPK pk)

createIndex

void createIndex(EventDetail detail)

addPeriodicityException

void addPeriodicityException(PeriodicityException exception)

getICal4jCalendar

net.fortuna.ical4j.model.Calendar getICal4jCalendar(Collection<EventDetail> events,
                                                    String language)

getListRecurrentEvent

Collection<EventDetail> getListRecurrentEvent(net.fortuna.ical4j.model.Calendar calendarAlmanach,
                                              Calendar currentDay,
                                              String spaceId,
                                              String instanceId,
                                              boolean yearScope)

getAttachments

Collection<org.silverpeas.attachment.model.SimpleDocument> getAttachments(EventPK eventPK)

getHTMLPath

String getHTMLPath(EventPK eventPK)