Class AbstractGlobalWorkflowTimer
- java.lang.Object
-
- de.uplanet.lucy.server.workflow.timer.AbstractGlobalWorkflowTimer
-
- All Implemented Interfaces:
IActivatableWorkflowObject
,de.uplanet.lucy.server.workflow.IImpersonateUser
,INamedWorkflowObject
,INeedWorkflow
,IWorkflowEventSource
,IWorkflowObject
,IWorkflowTimer
,Serializable
- Direct Known Subclasses:
AbstractGlobalMultiEventWorkflowTimer
,GlobalWorkflowTimer
public abstract class AbstractGlobalWorkflowTimer extends Object implements IWorkflowTimer, INamedWorkflowObject, INeedWorkflow, de.uplanet.lucy.server.workflow.IImpersonateUser
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
-
Constructor Summary
Constructors Constructor Description AbstractGlobalWorkflowTimer(String p_strGuid)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
getBeginTime()
Get the lower bound of the time interval, wherein the rules are valid.Date
getEndTime()
Get the upper bound of the time interval, wherein the rules are valid.String
getGuid()
Get the GUID of this workflow object.String
getImpersonateUserGuid()
Get this timer's impersonation user.Map<String,Object>
getInitialSharedState()
Get the initial shared state of this timer.String
getName()
Get the name of the workflow object.List<String>
getRules()
Get the rules for this timer.String
getRulesTimeZone()
Get the time zone used by this rules.de.uplanet.lucy.server.workflow.IWorkflow
getWorkflow()
Get the workflow this object belongs to.boolean
hasImpersonateUserGuid()
Check if this timer has an impersonation user.boolean
isActive()
Check if this workflow object is active or inactive.boolean
isTriggerOverdueTimer()
This flag indicates if overdue timers should be triggered or not.void
setActive(boolean p_bActive)
Set this workflow object active or inactive.void
setBeginTime(Date p_dtBegin)
Set the lower bound of the time interval, wherein the rules are valid.void
setEndTime(Date p_dtEnd)
Set the upper bound of the time interval, wherein the rules are valid.void
setImpersonateUserGuid(String p_impersonateUserGuid)
Set this timer's impersonation user.void
setInitialSharedState(Map<String,Object> p_initialSharedState)
Set initial shared state of this timer.void
setName(String p_strName)
Set the name of the workflow object.void
setRules(List<String> p_rules)
Get the rules for this timer.void
setRulesTimeZone(String p_strTimeZone)
Set the time zone used by this rules.void
setTriggerOverdueTimer(boolean p_bTriggerOverdueTimer)
This flag indicates if overdue timers should be triggered or not.void
setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wf)
Set the workflow this object belongs to.
-
-
-
Constructor Detail
-
AbstractGlobalWorkflowTimer
public AbstractGlobalWorkflowTimer(String p_strGuid)
- Parameters:
p_strGuid
- The timer GUID.
-
-
Method Detail
-
getGuid
public String getGuid()
Description copied from interface:IWorkflowObject
Get the GUID of this workflow object.Note: implementors must ensure that this is never
null
.- Specified by:
getGuid
in interfaceIWorkflowObject
- Returns:
- The GUID of this workflow object
-
isActive
public boolean isActive()
Description copied from interface:IActivatableWorkflowObject
Check if this workflow object is active or inactive.- Specified by:
isActive
in interfaceIActivatableWorkflowObject
- Specified by:
isActive
in interfaceIWorkflowEventSource
- Returns:
- The activation state of this workflow object.
-
setActive
public void setActive(boolean p_bActive)
Description copied from interface:IActivatableWorkflowObject
Set this workflow object active or inactive.- Specified by:
setActive
in interfaceIActivatableWorkflowObject
- Specified by:
setActive
in interfaceIWorkflowEventSource
- Parameters:
p_bActive
- The new activation state to be set.
-
getName
public String getName()
Description copied from interface:INamedWorkflowObject
Get the name of the workflow object.- Specified by:
getName
in interfaceINamedWorkflowObject
- Returns:
- The name of the workflow object.
-
setName
public void setName(String p_strName)
Description copied from interface:INamedWorkflowObject
Set the name of the workflow object.- Specified by:
setName
in interfaceINamedWorkflowObject
- Parameters:
p_strName
- The name of the workflow object.
-
getWorkflow
public de.uplanet.lucy.server.workflow.IWorkflow getWorkflow()
Description copied from interface:INeedWorkflow
Get the workflow this object belongs to.- Specified by:
getWorkflow
in interfaceINeedWorkflow
- Returns:
- The workflow this object belongs to.
-
setWorkflow
public void setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wf)
Description copied from interface:INeedWorkflow
Set the workflow this object belongs to.- Specified by:
setWorkflow
in interfaceINeedWorkflow
- Parameters:
p_wf
- The workflow this object belongs to.
-
getBeginTime
public Date getBeginTime()
Get the lower bound of the time interval, wherein the rules are valid.- Returns:
- The lower bound of the time interval, wherein the rules are valid.
-
setBeginTime
public void setBeginTime(Date p_dtBegin)
Set the lower bound of the time interval, wherein the rules are valid.- Parameters:
p_dtBegin
- The lower bound of the time interval, wherein the rules are valid.
-
getEndTime
public Date getEndTime()
Get the upper bound of the time interval, wherein the rules are valid.- Returns:
- The upper bound of the time interval, wherein the rules are valid.
-
setEndTime
public void setEndTime(Date p_dtEnd)
Set the upper bound of the time interval, wherein the rules are valid.- Parameters:
p_dtEnd
- The upper bound of the time interval, wherein the rules are valid, ornull
if no upper bound exists.
-
getRulesTimeZone
public String getRulesTimeZone()
Get the time zone used by this rules.- Returns:
- The time zone.
-
setRulesTimeZone
public void setRulesTimeZone(String p_strTimeZone)
Set the time zone used by this rules.- Parameters:
p_strTimeZone
- The time zone.
-
getRules
public List<String> getRules()
Get the rules for this timer.Note: To make Spring happy, this method returns a reference to the internal list that holds the rules. This breaks proper encapsulation, so beware of modifying the returned list.
- Returns:
- The rules for this timer.
-
setRules
public void setRules(List<String> p_rules)
Get the rules for this timer.- Parameters:
p_rules
- The rules for this timer.
-
isTriggerOverdueTimer
public boolean isTriggerOverdueTimer()
This flag indicates if overdue timers should be triggered or not.- Returns:
true
if overdue timers should be triggered, orfalse
otherwise.
-
setTriggerOverdueTimer
public void setTriggerOverdueTimer(boolean p_bTriggerOverdueTimer)
This flag indicates if overdue timers should be triggered or not.- Parameters:
p_bTriggerOverdueTimer
-true
if overdue timers should be triggered, orfalse
otherwise.
-
hasImpersonateUserGuid
public boolean hasImpersonateUserGuid()
Check if this timer has an impersonation user.- Specified by:
hasImpersonateUserGuid
in interfacede.uplanet.lucy.server.workflow.IImpersonateUser
- Returns:
true
if this timer has an impersonation user, orfalse
otherwise.
-
getImpersonateUserGuid
public String getImpersonateUserGuid()
Get this timer's impersonation user.- Specified by:
getImpersonateUserGuid
in interfacede.uplanet.lucy.server.workflow.IImpersonateUser
- Returns:
- This timer's impersonation user, or
null
.
-
setImpersonateUserGuid
public void setImpersonateUserGuid(String p_impersonateUserGuid)
Set this timer's impersonation user.- Specified by:
setImpersonateUserGuid
in interfacede.uplanet.lucy.server.workflow.IImpersonateUser
- Parameters:
p_impersonateUserGuid
- This GUID of this timer's impersonation user.
-
getInitialSharedState
public Map<String,Object> getInitialSharedState()
Get the initial shared state of this timer.- Returns:
- The initial shared state of this timer, or
null
.
-
-