org.alfresco.bm.process.share

Class NavigationEventProcess

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.process.share.AbstractShareEventProcessor

org.alfresco.bm.process.share.NavigationEventProcess

All Implemented Interfaces:

org.alfresco.bm.event.EventProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class NavigationEventProcess
extends AbstractShareEventProcessor

An Alfresco share navigation process that mimics selecting a button on Alfresco's main navigation bar.

Input

A SharePage that is displayed to the user.

Actions

Uses the Navigation on the share page to navigate from the current rendered page to the destination page using the main navigation bar.

Output

EVENT_NAME_NAVIGATION_COMPLETE: A Share page after navigation

Since:

1.0

Author:

Michael Suzuki

Field Summary

Fields inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

eventNameActionComplete, logger, userDataService

Fields inherited from class org.alfresco.bm.event.AbstractEventProcessor

DEFAULT_CHART, DEFAULT_PROPAGATE_SESSION_ID, DEFAULT_WARN_DELAY

Constructor Summary

Constructors

Constructor and Description
NavigationEventProcess(org.alfresco.bm.user.UserDataService userDataService, String navigateTo) Default constructor.
NavigationEventProcess(org.alfresco.bm.user.UserDataService userDataService, String eventNavigationName, String navigateTo) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event, ShareEventData eventData) Process a share based event.

Methods inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

closeWebDrone, getUserData, processEvent, setEventNameActionComplete, setSessionService

Methods inherited from class org.alfresco.bm.event.AbstractEventProcessor

getWarnDelay, isChart, processEvent, propagateSessionId, register, resumeTimer, setBeanName, setChart, setEventName, setEventNames, setPropagateSessionId, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationEventProcess

public NavigationEventProcess(org.alfresco.bm.user.UserDataService userDataService,
                      String navigateTo)

Default constructor.

Parameters:

navigateTo - The method name to select on the Navigation for the process to eventNavigationActionComplete.

NavigationEventProcess

public NavigationEventProcess(org.alfresco.bm.user.UserDataService userDataService,
                      String eventNavigationName,
                      String navigateTo)

Constructor.

Parameters:

userDataService - UserDataService

eventNavigationName - the name identifier for the action

navigateTo - the name of method to use on SiteNavigation

Method Detail

processEvent

public org.alfresco.bm.event.EventResult processEvent(org.alfresco.bm.event.Event event,
                                             ShareEventData eventData)
                                               throws Exception

Description copied from class: AbstractShareEventProcessor

Process a share based event.

Specified by:

processEvent in class AbstractShareEventProcessor

Parameters:

event - the origininating event (not normally required)

eventData - the share event data entity

Returns:

EventResult the result of the process (includes errors and next events)

Throws:

Exception