com.webmethods.caf.faces.data.task
Interface ITaskContentProvider

All Superinterfaces:
IContentProvider, IRefreshable, IRefreshableContentProvider, ITransactionalContentProvider, IUpdateableContentProvider
All Known Implementing Classes:
AbstractTaskContentProvider, SimpleTaskContentProvider, TaskContentProvider, TaskContentProviderExtended

public interface ITaskContentProvider
extends ITransactionalContentProvider, IRefreshableContentProvider

ITaskContentProvider is the interface represents content provider for task.

See Also:
ITransactionalContentProvider, IRefreshableContentProvider

Method Summary
 void acceptTask()
          Accepts current task for the current user
 void cancelTask()
          Cancels current task
 void completeTask()
          Updates and completes current task
 void deleteTask()
          Deletes current task
 boolean getAdhocRouting()
          Returns ad-hoc routing configuration setting.
 boolean getAutoAccept()
          Returns auto-accept configuration setting.
 String getCurrentUserID()
          Returns user ID of the current user
 int getMaxAllowedToAccept()
          Returns maximum number of users which may accept a task at a given time.
 boolean getNeedAcceptToUpdate()
          Returns Control indicates whether user must first accept a task before updating it.
 String getTaskID()
          Returns the current task ID
 ITaskInfo getTaskInfo()
          Returns current task info ITaskInfo, or empty object if there is no current task
 String getTaskTypeID()
          Returns New taskTypeID.
 String getTaskTypeName()
          Returns display name of the task type
 void queueNewTask()
          Queues new task using data set in the TaskInfo and TaskData
 void resumeTask()
          Resumes current task
 void setAdhocRouting(boolean allowAdhocRouting)
          Sets ad-hoc routing configuration setting.
 void setAutoAccept(boolean autoAccept)
          Sets auto-accept configuration setting.
 void setMaxAllowedToAccept(int maxAllowedToAccept)
          Sets maximum number of users which may accept a task at a given time.
 void setNeedAcceptToUpdate(boolean c)
          Set control indicates whether user must first accept a task before updating it.
 void setTaskID(String taskID)
          Sets current taskID
 void suspendTask()
          Suspends current task
 void unacceptTask()
          Unaccepts current task from the current user
 
Methods inherited from interface com.webmethods.caf.faces.data.ITransactionalContentProvider
applyChanges, cancelChanges
 
Methods inherited from interface com.webmethods.caf.faces.data.IUpdateableContentProvider
isReadOnly, setValue
 
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider
getPropertyKeys, getType, getValue, hasProperty, toString
 
Methods inherited from interface com.webmethods.caf.faces.data.IRefreshable
getNeedRefresh, isAutoRefresh, refresh, setAutoRefresh, setNeedRefresh, supportsAutoRefresh
 

Method Detail

getTaskID

String getTaskID()
Returns the current task ID


setTaskID

void setTaskID(String taskID)
Sets current taskID

Parameters:
taskID - current taskID

getTaskInfo

ITaskInfo getTaskInfo()
Returns current task info ITaskInfo, or empty object if there is no current task


getTaskTypeID

String getTaskTypeID()
Returns New taskTypeID. This is used only when queueing new tasks


getTaskTypeName

String getTaskTypeName()
Returns display name of the task type


getAutoAccept

boolean getAutoAccept()
Returns auto-accept configuration setting. If set to false the user would have to manually accept/unaccept task for editing. Default is false


setAutoAccept

void setAutoAccept(boolean autoAccept)
Sets auto-accept configuration setting. If set to false the user would have to manually accept/unaccept task for editing. Default is false

Parameters:
autoAccept -

getAdhocRouting

boolean getAdhocRouting()
Returns ad-hoc routing configuration setting. If set to true to allow the user to route an individual task manually. Default is false


setAdhocRouting

void setAdhocRouting(boolean allowAdhocRouting)
Sets ad-hoc routing configuration setting. If true, allow the user to route an individual task manually. Default is false

Parameters:
allowAdhocRouting -

getMaxAllowedToAccept

int getMaxAllowedToAccept()
Returns maximum number of users which may accept a task at a given time. Default is 1


setMaxAllowedToAccept

void setMaxAllowedToAccept(int maxAllowedToAccept)
Sets maximum number of users which may accept a task at a given time. Default is 1

Parameters:
maxAllowedToAccept -

getNeedAcceptToUpdate

boolean getNeedAcceptToUpdate()
Returns Control indicates whether user must first accept a task before updating it. Default is true


setNeedAcceptToUpdate

void setNeedAcceptToUpdate(boolean c)
Set control indicates whether user must first accept a task before updating it. Default is true

Parameters:
c - true means user must first accept a task before updating it

queueNewTask

void queueNewTask()
                  throws ContentProviderException
Queues new task using data set in the TaskInfo and TaskData

Throws:
ContentProviderException

acceptTask

void acceptTask()
                throws ContentProviderException
Accepts current task for the current user

Throws:
ContentProviderException

unacceptTask

void unacceptTask()
                  throws ContentProviderException
Unaccepts current task from the current user

Throws:
ContentProviderException

completeTask

void completeTask()
                  throws ContentProviderException
Updates and completes current task

Throws:
ContentProviderException

cancelTask

void cancelTask()
                throws ContentProviderException
Cancels current task

Throws:
ContentProviderException

deleteTask

void deleteTask()
                throws ContentProviderException
Deletes current task

Throws:
ContentProviderException

suspendTask

void suspendTask()
                 throws ContentProviderException
Suspends current task

Throws:
ContentProviderException

resumeTask

void resumeTask()
                throws ContentProviderException
Resumes current task

Throws:
ContentProviderException

getCurrentUserID

String getCurrentUserID()
                        throws ContentProviderException
Returns user ID of the current user

Throws:
ContentProviderException