Class ecm.model.AsyncTaskInstance


Extends ecm.model._ModelObject.
Represents a instance of a recurring ecm.model.AsyncTask. For a recurring asynchronous task, if it repeats multiple times, each record of the run is an instance of the task. For example if a recurring task reoccurs 10 times, there will be one ecm.model.AsyncTask and 10 ecm.model.AsyncTaskInstance. The parent attribute of each AsyncTaskInstance will point to the original recurring AsyncTask. In the ECM TaskManager, this is another word for an execution record.
Defined in: <ecm\model\AsyncTaskInstance.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 

Field Summary

Field Attributes Field Name and Description
 
The set of attributes for this audit.
 
parent 
The reference to the parent ecm.model.AsyncTask task.
 
The results of this asynchronous task instance.
 
The result set that this audit came from.
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes Method Name and Description
 
Returns the ecm.model.AsyncTaskType object associated with this task instance.
 
getAttributeType(attribute)
Returns the type of the attribute for this task instance.
 
getDisplayValue(attribute)
Returns the attribute value in a format that can be displayed in the user interface.
 
Returns the event action associated with this audit.
 
Returns the event date associated with this audit.
 
Returns the event information associated with this audit.
 
Returns the event type associated with this audit.
 
Returns the originator or user who created this audit.
 
getUserInfo(propertyName)
Returns the user information for this task.
 
hasPrivilege(privilege)
Returns true if this task instance has the specified privilege.
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.AsyncTaskInstance()

Since:
2.0.2

Field Detail

attributes

The set of attributes for this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

parent

The reference to the parent ecm.model.AsyncTask task.
Defined in: <ecm\model\AsyncTaskAudit.js>.

results

The results of this asynchronous task instance.

resultSet

The result set that this audit came from.
Defined in: <ecm\model\AsyncTaskAudit.js>.

Method Detail

getAsyncTaskType()

Returns the ecm.model.AsyncTaskType object associated with this task instance.
Since:
2.0.3

{string} getAttributeType(attribute)

Returns the type of the attribute for this task instance.
Defined in: <ecm\model\AsyncTaskAudit.js>.
Parameters:
attribute
The attribute name
Returns:
{string} The type of the attribute

getDisplayValue(attribute)

Returns the attribute value in a format that can be displayed in the user interface.
Defined in: <ecm\model\AsyncTaskAudit.js>.
Parameters:
attribute
The name of the attribute.

getEventAction()

Returns the event action associated with this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

getEventDate()

Returns the event date associated with this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

getEventInfo()

Returns the event information associated with this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

getEventType()

Returns the event type associated with this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

getOriginator()

Returns the originator or user who created this audit.
Defined in: <ecm\model\AsyncTaskAudit.js>.

getUserInfo(propertyName)

Returns the user information for this task.
Parameters:
propertyName
Since:
2.0.3

hasPrivilege(privilege)

Returns true if this task instance has the specified privilege.
Defined in: <ecm\model\AsyncTaskAudit.js>.
Parameters:
privilege