Class icm.model.WorkItemEditable
Extends
ecm.model._ModelObject.
Represents the scratchpad state for editing a work item.
Defined in: <icm/model/WorkItemEditable.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
icm.model.WorkItemEditable(properties)
Constructs a WorkItemEditable object.
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The comment of the step.
|
|
Will be non-null if integrating with an external data service
|
|
The WorkItem object corresponding to this Editable object.
|
|
The collection of PropertyEditable objects that represent the step parameters
of this step.
|
|
The currently selected step response.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
abortStep(callback, errCallback, backgroundRequest)
Aborts the step.
|
|
completeStep(callback, errCallback, backgroundRequest)
Completes the step.
|
|
Returns the workflow authored map name.
|
|
getCase()
Returns the Case object associated with the work item.
|
|
Returns the folder Id of the Case associated with this work item.
|
|
Returns the Id of the task associated with this work item.
|
|
Returns the CaseType object that is the case type of the Case associated with
the work item.
|
|
Returns the deadline of the step.
|
|
Returns the instruction of the step.
|
|
Returns the launch date of the step.
|
|
Indicates if the step is locked and by whom.
|
|
Returns the workflow map name.
|
|
Returns the originator.
|
|
Returns the overdue status of the step.
|
|
getProperty(provider, symbolicName)
Obtains the PropertyEditable from the propertiesCollection property with the given
provider and symbolic name.
|
|
Returns the reminder of the step.
|
|
Returns the possible responses of the step.
|
|
Returns the Id of the step.
|
|
Returns the step name.
|
|
Returns the page to process the step.
|
|
Gets the subject of the workflow.
|
|
getViewDefinitionUri(viewDefinitionId)
Returns the view definition URI.
|
|
Returns the workflow name.
|
|
Returns the workflow number.
|
|
Indicates if retrieveDependentProperties() should be called to resolve
dependent properties on the server.
|
|
Indicates if the step is locked by the current user.
|
|
lockStep(callback, errCallback, backgroundRequest)
Locks the step.
|
|
Called when the entire state of the object is refreshed, primarily
when the attributes have been updated based on updated information
from the server.
|
|
retrieveAllAttachmentContents(callback)
Retrieves all attachment contents of all attachment fields
at once.
|
|
retrieveAttributes(callback, errCallback, backgroundRequest)
Retrieves all attributes for this WorkItem object.
|
|
retrieveCachedAttributes(callback, errCallback, backgroundRequest)
Ensures that the full set of attributes has been retrieved.
|
|
retrieveDependentProperties(callback, errCallback, backgroundRequest)
Resolves dependent properties with the server.
|
|
retrieveNextItem(callback)
Returns the next item in the resultset that this WorkItemEditable object was originally obtained from.
|
|
retrieveStep(callback, errCallback, backgroundRequest)
Fully retrieves the properties of the step.
|
|
saveStep(callback, errCallback, backgroundRequest)
Saves the step.
|
|
setComment(commentText)
Sets the comment of the step.
|
|
setSelectedResponse(response)
Sets the step response
|
Constructor Detail
icm.model.WorkItemEditable(properties)
- Parameters:
- properties
- The properties for the WorkItemEditable object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.
Field Detail
comment
externalDataIdentifier
icmWorkItem
propertiesCollection
selectedResponse
Method Detail
abortStep(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- Callback function called with this object as an argument when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
completeStep(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- a function called with this object when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
getAuthoredMapName()
- Returns:
- The authored map name
getCase()
- Returns:
- icm.model.Case
getCaseFolderId()
- Returns:
- (string) GUID of the folder
getCaseTaskId()
- Returns:
- (string) GUID of the task
getCaseType()
- Returns:
- icm.model.CaseType
getDeadline()
- Returns:
- the deadline
getInstruction()
- Returns:
- The instruction of the step.
getLaunchDate()
- Returns:
- the launch date
getLockedBy()
- Returns:
- (string) The user name if it is locked
getMapName()
- Returns:
- the map name
getOriginator()
- Returns:
- the originator.
getOverdueStatus()
- Returns:
- the overdue status.
getProperty(provider, symbolicName)
- Parameters:
- provider
- symbolicName
- Returns:
- PropertyEditable object if one exists with the given provider and symbolic name. Otherwise null.
getReminder()
- Returns:
- the reminder
getResponses()
- Returns:
- (array of string)
getStepId()
- Returns:
- The step Id
getStepName()
- Returns:
- (string)
getStepPage()
- Returns:
- the step page.
{string} getSubject()
- Returns:
- {string}
getViewDefinitionUri(viewDefinitionId)
- Parameters:
- viewDefinitionId
- Returns:
- the view definition URI.
getWorkflowName()
- Returns:
- the workflow name
getWorkflowNumber()
- Returns:
- the workflow number.
isDependentPropertiesRetrievalPending()
- Returns:
- (boolean)
isLockedByCurrentUser()
- Returns:
- (boolean) True if locked by the current user.
lockStep(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- Callback function called with this object as an argument when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
onRefresh()
retrieveAllAttachmentContents(callback)
- Parameters:
- callback
- Callback function called with this WorkItemEditable object as an argument when the request completes.
retrieveAttributes(callback, errCallback, backgroundRequest)
This method is a convenience to calling retrieveAttributes() on the icm.model.WorkItem object and then obtaining this WorkItemEditable object. Both this WorkItemEditable object and its associated icm.model.WorkItem object are updated to reflect the retrieved state.
- Parameters:
- callback
- Callback function called with this object as an argument when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
retrieveCachedAttributes(callback, errCallback, backgroundRequest)
This method is a convenience to calling retrieveCachedAttributes() on the icm.model.WorkItem object and then obtaining this WorkItemEditable object. If the full attributes have not yet been cached, both this WorkItemEditable object and its associated icm.model.WorkItem object are updated to reflect the retrieved state.
- Parameters:
- callback
- Callback function called with this object as an argument when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
retrieveDependentProperties(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- Callback function called with this object as an argument when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
retrieveNextItem(callback)
From the next WorkItemEditable, retrieveNextItem() can be called again to repeatedly obtain the next WorkItemEditable until no more work items can be found. Items that are locked by a different user are skipped.
Calling retrieveNextItem() again from this same WorkItemEditable object will call the callback function with a new instance of icm.model.WorkItemEditable. This may or may not represent the same work item that was returned previously depending on if the work item has been processed or not. Typically when processing next items, you will retrieve the next items until no more are available but you will not start over from earlier in the list. If non-default processing of the list is desired, the work item objects should be cached by the application and managed outside of this class.
- Parameters:
- callback
- A callback function called with the next work item. It is passed an icm.model.WorkItemEditable object for the next item or null if there is no next item.
retrieveStep(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- a function called with this object when the request completes.
- errCallback
- Callback function called when the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
saveStep(callback, errCallback, backgroundRequest)
- Parameters:
- callback
- a function called with this object when the request completes.
- errCallback
- a function called when the request fails
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
setComment(commentText)
- Parameters:
- commentText
- the text of the comment
setSelectedResponse(response)
- Parameters:
- response
- the step response