Package | com.adobe.ep.taskmanagement.services |
Interface | public interface ITaskManager |
Implementors | TaskManager |
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
ITaskManager
interface for the API to manage tasks such as create tasks, delete tasks, modify tasks, complete tasks.
This interface also supports the capability to specify task types on the server with custom task properties. Task Types allow to add additional metadata to your tasks which is useful to create application specifc tasks. For example a Health Claim application may use a tasktype HealthClaim to add Health Claim related metadata like Insurance Provider, or X-Ray costs, etc.
Property | Defined By | ||
---|---|---|---|
activeTask : com.adobe.ep.taskmanagement.domain:ITask
Retrieves the active task from the task list. | ITaskManager |
Method | Defined By | ||
---|---|---|---|
Completes the specifed task. | ITaskManager | ||
createTask(taskDetails:com.adobe.ep.taskmanagement.domain:ITask):com.adobe.ep.taskmanagement.util:IObjectToken
Creates and persists a new task on the server. | ITaskManager | ||
Deletes the specified task. | ITaskManager | ||
Returns detailed information for a given task. | ITaskManager | ||
getTasks(taskFilter:IFilter = null, startIndex:int = 0, length:int = -1):com.adobe.ep.taskmanagement.util:ICollectionToken
Returns the current list of task filtered by the provided taskFilter. | ITaskManager | ||
Factory method to create a new taskfilter object to use with getTasks(taskFilter). | ITaskManager | ||
Factory method to instantiate the an ITask implementation class instance associated with the ITaskManager implementation. | ITaskManager | ||
Persists the given task to the server. | ITaskManager | ||
Starts a task. | ITaskManager |
activeTask | property |
activeTask:com.adobe.ep.taskmanagement.domain:ITask
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Retrieves the active task from the task list.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
Implementation
public function get activeTask():com.adobe.ep.taskmanagement.domain:ITask
public function set activeTask(value:com.adobe.ep.taskmanagement.domain:ITask):void
completeTask | () | method |
public function completeTask(taskId:String):com.adobe.ep.taskmanagement.util:IToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Completes the specifed task.
Parameters
taskId:String — Specifies the task id of the task to complete.
|
com.adobe.ep.taskmanagement.util:IToken — An object that is used to specify the handlers for this asynchronous call.
|
createTask | () | method |
public function createTask(taskDetails:com.adobe.ep.taskmanagement.domain:ITask):com.adobe.ep.taskmanagement.util:IObjectToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Creates and persists a new task on the server. Note that instances of ILCTaskManager do not support the creation of tasks.
Parameters
taskDetails:com.adobe.ep.taskmanagement.domain:ITask — Specifies the details of the task to create.
|
com.adobe.ep.taskmanagement.util:IObjectToken — An object that is used the specify handlers for this asynchronous call.
|
Example ( How to use this example )
var taskManager;ITaskManager = ... var newInstanceToken:IObjectToken = taskManager.newTaskInstance(); newInstanceToken.addResponder(new mx.rpc.Responder( function (event:ObjectResultEvent) : void { // get the newly instantate task from the result var newInstance:ITask = newInstanceToken.result as ITask; // set some data on the task newInstance.setPropertyValue("somePropertyName", "somePropertyValue"); // now create the task on the server var createTaskToken:IObjectToken = taskManager.createTask(newInstance); createTaskToken.addResponder(new mx.rpc.Responder( function (event:TaskManagerEvent) : void { // the task return from the server. // this task will now also include an ID to uniquely identify it var createdTask:ITask = createTaskToken.result as ITask; // do something with the newly created task }, function (event:TaskManagerFaultEvent) : void { // createTask failed, handle fault })); }, function (event:TaskManagerFaultEvent) : void { // newTaskInstance failed, handle fault });
deleteTask | () | method |
public function deleteTask(taskId:String):com.adobe.ep.taskmanagement.util:IToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Deletes the specified task.
Parameters
taskId:String — the task id for the task to delete.
|
com.adobe.ep.taskmanagement.util:IToken — An object that is used the specify handlers for this asynchronous call.
|
getTaskInfo | () | method |
public function getTaskInfo(taskId:String):com.adobe.ep.taskmanagement.util:IObjectToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns detailed information for a given task.
Parameters
taskId:String — Specifies the task id for the task to retrieve.
|
com.adobe.ep.taskmanagement.util:IObjectToken — An object that is used the specify handlers for this asynchronous call.
|
Example ( How to use this example )
var taskManager:ITaskManager = ... var taskId:String = ... var taskInfoToken:IObjectToken = taskManager.getTaskInfo(taskId); taskInfoToken.addResponder(new mx.rpc.Responder( function (event:ObjectResultEvent) : void { // get the newly instantate task from the result var task:ITask = taskInfoToken.result as ITask; }, function (event:TaskManagerFaultEvent) : void { // getTaskInfo failed, handle fault }));
getTasks | () | method |
public function getTasks(taskFilter:IFilter = null, startIndex:int = 0, length:int = -1):com.adobe.ep.taskmanagement.util:ICollectionToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the current list of task filtered by the provided taskFilter.
Parameters
taskFilter:IFilter (default = null ) — Specifies how to filter the returned list of tasks. Default value is null .
| |
startIndex:int (default = 0 ) — Specifies the index of the first task returned. Default value is 0 .
| |
length:int (default = -1 ) — Specifies the number of tasks returned. Default is -1 to return all tasks.
|
com.adobe.ep.taskmanagement.util:ICollectionToken — An object that is used the specify handlers for this asynchronous call.
|
Example ( How to use this example )
var taskManager:ITaskManager; var taskId:String; var taskFilter:IFilter = taskManager.newTaskFilter(); // this example assumes that a tasktype with name "SomeTaskType" is defined on the server taskFilter.taskTypeName = "SomeTaskType"; // and that the SomeTaskType task type defines a property of type 'Date' and name 'aTaskDateProperty' var dateProperty:IProperty = new Property("aTaskDateProperty"); // add one condition to only return tasks with a date property value > 15/2/2011 taskFilter.addCondition(dateProperty, ComparisonOperator.GREATER_THAN, new Date(2011, 2, 15)); // call the server to retrieve the list of tasks matching the provided filter var tokenTask:ICollectionToken = taskManager.getTasks(taskFilter); tokenTask.addResponder(new mx.rpc.Responder( function (event:CollectionResultEvent) : void { // the result is an ArrayCollection of ITask objects var returnValue:ArrayCollection = event.result as ArrayCollection; for(var index:int=0; index<returnValue.length; index++) { var task:ITask = returnValue.getItemAt(index) as ITask; // ... } }, function (event:TaskManagerFaultEvent) : void { // handle getTasks() fault } ));
newTaskFilter | () | method |
public function newTaskFilter(aTaskTypeName:String = null):IFilter
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Factory method to create a new taskfilter object to use with getTasks(taskFilter).
Parameters
aTaskTypeName:String (default = null ) — Specifies the tasktype to filter on. Default value is null .
|
IFilter — A new task filter.
|
Related API Elements
newTaskInstance | () | method |
public function newTaskInstance(taskType:String):com.adobe.ep.taskmanagement.util:IObjectToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Factory method to instantiate the an ITask implementation class instance associated with the ITaskManager implementation.
Note that the returned task is not yet created nor persisted. In order for the task to be persisted you need to call
createTask
or save
.
Parameters
taskType:String — Specifies the name of the tasktype for which to instantiate a task object.
|
com.adobe.ep.taskmanagement.util:IObjectToken — A task object that is used the specify handlers for this asynchronous call.
|
Related API Elements
save | () | method |
public function save(task:com.adobe.ep.taskmanagement.domain:ITask):com.adobe.ep.taskmanagement.util:IObjectToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Persists the given task to the server.
Parameters
task:com.adobe.ep.taskmanagement.domain:ITask — Specifies the task information to persist.
|
com.adobe.ep.taskmanagement.util:IObjectToken — An object that is used the specify handlers for this asynchronous call.
|
Example ( How to use this example )
var taskManager:ITaskManager = null; // ... var task:ITask = null; // ... // save the 'task' object to the server var taskSaveToken:IObjectToken = taskManager.save(task); // add a responder for the result of the save operation taskSaveToken.addResponder(new mx.rpc.Responder( function (event:ObjectResultEvent) : void { // save succesful.. }, function (event:TaskManagerFaultEvent) : void { // save failed, handle fault }));
start | () | method |
public function start(taskId:String):com.adobe.ep.taskmanagement.util:IToken
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Task Management 10 |
Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Starts a task.
Parameters
taskId:String — Specifies the task Id of the task to start.
|
com.adobe.ep.taskmanagement.util:IToken — An object that is used the specify handlers for this asynchronous call.
|
Thu Dec 6 2018, 01:12 PM -08:00