FRAMES NO FRAMES |
com.ibm.rpm.framework.RPMObjectcom.ibm.rpm.communications.containers.WorkflowResponse
Related scope: com.ibm.rpm.communications.scope.WorkflowResponseScope
This class represents a response to a communication. Each recipient's response is created when sending a communication. Individual response can be responded to using the sendResponse API call.
Delete restrictions: This object can't be deleted.
Creation restrictions: This object is automaticaly created by its parent.
Supported API Calls:Field Summary | |
xsd:string
|
comments
The response comments. |
xsd:int
|
effort
The amount of time, in hours, that the resource worked on a checklist or vote response. For this field to be editable, the parent of the WorkflowResponse must be of type workflowStepNotification, and the resource must be assigned to a task that is designed as a timesheet task in the workflow process associated to the WorkflowStepNotification |
CommunicationsFolder
|
folder
The folder in which the response is stored in the resource's communications view |
xsd:boolean
|
read
This field indicates whether or not the response has been read by the resource. |
Resource
|
resource
The resource that must respond, or has already responded to the communication parent |
GenericResponseType[]
|
response
For parents of type WorkflowStepNotification, this field is used to submit a vote, or complete a checklist, as is necessary to complete the workflow. |
xsd:dateTime
|
responseDate
The date the response was sent. This field is null if the resource has not responded yet |
WorkflowResponseState
|
state
The state of the workflow response. When responding using sendResponse, the state must be set to Accepted or Rejected |
xsd:boolean
|
visible
This field indicates whether the response should be visible to a user that is logged onto the system. |
xsd:int
|
weight
For vote responses, the weight of the vote. |
Inherited Field Summary | |
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. |
RPMObject
|
parent
The parent of the RPMObject. |
Field Detail |
Maximum: The maximum length for this field is 4095 characters.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field resource 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.
Scoping: This field will be used by the API if the scope field response is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Inherited Field Detail |
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
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.