Class icm.model.UpdatingBatch
Extends
ecm.model._ModelObject.
Represents an UpdatingBatch.
Defined in: <icm/model/UpdatingBatch.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Constructs an UpdatingBatch object.
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Indicates if changes have been added to this batch that have yet to be executed.
|
|
The refresh mode.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
addCase(c)
Adds changes to be executed to a Case when the batch is executed.
|
|
addExternalDocument(externalDoc)
Adds changes to be executed to an external document reference when the batch is executed.
|
|
addTask(t)
Adds changes to be executed to a Task when the batch is executed.
|
|
updateBatch(callback, errCallback, backgroundRequest)
Executes the batch with updates.
|
Field Detail
isPendingExecute
Indicates if changes have been added to this batch that have yet to be executed.
refreshMode
The refresh mode. If this is set to "refresh", the objects that have been added to
the batch will be refreshed after the changes are executed. Otherwise they will be left
in their existing state.
Method Detail
addCase(c)
Adds changes to be executed to a Case when the batch is executed.
- Parameters:
- c
- An icm.model.CaseEditable object with changes to be executed in a batch.
addExternalDocument(externalDoc)
Adds changes to be executed to an external document reference when the batch is executed.
- Parameters:
- externalDoc
- An icm.model.ExternalDocumentReferenceEditable object with changes to be executed in a batch.
addTask(t)
Adds changes to be executed to a Task when the batch is executed.
- Parameters:
- t
- An icm.model.TaskEditable object with changes to be executed in a batch.
updateBatch(callback, errCallback, backgroundRequest)
Executes the batch with updates.
- Parameters:
- callback
- a function called with this object
- errCallback
- An optional argument. A function called if the request fails.
- backgroundRequest
- An optional argument. If true, indicates the request is processed in the background.
Licensed Materials - Property of IBM (©) Copyright IBM Corp. 2013. All Rights Reserved.