com.webmethods.portal.mech.task

Interface ITaskMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IViewableMechanics

public interface ITaskMechanics
extends IBasicMechanics

Class ITaskMechanics

Field Summary

Fields

Modifier and Type	Field and Description
static int	UPDATE_RESULT_SUCCESS
static int	UPDATE_RESULT_TASK_MUTABLE
static int	UPDATE_RESULT_TASK_NOT_UP_TO_DATE

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Method Summary

Modifier and Type	Method and Description
String	canUpdateTask(IURI principalURI, IURI taskURI, Map<String,?> properties) Obtains container ID where task comments should be stored.
void	checkCreateCollaboration(IURI principalURI, IURI taskDefinitionURI) Throws PortalAccessException if principal may not create a collaboration tasks for the specified task type
void	checkCreateTask(IURI principalURI, IURI taskDefinitionURI) Throws PortalAccessException if principal may not create a task of a given type
void	checkRollbackTask(IURI principalURI, IURI taskURI) PortalAccessException is thrown if principal does not have rights to update task
void	checkUpdateTask(IURI principalURI, IURI taskURI, Map<String,?> properties) PortalAccessException is thrown if principal does not have rights to update task
void	checkViewTask(IURI principalURI, IURI taskURI) PortalAccessException is thrown if principal does not have rights to view task info
void	checkViewTaskAudit(IURI principalURI, IURI taskURI) PortalAccessException is thrown if principal does not have rights to view task audit
IURI	createTask(IURI principalURI, IURI taskDefinitionURI, Map<String,?> properties)
void	fireCreateTaskEvent(IURI principalURI, IURI taskURI, int status) Fires create new task event
default void	fireTaskReindexStopEvent(ITaskDefinition taskDefinition) Fires stop reindex task event
void	fireTaskReindexStopEvent(ITaskDefinition taskDefinition, String indexEngineType) Fires stop reindex task event
default void	fireTaskVotingStrategyUpdateStopEvent(ITaskDefinition taskDefinition) Fires stop voting strategy update task event
void	fireTaskVotingStrategyUpdateStopEvent(ITaskDefinition taskDefinition, String indexEngineType) Fires stop Voting Strategy Update task event
void	fireUpdateTaskEvent(IURI principalURI, IURI taskURI, int status, DifferenceMap diffMap) Fires update task event
IThingID	getAttachmentsContainerID(IThingID taskID) Obtains container ID where task attachments should be stored.
IThingID	getCommentsContainerID(IThingID taskID) Obtains container ID where task comments should be stored.
ITask	getTask(IURI taskURI) Returns instance of the task
List<ITaskAuditEntry>	getTaskAudit(IURI taskURI) Returns list of ITaskAuditEntry audit entries for the task
List<ITaskAuditEntry>	getTaskAudit(IURI taskURI, int fromIndex, int toIndex)
Object	getTaskData(IURI taskURI) Returns instance of task data
IURI	getTaskURIByCustomID(String externalID) Returns task uri by task external (correlation) ID
boolean	isTaskAssignedToPrincipal(IURI principalURI, IURI taskURI, boolean includeRoles, boolean activeTasksOnly) Checks if task is still in the user inbox
IURI	isTaskDelegatedToPrincipal(IURI principalURI, IURI taskURI) Checks if the task is delegated to that principal
ITaskList	listAllTasks(IURI principalURI) Queries for all tasks
ITaskList	listAllTasks(IURI principalURI, TaskSearchQuery taskQuery) Queries for all tasks.
int	listAllTasksCount(IURI principalURI, TaskSearchQueryV2 taskQuery, boolean includeRoles, boolean businessData) Queries for tasks in the given user's inbox which match passed search query and return total number of tasks
List<ITaskSearchRecord>	listAllTasksPaged(IURI principalURI, TaskSearchQueryV2 taskQuery, boolean includeRoles, boolean businessData) Queries for tasks in the given user's inbox which match passed search query
ITaskList	listUserTasks(IURI principalURI) Queries for tasks in the given user inbox
ITaskList	listUserTasks(IURI principalURI, TaskSearchQuery taskQuery, boolean includeRoles) Queries for tasks in the given user inbox.
int	listUserTasksCount(IURI principalURI, TaskSearchQueryV2 taskQuery, boolean includeRoles, boolean businessData) Queries for tasks in the given user's inbox which match passed search query and return total number of tasks
List<ITaskSearchRecord>	listUserTasksPaged(IURI principalURI, TaskSearchQueryV2 taskQuery, boolean includeRoles, boolean businessData) Queries for tasks in the given user's inbox which match passed search query
void	processSinkRequest(String sourceID, List<String> contents, MimeMessage mimeMessage) Processes request from external sink
void	rollbackTask(IURI principalURI, IURI taskURI, int auditEntryID) Reverts task state to the point indicated by auditEntryID
int	updateTask(IURI principalURI, IURI taskURI, Map<String,?> properties, int taskVersionNumber, boolean lockTask) Updates task
int	updateTask(IURI principalURI, IURI taskURI, Map<String,?> properties, int taskVersionNumber, boolean lockTask, boolean syncUpdate, boolean hiddenUpdate) Updates task

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

Methods inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Field Detail

UPDATE_RESULT_SUCCESS

static final int UPDATE_RESULT_SUCCESS

See Also:

Constant Field Values

UPDATE_RESULT_TASK_MUTABLE

static final int UPDATE_RESULT_TASK_MUTABLE

See Also:

Constant Field Values

UPDATE_RESULT_TASK_NOT_UP_TO_DATE

static final int UPDATE_RESULT_TASK_NOT_UP_TO_DATE

See Also:

Constant Field Values

Method Detail

checkCreateTask

void checkCreateTask(IURI principalURI,
                     IURI taskDefinitionURI)
              throws PortalException,
                     PortalAccessException

Throws PortalAccessException if principal may not create a task of a given type

Parameters:

principalURI -

taskDefinitionURI -

Throws:

PortalException

PortalAccessException

checkCreateCollaboration

void checkCreateCollaboration(IURI principalURI,
                              IURI taskDefinitionURI)
                       throws PortalException,
                              PortalAccessException

Throws PortalAccessException if principal may not create a collaboration tasks for the specified task type

Parameters:

principalURI -

taskDefinitionURI -

Throws:

PortalException

PortalAccessException

checkUpdateTask

void checkUpdateTask(IURI principalURI,
                     IURI taskURI,
                     Map<String,?> properties)
              throws PortalException,
                     PortalAccessException

PortalAccessException is thrown if principal does not have rights to update task

Parameters:

principalURI -

taskURI -

Throws:

PortalException

PortalAccessException

checkViewTask

void checkViewTask(IURI principalURI,
                   IURI taskURI)
            throws PortalException,
                   PortalAccessException

PortalAccessException is thrown if principal does not have rights to view task info

Parameters:

principalURI -

taskURI -

Throws:

PortalException

PortalAccessException

checkViewTaskAudit

void checkViewTaskAudit(IURI principalURI,
                        IURI taskURI)
                 throws PortalException,
                        PortalAccessException

PortalAccessException is thrown if principal does not have rights to view task audit

Parameters:

principalURI -

taskURI -

Throws:

PortalException

PortalAccessException

checkRollbackTask

void checkRollbackTask(IURI principalURI,
                       IURI taskURI)
                throws PortalException,
                       PortalAccessException

PortalAccessException is thrown if principal does not have rights to update task

Parameters:

principalURI -

taskURI -

Throws:

PortalException

PortalAccessException

fireCreateTaskEvent

void fireCreateTaskEvent(IURI principalURI,
                         IURI taskURI,
                         int status)
                  throws PortalException

Fires create new task event

Parameters:

principalURI -

taskURI -

status -

Throws:

PortalException

fireUpdateTaskEvent

void fireUpdateTaskEvent(IURI principalURI,
                         IURI taskURI,
                         int status,
                         DifferenceMap diffMap)
                  throws PortalException

Fires update task event

Parameters:

principalURI -

taskURI -

status -

diffMap -

Throws:

PortalException

fireTaskReindexStopEvent

default void fireTaskReindexStopEvent(ITaskDefinition taskDefinition)
                               throws PortalException

Fires stop reindex task event

Parameters:

taskDefinition -

Throws:

PortalException

fireTaskReindexStopEvent

void fireTaskReindexStopEvent(ITaskDefinition taskDefinition,
                              String indexEngineType)
                       throws PortalException

Fires stop reindex task event

Parameters:

taskDefinition -

indexEngineType -

Throws:

PortalException

createTask

IURI createTask(IURI principalURI,
                IURI taskDefinitionURI,
                Map<String,?> properties)
         throws PortalException

Parameters:

principalURI -

taskDefinitionURI -

properties - propeties of new task

Returns:

Throws:

PortalException

updateTask

int updateTask(IURI principalURI,
               IURI taskURI,
               Map<String,?> properties,
               int taskVersionNumber,
               boolean lockTask)
        throws PortalException

Updates task

Parameters:

principalURI -

taskURI -

properties -

taskVersionNumber - optional task version number to check for stale task

lockTask - whether task should be locked during update operation

Returns:

UPDATE_RESULT_SUCCESS, UPDATE_RESULT_TASK_MUTABLE, UPDATE_RESULT_TASK_NOT_UP_TO_DATE

Throws:

PortalException

updateTask

int updateTask(IURI principalURI,
               IURI taskURI,
               Map<String,?> properties,
               int taskVersionNumber,
               boolean lockTask,
               boolean syncUpdate,
               boolean hiddenUpdate)
        throws PortalException

Updates task

Parameters:

principalURI -

taskURI -

properties -

taskVersionNumber - optional task version number to check for stale task

lockTask - whether task should be locked during update operation

Returns:

UPDATE_RESULT_SUCCESS, UPDATE_RESULT_TASK_MUTABLE, UPDATE_RESULT_TASK_NOT_UP_TO_DATE

Throws:

PortalException

rollbackTask

void rollbackTask(IURI principalURI,
                  IURI taskURI,
                  int auditEntryID)
           throws PortalException

Reverts task state to the point indicated by auditEntryID

Parameters:

principalURI -

taskURI -

auditEntryID -

Throws:

PortalException

getTaskURIByCustomID

IURI getTaskURIByCustomID(String externalID)
                   throws PortalException

Returns task uri by task external (correlation) ID

Parameters:

externalID -

Returns:

task URI or not found

Throws:

PortalException

getTask

ITask getTask(IURI taskURI)
       throws PortalException

Returns instance of the task

Parameters:

taskURI -

Returns:

Throws:

PortalException

getTaskData

Object getTaskData(IURI taskURI)
            throws PortalException

Returns instance of task data

Parameters:

taskURI -

Returns:

Throws:

PortalException

getTaskAudit

List<ITaskAuditEntry> getTaskAudit(IURI taskURI)
                            throws PortalException

Returns list of ITaskAuditEntry audit entries for the task

Parameters:

taskURI -

Returns:

Throws:

PortalException

getTaskAudit

List<ITaskAuditEntry> getTaskAudit(IURI taskURI,
                                   int fromIndex,
                                   int toIndex)
                            throws PortalException

Parameters:

taskURI -

fromIndex -

toIndex -

Returns:

List of Task Audit entries based on parameters

Throws:

PortalException

isTaskAssignedToPrincipal

boolean isTaskAssignedToPrincipal(IURI principalURI,
                                  IURI taskURI,
                                  boolean includeRoles,
                                  boolean activeTasksOnly)
                           throws PortalException,
                                  com.webmethods.caf.rules.RuleException

Checks if task is still in the user inbox

Parameters:

principalURI -

taskURI -

includeRoles - TODO

activeTasksOnly - TODO

Returns:

Throws:

PortalException

com.webmethods.caf.rules.RuleException

isTaskDelegatedToPrincipal

IURI isTaskDelegatedToPrincipal(IURI principalURI,
                                IURI taskURI)
                         throws PortalException

Checks if the task is delegated to that principal

Parameters:

principalURI -

taskURI -

Returns:

URI of the principal who delegated the given task or null if task is not delegated

Throws:

PortalException

listAllTasks

ITaskList listAllTasks(IURI principalURI,
                       TaskSearchQuery taskQuery)
                throws PortalException

Queries for all tasks. Only tasks that user may see are returned

Parameters:

principalURI -

cookie -

rights - access rights to check

Returns:

Throws:

PortalException

listAllTasks

ITaskList listAllTasks(IURI principalURI)
                throws PortalException

Queries for all tasks

Parameters:

principalURI -

rights - access rights to check

Returns:

Throws:

PortalException

listUserTasks

ITaskList listUserTasks(IURI principalURI,
                        TaskSearchQuery taskQuery,
                        boolean includeRoles)
                 throws PortalException,
                        com.webmethods.caf.rules.RuleException

Queries for tasks in the given user inbox.

Parameters:

principalURI -

includeRoles - TODO

cookie -

rights - access to check

Returns:

Throws:

PortalException

com.webmethods.caf.rules.RuleException

listUserTasksPaged

List<ITaskSearchRecord> listUserTasksPaged(IURI principalURI,
                                           TaskSearchQueryV2 taskQuery,
                                           boolean includeRoles,
                                           boolean businessData)
                                    throws PortalException

Queries for tasks in the given user's inbox which match passed search query

Throws:

PortalException

listUserTasksCount

int listUserTasksCount(IURI principalURI,
                       TaskSearchQueryV2 taskQuery,
                       boolean includeRoles,
                       boolean businessData)
                throws PortalException

Queries for tasks in the given user's inbox which match passed search query and return total number of tasks

Throws:

PortalException

listAllTasksPaged

List<ITaskSearchRecord> listAllTasksPaged(IURI principalURI,
                                          TaskSearchQueryV2 taskQuery,
                                          boolean includeRoles,
                                          boolean businessData)
                                   throws PortalException

Queries for tasks in the given user's inbox which match passed search query

Throws:

PortalException

listAllTasksCount

int listAllTasksCount(IURI principalURI,
                      TaskSearchQueryV2 taskQuery,
                      boolean includeRoles,
                      boolean businessData)
               throws PortalException

Queries for tasks in the given user's inbox which match passed search query and return total number of tasks

Throws:

PortalException

listUserTasks

ITaskList listUserTasks(IURI principalURI)
                 throws PortalException,
                        com.webmethods.caf.rules.RuleException

Queries for tasks in the given user inbox

Parameters:

principalURI -

rights - access rights to check

Returns:

Throws:

PortalException

com.webmethods.caf.rules.RuleException

processSinkRequest

void processSinkRequest(String sourceID,
                        List<String> contents,
                        MimeMessage mimeMessage)
                 throws PortalException

Processes request from external sink

Parameters:

sourceID - identifier of the source of the request. Generally this is some string which helps to identify the source of the request. For example for email sink this could be messageID or From: email address

contents - request content. May be multipart

Throws:

PortalException

getAttachmentsContainerID

IThingID getAttachmentsContainerID(IThingID taskID)
                            throws PortalException

Obtains container ID where task attachments should be stored. Creates new container if necessary

Parameters:

taskID -

Throws:

PortalException

getCommentsContainerID

IThingID getCommentsContainerID(IThingID taskID)
                         throws PortalException

Obtains container ID where task comments should be stored. Creates new container if necessary

Parameters:

taskID -

Throws:

PortalException

canUpdateTask

String canUpdateTask(IURI principalURI,
                     IURI taskURI,
                     Map<String,?> properties)
              throws PortalException

Obtains container ID where task comments should be stored. Creates new container if necessary

Parameters:

taskID -

Throws:

PortalException

fireTaskVotingStrategyUpdateStopEvent

default void fireTaskVotingStrategyUpdateStopEvent(ITaskDefinition taskDefinition)
                                            throws PortalException

Fires stop voting strategy update task event

Parameters:

taskDefinition -

Throws:

PortalException

fireTaskVotingStrategyUpdateStopEvent

void fireTaskVotingStrategyUpdateStopEvent(ITaskDefinition taskDefinition,
                                           String indexEngineType)
                                    throws PortalException

Fires stop Voting Strategy Update task event

Parameters:

taskDefinition -

indexEngineType -

Throws:

PortalException