org.alfresco.bm.process.share.soak

Interface ShareScenario

All Known Implementing Classes:

AbstractShareScenario, ShareBrowseToSiteDashboardScenario, ShareBrowseToSiteDocLibScenario, ShareBrowseToUserDashboardScenario, ShareCreateFolderScenario, ShareCreateSiteScenario, ShareDownloadFileScenario, ShareEditDocumentScenario, SharePageDocLibScenario, SharePeopleFinderScenario, ShareSearchScenario, ShareSelectDocLibEntryScenario, ShareSelectSearchEntryScenario, ShareUploadFileScenario, ShareUploadNewVersionScenario

public interface ShareScenario

Share-aware scenario interface.
Implementations choose the next event outcome and ensure the correct input data is available.

Since:

1.0

Author:

Derek Hulley

Method Summary

Methods

Modifier and Type	Method and Description
List<org.alfresco.bm.event.Event>	getNextEvents(org.alfresco.bm.event.Event event, ShareEventData eventData, ShareSoakData soakData, long nextEventTime) Construct a list of events to follow according to the scenario implementation.

Method Detail

getNextEvents

List<org.alfresco.bm.event.Event> getNextEvents(org.alfresco.bm.event.Event event,
                                              ShareEventData eventData,
                                              ShareSoakData soakData,
                                              long nextEventTime)

Construct a list of events to follow according to the scenario implementation.

Implementations use the contextual data available to determine the next course of action. However, the no-op (empty list return) should be determined as quickly and cheaply as possible.

NB: Implementations must ensure that an adequate termination condition exists and return an empty list. If not, an infinite loop of events can ensue.

Parameters:

event - the event that triggered this choice

eventData - Share-specific data associated with the event

soakData - Session-specific data for the event

nextEventTime - the suggested next event time (for guidance)

Returns:

a list of events to publish (never null) or an empty list if the scenario cannot continue