Package com.webmethods.portal.service.task

Interface ITask

All Superinterfaces:

ITaskConstants, IView, Serializable

public interface ITask
extends IView, ITaskConstants

Class ITask

Field Summary

Fields inherited from interface com.webmethods.portal.service.task.ITaskConstants

ACCEPT_OTHERS_RIGHT, ACCEPT_RIGHT, ASSIGN_RIGHT, ATTRIBUTE_CALLBACK_DATA, ATTRIBUTE_CALLBACK_SERVICE, ATTRIBUTE_RULE_SET, CALLBACK_TASK_CALLBACK_DATA, CALLBACK_TASK_COMPLETION_INFO, CALLBACK_TASK_DATA, CONFIG_PORTLET_ALIAS, DELETE_RIGHT, EDA_MASK_TASK_CREATED, EDA_MASK_TASK_DELETED, EDA_MASK_TASK_UPDATED, MODIFY_PERMISSION_RIGHT, MODIFY_TASK_DATA_RIGHT, MODIFY_TASK_INFO_RIGHT, OPERATION_ACCEPTED, OPERATION_CREATED, OPERATION_DELEGATION_RULE, OPERATION_DIST_FILTER_RULE, OPERATION_DIST_RULE, OPERATION_ERROR, OPERATION_RESUME, OPERATION_REVERTED, OPERATION_SCHEDULE_RULE, OPERATION_SUSPEND, OPERATION_TRIGGER_RULE, OPERATION_UNACCEPTED, OPERATION_UPDATE, PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_NONE, PROCESS_AUDIT_POOL_NAME, PROCESS_PRE_TDE_STEP, PROPERTY_TASK_ID, PRT_STEP_CANCEL, PRT_STEP_COMPLETE, PRT_STEP_EXPIRE, PRT_STEP_FAIL, PRT_TASK_ANALYTICS_ENABLED, PRT_TASK_AUDIT_ENABLED, QUEUE_TASK_RIGHT, ROLLBACK_RIGHT, RULE_ATTR_BUSINESS_RULES, RULE_ATTR_CHECK_TIME, RULE_ATTR_DELEGATION_SOURCE, RULE_ATTR_DO_NOT_FIRE, RULE_ATTR_ERROR_CODE, RULE_ATTR_ERROR_MESSAGE, RULE_ATTR_EXPAND_ROLE_MEMBERS, RULE_ATTR_EXPIRING, RULE_ATTR_FIRE_ONCE, RULE_ATTR_FROM_TIMESTAMP, RULE_ATTR_PRINCIPAL_TYPES, RULE_ATTR_PRINCIPAL_TYPES_DELIM, RULE_ATTR_RESULT_TYPE, RULE_ATTR_RULE_SET, RULE_ATTR_RULE_TYPE, RULE_ATTR_RUNNING, RULE_ATTR_SCHEDULE_DATE_BEAN, RULE_ATTR_START_TIME, RULE_ATTR_TASK_DEF_URI, RULE_ATTR_TO_TIMESTAMP, RULE_ATTR_WORKLOAD_PROVIDER, RULE_ATTR_WORKLOAD_PROVIDER_TYPE, RULE_COMMENTS, RULE_CONTEXT_CHANGE_RULES, RULE_CONTEXT_ROUTING_RULES, RULE_CONTEXT_SYSTEM_OBJECT, RULE_CURRENT_TASK, RULE_CURRENT_TASK_EXTENDED, RULE_FACES_CONTEXT, RULE_NEW_CHILD_TASK, RULE_NEW_TASK, RULE_OLD_TASK, RULE_PARENT_TASK, RULE_PRINCIPAL, RULE_RESULT_CANCEL, RULE_RESULT_COMPLETE, RULE_RESULT_ERROR, RULE_RESULT_EXPIRE, RULE_RESULT_EXPRESSION, RULE_RESULT_LAST_ACCEPTED_BY, RULE_RESULT_PRINCIPALS, RULE_RESULT_REPLY, RULE_RESULT_STOP, RULE_ROLE, RULE_TYPE_CHANGE, RULE_TYPE_DELEGATION, RULE_TYPE_DISTRIBUTION, RULE_TYPE_FILTER, RULE_TYPE_SCHEDULE, RULE_USER, START_STOP_RIGHT, STATUS_ACTIVE, STATUS_CANCELLED, STATUS_COMPLETED, STATUS_ERROR, STATUS_EXPIRED, STATUS_NEW, STATUS_OUTDATED, STATUS_SCHEDULED, STATUS_SUSPENDED, STATUS_UNDEFINED, STORAGE_ROOT, STORAGE_TYPE_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_PREFIX, STORAGE_TYPE_NAME_PROCESS, STORAGE_TYPE_NAME_PROCESS_RULESET, STORAGE_TYPE_PATTERN, STORAGE_TYPE_PROCESS, STORAGE_TYPE_PROCESS_RULESET, STORAGE_TYPE_TASK, TASK_ATTACHMENTS_FOLDER, TASK_ATTACHMENTS_FOLDER_TYPE, TASK_ATTACHMENTS_RELATION, TASK_AUDIT_DELEGATED_BY, TASK_AUDIT_DIFFERENCE, TASK_AUDIT_PROPERTIES, TASK_AUDIT_VOTE, TASK_AUDIT_VOTING_FINISHED, TASK_COMMENTS_FOLDER, TASK_COMMENTS_FOLDER_TYPE, TASK_COMMENTS_RELATION, TASK_DATA_BINDING, TASK_DATA_BINDING_PREFIX, TASK_DATA_PROPERTY_PREFIX, TASK_DEFINITION_STORAGE, TASK_DETAILS_PAGE, TASK_DETAILS_PORTLET, TASK_FIELD_ACCEPT_BY_CSV, TASK_FIELD_ACCEPT_BY_NAME, TASK_FIELD_ACCEPT_BY_URI, TASK_FIELD_ACCEPTED_BY_CURRENT, TASK_FIELD_ACCEPTED_BY_LIST, TASK_FIELD_ASSIGNED_TO_CSV, TASK_FIELD_ASSIGNED_TO_LIST, TASK_FIELD_ASSIGNED_TO_NAME, TASK_FIELD_ASSIGNED_TO_URI, TASK_FIELD_ATTRIBUTES, TASK_FIELD_AUDIT_CONTEXT, TASK_FIELD_CHILD_TASK_COUNT, TASK_FIELD_COLLABORATION_PROCESS_ID, TASK_FIELD_COLLABORATION_STEP_ID, TASK_FIELD_CONTRIBUTED_BY_LIST, TASK_FIELD_CREATED_BY, TASK_FIELD_CREATED_BY_NAME, TASK_FIELD_CREATED_BY_URI, TASK_FIELD_CREATED_DATE, TASK_FIELD_CUSTOM_TASK_ID, TASK_FIELD_DELEGATED_FROM_LIST, TASK_FIELD_DELEGATED_TO_LIST, TASK_FIELD_DESCRIPTION, TASK_FIELD_ERROR_CODE, TASK_FIELD_ERROR_MESSAGE, TASK_FIELD_EXPIRE_DATE, TASK_FIELD_FOR_PROCESS, TASK_FIELD_IS_MANDATORY, TASK_FIELD_IS_VOTABLE, TASK_FIELD_LAST_ACCEPTED_BY, TASK_FIELD_LAST_ACCEPTED_BY_NAME, TASK_FIELD_LAST_ACCEPTED_DATE, TASK_FIELD_LAST_MODIFIED_BY, TASK_FIELD_LAST_MODIFIED_BY_NAME, TASK_FIELD_LAST_MODIFIED_BY_URI, TASK_FIELD_LAST_MODIFIED_DATE, TASK_FIELD_NAME, TASK_FIELD_PARENT_TASK_ID, TASK_FIELD_PRIORITY, TASK_FIELD_PRIORITY_NAME, TASK_FIELD_PROCESS_INSTANCE_ID, TASK_FIELD_PROCESS_ITERATION, TASK_FIELD_PROCESS_MODEL_ID, TASK_FIELD_PROCESS_MODEL_VERSION, TASK_FIELD_PROCESSED_RULES_LIST, TASK_FIELD_ROOT_PROCESS_INSTANCE_ID, TASK_FIELD_STATUS, TASK_FIELD_STATUS_NAME, TASK_FIELD_STEP_ID, TASK_FIELD_STEP_ITERATION, TASK_FIELD_TASK_DATA, TASK_FIELD_TASK_ID, TASK_FIELD_TASK_SCHEDULE_DATE, TASK_FIELD_TASK_TYPE_ID, TASK_FIELD_TASK_TYPE_NAME, TASK_FIELD_TASK_TYPE_URI, TASK_FIELD_TASK_URL, TASK_FIELD_UNACCEPT_FROM_NAME, TASK_FIELD_UNACCEPT_FROM_URI, TASK_FIELD_VERSION, TASK_GLOBAL_DISTRIBUTION_RULES, TASK_GLOBAL_SCHEDULE_RULES, TASK_GLOBAL_TRIGGER_RULES, TASK_INFO_BINDING, TASK_INFO_BINDING_PREFIX, TASK_OPERATION_ACCEPTED, TASK_OPERATION_ASSIGNMENT_CHANGED, TASK_OPERATION_ATTACHMENT_ADDED, TASK_OPERATION_ATTACHMENT_DELETED, TASK_OPERATION_ATTACHMENT_UPDATED, TASK_OPERATION_CANCEL, TASK_OPERATION_COMMENT_ADDED, TASK_OPERATION_COMMENT_DELETED, TASK_OPERATION_COMMENT_UPDATED, TASK_OPERATION_COMPLETE, TASK_OPERATION_CREATED, TASK_OPERATION_DELEGATION_CHANGED, TASK_OPERATION_DELEGATION_RULE_FIRED, TASK_OPERATION_DISTRIBUTION_RULE_FIRED, TASK_OPERATION_ERROR, TASK_OPERATION_EXPIRE, TASK_OPERATION_NOTIFICATION, TASK_OPERATION_REPLY, TASK_OPERATION_RESUME, TASK_OPERATION_REVERTED, TASK_OPERATION_ROLLEDBACK, TASK_OPERATION_SCHEDULE_RULE_FIRED, TASK_OPERATION_SINK_REQUEST, TASK_OPERATION_START, TASK_OPERATION_STOP, TASK_OPERATION_SUSPEND, TASK_OPERATION_TRIGGER_RULE_FIRED, TASK_OPERATION_UNACCEPTED, TASK_OPERATION_UNHANDLED_ERROR, TASK_OPERATION_UPDATE, TASK_OPERATION_VOTE, TASK_OPERATION_VOTING_STRATEGY_UPDATE, TASK_PRIORITY_CRITICAL, TASK_PRIORITY_HIGH, TASK_PRIORITY_LOW, TASK_PRIORITY_MEDIUM, TASK_PRIORITY_NONE, TASK_RULES_STORAGE, TASK_SEARCH_RAW_WHERE_CLAUSE, TASK_SEARCH_RAW_WHERE_CLAUSE_PREFIX, TASK_STATUS_ACTIVE, TASK_STATUS_CANCELLED, TASK_STATUS_COMPLETED, TASK_STATUS_ERROR, TASK_STATUS_EXPIRED, TASK_STATUS_NEW, TASK_STATUS_OUTDATED, TASK_STATUS_SCHEDULED, TASK_STATUS_SUSPENDED, TASK_STATUS_UNDEFINED, TASK_STORAGE, TASK_TABLE_TASK, TASK_TABLE_TASK_INBOX, TASK_TAGS, TASK_VOTING_STRATEGY_FIXED_NUMBER, TASK_VOTING_STRATEGY_PERCENTAGE, VIEW_TASK_AUDIT_RIGHT, VIEW_TASK_DATA_RIGHT, VIEW_TASK_INFO_RIGHT

Fields inherited from interface com.webmethods.portal.service.view.IView

PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

Modifier and Type	Method	Description
List<IURI>	getAcceptedByList()	List of principal ID's who currently accepted the task
List<IURI>	getAssignedToList()	List of principals IURI's whom this task is assigned to
Map<String,Object>	getAttributes()	Returns map of custom task attributes
String	getAuditContext()	ProcessContext: AuditContext
int	getChildTaskCount()	Returns number of collaboration child tasks
String	getCollaborationProcessID()	Returns ID of collaboration process for this task
String	getCollaborationStepID()	Returns ID of collaboration process for this task
List<Integer>	getContributedByList()	List of principal ID's who have contributed to this task
IURI	getCreatedBy()	Principal who created the task
Date	getCreatedDate()	Date when task was created
String	getCustomTaskID()	Custom task ID used in the auditing
List<IURI>	getDelegatedFromList()	List of principals IURI's who delegated this task
List<IURI>	getDelegatedToList()	List of principals IURI's whom this task is delegated
String	getDescription()	Task description
String	getErrorCode()	Task error code if any
String	getErrorMessage()	Task error message if any
Date	getExpireDate()	Expiration date for this task.
Integer	getIsMandatory()	Returns if is mandatory
default Integer	getIsVotable()	Returns positive number if the task is votable and 0 if it is not
IURI	getLastAcceptedBy()	Last principal which accepted a task
Date	getLastAcceptedDate()	Timestamp when task was accepted
IURI	getLastModifiedBy()	Principal who modified the task
Date	getLastModifiedDate()	Date when task was last modified
String	getName()	Task name
int	getParentTaskID()	Returns parent task ID from collaboration process
int	getPendingUpdates()	Returns number of non-processed yet (pending) update operations for this task instance
int	getPriority()	Priority value for this task
List<IThingID>	getProcessedRulesList()	List of routing and delegation rules already processed for this task instance
String	getProcessInstanceID()	ProcessContext: ProcessInstanceID
int	getProcessIteration()	ProcessContext: ProcessIteration
String	getProcessModelID()	ProcessContext: ProcessModelID
String	getProcessModelVersion()	ProcessContext: ProcessModelVersion
String	getRootProcessInstanceID()	ProcessContext: RootProcessInstanceID
int	getStatus()	Returns current status for this task
String	getStepID()	ProcessContext: SourceStepID
int	getStepIteration()	ProcessContext: tryCount
IURI	getTaskDefinitionURI()	Returns task definition URI for this task
Date	getTaskScheduleDate()	Returns task schedule start date
default String	getTaskVotingTable()	Returns XML representation of the voting table
int	getVersionNumber()	Returns unique task data version number
boolean	hasChildTasks()	Returns true is this task has collaboration child tasks

Methods inherited from interface com.webmethods.portal.service.view.IView

getProperties, getProperty, getPropertyNames, getURI

Method Details

getName

String getName()
        throws PortalException

Task name

Throws:

PortalException

getDescription

String getDescription()
               throws PortalException

Task description

Throws:

PortalException

getTaskDefinitionURI

IURI getTaskDefinitionURI()
                   throws PortalException

Returns task definition URI for this task

Throws:

PortalException

getStatus

int getStatus()
       throws PortalException

Returns current status for this task

Throws:

PortalException

getCreatedDate

Date getCreatedDate()
             throws PortalException

Date when task was created

Throws:

PortalException

getCreatedBy

IURI getCreatedBy()
           throws PortalException

Principal who created the task

Throws:

PortalException

getLastModifiedDate

Date getLastModifiedDate()
                  throws PortalException

Date when task was last modified

Throws:

PortalException

getLastModifiedBy

IURI getLastModifiedBy()
                throws PortalException

Principal who modified the task

Throws:

PortalException

getLastAcceptedBy

IURI getLastAcceptedBy()
                throws PortalException

Last principal which accepted a task

Throws:

PortalException

getLastAcceptedDate

Date getLastAcceptedDate()
                  throws PortalException

Timestamp when task was accepted

Throws:

PortalException

getAcceptedByList

List<IURI> getAcceptedByList()
                      throws PortalException

List of principal ID's who currently accepted the task

Throws:

PortalException

getContributedByList

List<Integer> getContributedByList()
                            throws PortalException

List of principal ID's who have contributed to this task

Throws:

PortalException

getAssignedToList

List<IURI> getAssignedToList()
                      throws PortalException

List of principals IURI's whom this task is assigned to

Throws:

PortalException

getDelegatedToList

List<IURI> getDelegatedToList()
                       throws PortalException

List of principals IURI's whom this task is delegated

Throws:

PortalException

getDelegatedFromList

List<IURI> getDelegatedFromList()
                         throws PortalException

List of principals IURI's who delegated this task

Throws:

PortalException

getProcessedRulesList

List<IThingID> getProcessedRulesList()
                              throws PortalException

List of routing and delegation rules already processed for this task instance

Throws:

PortalException

getPriority

int getPriority()
         throws PortalException

Priority value for this task

Throws:

PortalException

getExpireDate

Date getExpireDate()
            throws PortalException

Expiration date for this task. May be null

Throws:

PortalException

getVersionNumber

int getVersionNumber()
              throws PortalException

Returns unique task data version number

Throws:

PortalException

getPendingUpdates

int getPendingUpdates()
               throws PortalException

Returns number of non-processed yet (pending) update operations for this task instance

Throws:

PortalException

getProcessInstanceID

String getProcessInstanceID()
                     throws PortalException

ProcessContext: ProcessInstanceID

Throws:

PortalException

getRootProcessInstanceID

String getRootProcessInstanceID()
                         throws PortalException

ProcessContext: RootProcessInstanceID

Throws:

PortalException

getProcessModelID

String getProcessModelID()
                  throws PortalException

ProcessContext: ProcessModelID

Throws:

PortalException

getStepID

String getStepID()
          throws PortalException

ProcessContext: SourceStepID

Throws:

PortalException

getProcessModelVersion

String getProcessModelVersion()
                       throws PortalException

ProcessContext: ProcessModelVersion

Throws:

PortalException

getProcessIteration

int getProcessIteration()
                 throws PortalException

ProcessContext: ProcessIteration

Throws:

PortalException

getStepIteration

int getStepIteration()
              throws PortalException

ProcessContext: tryCount

Throws:

PortalException

getAuditContext

String getAuditContext()
                throws PortalException

ProcessContext: AuditContext

Throws:

PortalException

getCustomTaskID

String getCustomTaskID()
                throws PortalException

Custom task ID used in the auditing

Throws:

PortalException

getAttributes

Map<String,Object> getAttributes()
                          throws PortalException

Returns map of custom task attributes

Throws:

PortalException

getErrorCode

String getErrorCode()
             throws PortalException

Task error code if any

Throws:

PortalException

getErrorMessage

String getErrorMessage()
                throws PortalException

Task error message if any

Throws:

PortalException

getCollaborationProcessID

String getCollaborationProcessID()
                          throws PortalException

Returns ID of collaboration process for this task

Throws:

PortalException

getCollaborationStepID

String getCollaborationStepID()
                       throws PortalException

Returns ID of collaboration process for this task

Throws:

PortalException

getParentTaskID

int getParentTaskID()
             throws PortalException

Returns parent task ID from collaboration process

Throws:

PortalException

hasChildTasks

boolean hasChildTasks()
               throws PortalException

Returns true is this task has collaboration child tasks

Throws:

PortalException

getChildTaskCount

int getChildTaskCount()
               throws PortalException

Returns number of collaboration child tasks

Throws:

PortalException

getIsMandatory

Integer getIsMandatory()
                throws PortalException

Returns if is mandatory

Throws:

PortalException

getTaskScheduleDate

Date getTaskScheduleDate()
                  throws PortalException

Returns task schedule start date

Throws:

PortalException

getIsVotable

default Integer getIsVotable()
                      throws PortalException

Returns positive number if the task is votable and 0 if it is not

Throws:

PortalException

getTaskVotingTable

default String getTaskVotingTable()
                           throws PortalException

Returns XML representation of the voting table

Throws:

PortalException