Package de.uplanet.lucy.server.share.workflow.action

Class AbstractSharePushNotificationWorkflowAction

java.lang.Object

de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

de.uplanet.lucy.server.share.workflow.action.AbstractSharePushNotificationWorkflowAction

All Implemented Interfaces:

IActivatableWorkflowObject, ILogLevelAware, INamedWorkflowObject, INeedWorkflow, IWorkflowAction, IWorkflowObject, Serializable

Direct Known Subclasses:

ShareFrequencyPushNotificationWorkflowAction, ShareImmediatelyPushNotificationWorkflowAction

public abstract class AbstractSharePushNotificationWorkflowAction
extends AbstractWorkflowAction
implements ILogLevelAware

See Also:

• Serialized Form

Field Summary

Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractSharePushNotificationWorkflowAction(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
String	getCollapseKey()
String	getPortalName()
long	getTimeToLive()
String	getTitle()
boolean	isDryRun()
boolean	isLogVerbose()	This flag determines if verbose logging is turned on or off.
boolean	isPushAsynchronous()	This property specifies whether or not messages should be pushed asynchronously if possible.
boolean	isUseTransaction()	This property specifies whether or not pushing a message should be part of the current transaction or not.
WorkflowTransition	process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx)	Process a workflow event in the given context.
void	setCollapseKey(String p_strCollapseKey)
void	setDryRun(boolean p_bDryRun)
void	setLogVerbose(boolean p_bLogVerbose)	This flag determines if verbose logging is turned on or off.
void	setPortalName(String p_strPortalName)
void	setPushAsynchronous(boolean p_bPushAsynchronous)	This property specifies whether or not messages should be pushed asynchronously if possible.
void	setTimeToLive(long p_lTimeToLive)
void	setTitle(String p_strTitle)
void	setUseTransaction(boolean p_bUseTransaction)	This property specifies whether or not pushing a message should be part of the current transaction or not.

Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransition, setName, setWorkflow, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractSharePushNotificationWorkflowAction

public AbstractSharePushNotificationWorkflowAction(String p_strGuid)

Method Details

getTitle

public String getTitle()

setTitle

public void setTitle(String p_strTitle)

getPortalName

public String getPortalName()

setPortalName

public void setPortalName(String p_strPortalName)

getTimeToLive

public long getTimeToLive()

setTimeToLive

public void setTimeToLive(long p_lTimeToLive)

getCollapseKey

public String getCollapseKey()

setCollapseKey

public void setCollapseKey(String p_strCollapseKey)

isUseTransaction

public boolean isUseTransaction()

This property specifies whether or not pushing a message should be part of the current transaction or not.

If true this implies asynchronous sending.

Returns:

true if pushing a message should be part of the current transaction, or false otherwise.

setUseTransaction

public void setUseTransaction(boolean p_bUseTransaction)

This property specifies whether or not pushing a message should be part of the current transaction or not.

If true this implies asynchronous sending.

Parameters:

p_bUseTransaction - true if pushing a message should be part of the current transaction, or false otherwise.

isPushAsynchronous

public boolean isPushAsynchronous()

This property specifies whether or not messages should be pushed asynchronously if possible.

If transactions are used or the message to be sent has multiple recipients, this property is ignored.

Returns:

true if messages should be pushed asynchronously, or false otherwise.

setPushAsynchronous

public void setPushAsynchronous(boolean p_bPushAsynchronous)

This property specifies whether or not messages should be pushed asynchronously if possible.

If transactions are used or the message to be sent has multiple recipients, this property is ignored.

Parameters:

p_bPushAsynchronous - true if messages should be pushed asynchronously, or false otherwise.

isDryRun

public boolean isDryRun()

setDryRun

public void setDryRun(boolean p_bDryRun)

isLogVerbose

public boolean isLogVerbose()

Description copied from interface: ILogLevelAware

This flag determines if verbose logging is turned on or off.

Specified by:

isLogVerbose in interface ILogLevelAware

Returns:

true if logging is verbose, or false otherwise.

setLogVerbose

public void setLogVerbose(boolean p_bLogVerbose)

Description copied from interface: ILogLevelAware

This flag determines if verbose logging is turned on or off.

Specified by:

setLogVerbose in interface ILogLevelAware

Parameters:

p_bLogVerbose - true if logging should be verbose, or false otherwise.

process

public WorkflowTransition process(IWorkflowEvent p_evt,
 de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx,
 de.uplanet.lucy.server.IProcessingContext p_ctx)
                           throws Exception

Description copied from interface: IWorkflowAction

Process a workflow event in the given context.

Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

Specified by:

process in interface IWorkflowAction

Parameters:

p_evt - The event to be processed.

p_wfCtx - The workflow processing context.

p_ctx - The processing context.

Returns:

The efferent transition, or null.

Throws:

Exception - If an error occurred.