org.alfresco.bm.process.share.soak

Class SharePageDocLibScenario

java.lang.Object

org.alfresco.bm.process.share.soak.AbstractShareScenario

org.alfresco.bm.process.share.soak.SharePageDocLibScenario

All Implemented Interfaces:

ShareScenario, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class SharePageDocLibScenario
extends AbstractShareScenario

Pages through document library listings

The following page is executed. * indicates a possible start location.

• * 1. Site doclib (with pages): Pages forward or backwards. Can return to this page.
• 2.1. Site doclib: END

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_NAME_DOCLIB_PAGE

Constructor Summary

Constructors

Constructor and Description
SharePageDocLibScenario(ShareScenarioRegistry registry, double weight)

Method Summary

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.
void	setEventNameDocLibPage(String eventNameDocLibPage) Override the default name for events to page forward or backwards

Methods inherited from class org.alfresco.bm.process.share.soak.AbstractShareScenario

afterPropertiesSet, setBeanName, setScenarioName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_NAME_DOCLIB_PAGE

public static final String EVENT_NAME_DOCLIB_PAGE

See Also:

Constant Field Values

Constructor Detail

SharePageDocLibScenario

public SharePageDocLibScenario(ShareScenarioRegistry registry,
                               double weight)

Parameters:

registry - registry with which this instance will be registered

weight - the weight relative to other scenarios registered in the registry

Method Detail

setEventNameDocLibPage

public void setEventNameDocLibPage(String eventNameDocLibPage)

Override the default name for events to page forward or backwards

getNextEvents

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

Description copied from interface: ShareScenario

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

See Also:

see class comments