com.ibm.itim.workflow.model
Class ActivityResult

java.lang.Object
  |
  +--com.ibm.itim.workflow.model.ActivityResult
All Implemented Interfaces:
java.io.Serializable

public class ActivityResult
extends java.lang.Object
implements java.io.Serializable

This class holds the result of an activity. The summary string identifies the return code of the activity or process The detail describes the associated relevant data that have been modified during the activity execution.

See Also:
Serialized Form

Field Summary
static java.lang.String[] APPLICATION_RESULTS
          Constant identifying the result constants that are application based.
static java.lang.String[] APPROVAL_RESULTS
           
static java.lang.String APPROVED
          Supported summary code for approval activity
static java.lang.String ESCALATED
          Constant identifying an escalation result.
static java.lang.String FAILED
          Constant identifying a failed result.
static java.lang.String PARTICIPANT_RESOLVE_FAILED
          Constant identifying a participant resolution failure as a result.
static java.lang.String PENDING
          Constant identifyin a pending result.
static java.lang.String REJECTED
           
static java.lang.String[] RFI_RESULTS
           
static int STATUS_ABORT
          Constant identifying an abort status.
static int STATUS_COMPLETE
          Constant identifying a completion status.
static int STATUS_CONTINUE
          Constant identifying a continue status.
static int STATUS_WAIT
          Constant identifying a wait status.
static java.lang.String SUBMITED
          Supported summary code for RFI activity
static java.lang.String SUCCESS
          Constant identifying a successful result.
static java.lang.String TIMEOUT
          Constant identifying a timout result.
static java.lang.String WARNING
          Constant identifying a warning result.
 
Constructor Summary
ActivityResult()
          Default constructor sets the status to STATUS_COMPLETE.
ActivityResult(int status, java.lang.String summary)
          Constructor takes a status and summary.
ActivityResult(int status, java.lang.String summary, java.lang.String description, java.util.List detail)
          Constructor takes a status, summary, description, and result values.
ActivityResult(java.lang.String summary)
          Constructor takes a summary string and sets the status to STATUS_COMPLETE
ActivityResult(java.lang.String summary, java.util.List detail)
          Constructor takes a summary and result values.
ActivityResult(java.lang.String summary, java.lang.String description, java.util.List detail)
          Constructor takes a summary, description, and result values.
 
Method Summary
 java.lang.String getDescription()
          Accessor method for the activity result description property.
 java.util.List getDetail()
          Returns the list of result values for the target activity.
 int getStatus()
          Access method for the result status.
 java.lang.String getSummary()
          Accessor method for the activity summary property.
 void setDescription(java.lang.String description)
          Mutator method for the activity result description property.
 void setDetail(java.util.List detail)
          This method replaces the current list of result values with the list specified in the detail parameter.
 void setSummary(java.lang.String summary)
          Mutator method for the activity summary property.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APPROVED

public static final java.lang.String APPROVED
Supported summary code for approval activity

See Also:
Constant Field Values

REJECTED

public static final java.lang.String REJECTED
See Also:
Constant Field Values

APPROVAL_RESULTS

public static final java.lang.String[] APPROVAL_RESULTS

SUBMITED

public static final java.lang.String SUBMITED
Supported summary code for RFI activity

See Also:
Constant Field Values

RFI_RESULTS

public static final java.lang.String[] RFI_RESULTS

PARTICIPANT_RESOLVE_FAILED

public static final java.lang.String PARTICIPANT_RESOLVE_FAILED
Constant identifying a participant resolution failure as a result.

See Also:
Constant Field Values

SUCCESS

public static final java.lang.String SUCCESS
Constant identifying a successful result.

See Also:
Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT
Constant identifying a timout result.

See Also:
Constant Field Values

FAILED

public static final java.lang.String FAILED
Constant identifying a failed result.

See Also:
Constant Field Values

WARNING

public static final java.lang.String WARNING
Constant identifying a warning result.

See Also:
Constant Field Values

PENDING

public static final java.lang.String PENDING
Constant identifyin a pending result.

See Also:
Constant Field Values

ESCALATED

public static final java.lang.String ESCALATED
Constant identifying an escalation result.

See Also:
Constant Field Values

APPLICATION_RESULTS

public static final java.lang.String[] APPLICATION_RESULTS
Constant identifying the result constants that are application based. Those are SUCCESS, TIMEOUT, FAILED, WARNING, PENDING, and ESCALATED.


STATUS_CONTINUE

public static final int STATUS_CONTINUE
Constant identifying a continue status. A continue status indicates the workflow process thread should continue navigation without updating the activity status. Used for instance as a returned result from LOOP activities when the loop has not completed.

See Also:
Constant Field Values

STATUS_WAIT

public static final int STATUS_WAIT
Constant identifying a wait status. A wait status indicates the workflow process thread should wait for an activity completion notice.

See Also:
Constant Field Values

STATUS_COMPLETE

public static final int STATUS_COMPLETE
Constant identifying a completion status. A completion status indicates the workflow process thread should complete the activity.

See Also:
Constant Field Values

STATUS_ABORT

public static final int STATUS_ABORT
Constant identifying an abort status. An abort status indicates the workflow process thread should abort the activity.

See Also:
Constant Field Values
Constructor Detail

ActivityResult

public ActivityResult()
Default constructor sets the status to STATUS_COMPLETE.


ActivityResult

public ActivityResult(java.lang.String summary)
Constructor takes a summary string and sets the status to STATUS_COMPLETE

Parameters:
summary - activity specific code that may be used within a workflow process to control transistions.

ActivityResult

public ActivityResult(int status,
                      java.lang.String summary)
Constructor takes a status and summary.

Parameters:
status - indicates the status of the workflow process thread. This parameter may be STATUS_CONTINUE, STATUS_WAIT, STATUS_COMPLETE or STATUS_ABORT.
summary - activity specific code that may be used within a workflow process to control transistions.

ActivityResult

public ActivityResult(java.lang.String summary,
                      java.util.List detail)
Constructor takes a summary and result values. Status is set to STATUS_COMPLETE.

Parameters:
summary - activity specific code that may be used within a workflow process to control transistions.
detail - list of result values for the target activity. NOTE: the passed list must be serializable.

ActivityResult

public ActivityResult(java.lang.String summary,
                      java.lang.String description,
                      java.util.List detail)
Constructor takes a summary, description, and result values. Status is set to STATUS_COMPLETE.

Parameters:
summary - activity specific code that may be used within a workflow process to control transistions.
description - property that is used in audit logs to provide additional information about the activity result.
detail - list of result values for the target activity. NOTE: the passed list must be serializable.

ActivityResult

public ActivityResult(int status,
                      java.lang.String summary,
                      java.lang.String description,
                      java.util.List detail)
Constructor takes a status, summary, description, and result values.

Parameters:
status - indicates the status of the workflow process thread. This parameter may be STATUS_CONTINUE, STATUS_WAIT, STATUS_COMPLETE or STATUS_ABORT.
summary - activity specific code that may be used within a workflow process to control transistions.
description - property that is used in audit logs to provide additional information about the activity result.
detail - list of result values for the target activity. NOTE: the passed list must be serializable.
Method Detail

getStatus

public int getStatus()
Access method for the result status. This field is different than the summary field which is an activity specific code that may be used within a workflow process to control transistions whereas the status field is used internally in the workflow engine to change the processing state of a workflow processing thread. This field may be STATUS_CONTINUE, STATUS_WAIT, STATUS_COMPLETE or STATUS_ABORT.

Returns:
the result status of the activity.

setSummary

public void setSummary(java.lang.String summary)
Mutator method for the activity summary property. This property is an activity specific code that may be used within a workflow process to control transistions.

Parameters:
summary - an activity specific control code.

getSummary

public java.lang.String getSummary()
Accessor method for the activity summary property.

Returns:
An activity specific control code that may be used to control transitions.

setDescription

public void setDescription(java.lang.String description)
Mutator method for the activity result description property. This property is used in audit logs to provide additional information about the activity result.

Parameters:
description - addition detail about an activity result.

getDescription

public java.lang.String getDescription()
Accessor method for the activity result description property.

Returns:
Additional detail about an activity result.

setDetail

public void setDetail(java.util.List detail)
This method replaces the current list of result values with the list specified in the detail parameter.

Parameters:
detail - a list of result values. This list is generic list of objects specific to the activity. This parameter may be null. NOTE: detail must be serializable.

getDetail

public java.util.List getDetail()
Returns the list of result values for the target activity.



IBM Tivoli Identity Manager 4.6
© Copyright International Business Machines Corporation 2005. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.