com.semarchy.mdm.runtime.activity
Interface IActivity


public interface IActivity

Represent an Activity (instance of IHumanWorkflow)

Author:
sarod

Method Summary
 Date getActivityCreationDate()
          Date at which the activity was initiated
 String getActivityInitiator()
          Username of the person who started/initiated the activity.
 String getActivityLabel()
          The label chosen for this activity by the initiator.
 ActivityPriority getActivityPriority()
          The informative priority chosen by activity initiator.
 String getActivityStartComments()
          Initial comment entered by initiator on activity initiation.
 ActivityStatus getActivityStatus()
          Current ActivityStatus
 Date getActivitySubmitDate()
          Activity submit date.
 ActivityType getActivityType()
          The ActivityType of the activity
 UUID getActivityUUID()
          The Unique Identifier of this activity.
 String getApplicationName()
          The name of the IApplication to which the getHumanWorkflow() belongs.
 IActivityTask getCurrentTask()
          Get the current task for the activity or null if getActivityStatus() is not ActivityStatus.RUNNING.
 IHumanWorkflow getHumanWorkflow()
          The underlying IHumanWorkflow that defines this IActivity
 long getLoadID()
          The load ID attached to this activity
 IActivityTask getPreviousTask()
          Get the previous task.
 List<IActivityTask> getTaskHistory()
          Return the list of tasks This list is empty unless activity is loaded with IActivityService.getActivity(UUID)
 String getWorkflowName()
          The name of the getHumanWorkflow()
 boolean isPropertiesEditable(ILogicalModelSecurityProvider secuProvider)
          Return true if TODO
 

Method Detail

getActivityUUID

UUID getActivityUUID()
The Unique Identifier of this activity.

Returns:

getLoadID

long getLoadID()
The load ID attached to this activity

Returns:

getApplicationName

String getApplicationName()
The name of the IApplication to which the getHumanWorkflow() belongs.

Returns:

getWorkflowName

String getWorkflowName()
The name of the getHumanWorkflow()

Returns:

getHumanWorkflow

IHumanWorkflow getHumanWorkflow()
                                throws NoSuchWorkflowException
The underlying IHumanWorkflow that defines this IActivity

Returns:
Throws:
NoSuchWorkflowException - if the activity references a workflow name that does not exist anymore

getActivityType

ActivityType getActivityType()
The ActivityType of the activity

Returns:

getActivityLabel

String getActivityLabel()
The label chosen for this activity by the initiator.

Returns:

getActivityPriority

ActivityPriority getActivityPriority()
The informative priority chosen by activity initiator.

Returns:

getActivityCreationDate

Date getActivityCreationDate()
Date at which the activity was initiated

Returns:

getActivityInitiator

String getActivityInitiator()
Username of the person who started/initiated the activity.

Returns:

getActivityStartComments

String getActivityStartComments()
Initial comment entered by initiator on activity initiation.

Returns:

getActivityStatus

ActivityStatus getActivityStatus()
Current ActivityStatus

Returns:

getActivitySubmitDate

Date getActivitySubmitDate()
Activity submit date. null if not submitted

Returns:

getTaskHistory

List<IActivityTask> getTaskHistory()
Return the list of tasks This list is empty unless activity is loaded with IActivityService.getActivity(UUID)

Returns:

getCurrentTask

IActivityTask getCurrentTask()
Get the current task for the activity or null if getActivityStatus() is not ActivityStatus.RUNNING.

Returns:
Throws:
IllegalStateException - if getTaskHistory() has not been loaded

getPreviousTask

IActivityTask getPreviousTask()
Get the previous task.

If activity is ActivityStatus.RUNNING the task preceding the getCurrentTask() is returned or null if getCurrentTask() is the first task. If activity is not ActivityStatus.RUNNING the last task in getTaskHistory() is returned.

Returns:
Throws:
IllegalStateException - if getTaskHistory() has not been loaded

isPropertiesEditable

boolean isPropertiesEditable(ILogicalModelSecurityProvider secuProvider)
Return true if TODO

Parameters:
secuProvider -
Returns:


Copyright © 2015. All Rights Reserved.