com.ibm.rpm.communications.containers
WorkflowStepNotification

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.communications.containers.GenericCommunication
   extended bycom.ibm.rpm.communications.containers.WorkflowStepNotification

WorkflowStepNotification
Extends: com.ibm.rpm.communications.containers.GenericCommunication
Child objects: None

Related scope: com.ibm.rpm.communications.scope.GenericCommunicationScope

This class represents a workflow step notification. These cannot be created, workflows create an instance of this class automatically when the response to a vote or checklist is required.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Field Summary
xsd:dateTime closedDate
   When the state of the workflow is closed, this is the date that it was closed.
xsd:string description
   The description of the WorkflowStepNotification. For notifications with a checklist response, this is the description of the checklist. For notifications where a vote is required, this is the question to respond to.
xsd:dateTime dueDate
   The due date of the WorkflowStepNotification
RunningWorkflowProcess runningWorkflowProcess
   The running workflow process that generated the WorkflowStepNotification

Inherited Field Summary
xsd:string attachmentName
   The attachment name of the GenericCommunication
Resource author
   The author of the GenericCommunication. For SendNotification and SendStaffingRequest, the author is the resource that was logged onto the system when the API call was made.
xsd:string comments
   The comments of the GenericCommunication
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
xsd:string name
   The name of the GenericCommunication
RPMObject parent
   The parent of the RPMObject.
xsd:string projectName
   The project name of the GenericCommunication
xsd:dateTime receivedDate
   The date the GenericCommunication was received
WorkflowResponse[] responses
   The responses to the GenericCommunication. There is a WorkflowResponse for each resource the communication was sent to, as well as the author.
WorkflowState state
   The state of the running workflow process associated to the communication. For staffing requests and notifications, this field's value is always set to open.
xsd:string subject
   The subject of the GenericCommunication
WorkflowAttachment workflowAttachment
   The workflow attachment of the GenericCommunication

Field Detail

closedDate


xsd:dateTime  closedDate
When the state of the workflow is closed, this is the date that it was closed.

Read-only behavior: The value of this field is read only.


description


xsd:string  description
The description of the WorkflowStepNotification. For notifications with a checklist response, this is the description of the checklist. For notifications where a vote is required, this is the question to respond to.

Read-only behavior: The value of this field is read only.


dueDate


xsd:dateTime  dueDate
The due date of the WorkflowStepNotification

Read-only behavior: The value of this field is read only after the object was created.


runningWorkflowProcess


RunningWorkflowProcess runningWorkflowProcess
The running workflow process that generated the WorkflowStepNotification

Scoping: This field will be used by the API if the scope field runningWorkflowProcess is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


Inherited Field Detail

attachmentName


xsd:string  attachmentName
The attachment name of the GenericCommunication

Read-only behavior: The value of this field is read only.


author


Resource author
The author of the GenericCommunication. For SendNotification and SendStaffingRequest, the author is the resource that was logged onto the system when the API call was made.

Scoping: This field will be used by the API if the scope field author is enabled.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


comments


xsd:string  comments
The comments of the GenericCommunication

Maximum: The maximum length for this field is 3990 characters.

Read-only behavior: The value of this field is read only after the object was created.


contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


name


xsd:string  name
The name of the GenericCommunication

Read-only behavior: The value of this field is read only after the object was created.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.


projectName


xsd:string  projectName
The project name of the GenericCommunication

Read-only behavior: The value of this field is read only.


receivedDate


xsd:dateTime  receivedDate
The date the GenericCommunication was received

Read-only behavior: The value of this field is read only.


responses


WorkflowResponse[] responses
The responses to the GenericCommunication. There is a WorkflowResponse for each resource the communication was sent to, as well as the author.

Null value: This field must have a value at creation time.

Scoping: This field will be used by the API if the scope field responses is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


state


WorkflowState state
The state of the running workflow process associated to the communication. For staffing requests and notifications, this field's value is always set to open.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


subject


xsd:string  subject
The subject of the GenericCommunication

Maximum: The maximum length for this field is 250 characters.

Read-only behavior: The value of this field is read only after the object was created.


workflowAttachment


WorkflowAttachment workflowAttachment
The workflow attachment of the GenericCommunication

Scoping: This field will be used by the API if the scope field workflowAttachment is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.