com.webmethods.portal.mech.task

Interface ITaskHelper

public interface ITaskHelper

Method Summary

Modifier and Type	Method and Description
Map<String,Map<Object,Object>>	convertDecisionTablesFromXml(Object decisionTablesXml)
Map<String,Map<Object,Object>>	convertDecisionTablesFromXml(Object decisionTablesXml, FacesContext facesContext)
ClassLoader	getClassLoader(ITask task)
ClassLoader	getClassLoader(ITaskDefinition taskDef)
ClassLoader	getClassLoader(IURI taskURI) Obtains task application classloader for the given taskUri
ClassLoader	getClassLoaderIfExists(ITaskDefinition taskDef)
IURI	getCurrentTaskURI() Returns task URI from the current thread
String	getDisplayName(ITaskChangedEvent event)
String	getDisplayName(IURI uri)
String	getDisplayName(List<? extends IURI> uriList)
int	getIntOperation(String operation)
int	getIntPriority(String priority)
int	getIntStatus(String status)
IClusterLockingService	getLockingService() Returns instance of cluster locking service
String	getOperationDisplayName(int operation)
List<IURI>	getPrincipalsFromDecisionTable(Map<String,Map<Object,Object>> paramMap)
IURI[]	getPrincipalsList(Object principals) Returns list of principals uris from object
IURI[]	getPrincipalsList(Object principals, Object principalTypes)
String	getPriorityDisplayName(int priority)
String	getPriorityTitlesCSV()
String	getPriorityValuesCSV()
com.webmethods.caf.rules.IRule	getRule(IURI ruleURI)
com.webmethods.caf.rules.IRuleBuilder	getRuleBuilder()
IPortalRulesMechanics	getRuleMechanics()
List<IThingID>	getRulesList(IThingID folderID, boolean nested, boolean includeNotFired) Returns sorted list of enabled rules from the given folder and subfolders
String	getRuleType(IURI ruleURI)
String	getRunningDisplayName(boolean isRunning)
String	getStatusDisplayName(int status)
String	getStatusTitlesCSV()
String	getStatusValuesCSV()
String	getStringOperation(int operation)
String	getStringPriority(int priority)
String	getStringStatus(int status)
ITaskAuditService	getTaskAuditService()
ITaskDefinition	getTaskDefinitionByName(String taskDefName)
ITaskDefinitionService	getTaskDefinitionService()
ITaskDistributionService	getTaskDistributionService()
ITaskFormFlowService	getTaskFormFlowService() Returns singleton instance for Task Form Flow service
ITaskMechanics	getTaskMechanics()
ITaskMonitoringService	getTaskMonitoringService()
ITaskProcessAuditService	getTaskProcessAuditService()
String	getTaskRuleSet(ITask task) Returns rule set value for given task
ITaskService	getTaskService()
IThingID	getThingID(IURI uri)
IURI	getURI(int id)
IURI	getURI(String id)
boolean	isRuleEnabled(IURI ruleURI) Determines if specified rule is enabled
boolean	isRuleType(IThingID ruleID) Checks if given thingID points to a Rule thing
boolean	isTaskType(IThingID taskID) Checks if given thingID is a valid task ID
IURI	lookupPrincipal(Object id)
IURI	lookupPrincipal(Object id, int type)
IURI	lookupPrincipal(Object principal, String principalType)
IThingID	lookupUser(String userID)
boolean	needExecuteRule(ITask task, com.webmethods.caf.rules.IRule rule) Determines whether given rule should be executed fro given task
ITaskList	pageList(List<? extends ITask> list, IPagingCookie cookie, int endIndex, int startIndex) Splits the list according to the paging cookie
String	principalName(IURI uri) Returns displayName for a principal
void	setCurrentTaskURI(IURI taskURI) Sets task URI on the current thread
ITaskList	sortAndPageList(IThingID userID, ITaskList taskList, IPagingCookie cookie, int rights)
<T extends IURI> List<T>	sortPrincipalList(List<T> list)
List<IURI>	stringArrayToUriList(String[] array)
List<IURI>	stringToUriList(String str)
String	toString(Object data)
String[]	uriListToStringArray(List<? extends IURI> list)
<K,V> Map<K,V>	writableMap(Map<K,V> map) Ensures map container is not read-only

Method Detail

setCurrentTaskURI

void setCurrentTaskURI(IURI taskURI)

Sets task URI on the current thread

Parameters:

taskURI -

getCurrentTaskURI

IURI getCurrentTaskURI()

Returns task URI from the current thread

Returns:

getURI

IURI getURI(String id)

getURI

IURI getURI(int id)

getTaskFormFlowService

ITaskFormFlowService getTaskFormFlowService()

Returns singleton instance for Task Form Flow service

getTaskService

ITaskService getTaskService()

getTaskMonitoringService

ITaskMonitoringService getTaskMonitoringService()

getTaskDefinitionService

ITaskDefinitionService getTaskDefinitionService()

getTaskDistributionService

ITaskDistributionService getTaskDistributionService()

getTaskProcessAuditService

ITaskProcessAuditService getTaskProcessAuditService()

getTaskAuditService

ITaskAuditService getTaskAuditService()

getLockingService

IClusterLockingService getLockingService()

Returns instance of cluster locking service

getClassLoader

ClassLoader getClassLoader(IURI taskURI)
                    throws PortalException

Obtains task application classloader for the given taskUri

Throws:

PortalException

getClassLoaderIfExists

ClassLoader getClassLoaderIfExists(ITaskDefinition taskDef)
                            throws PortalException

Throws:

PortalException

getClassLoader

ClassLoader getClassLoader(ITaskDefinition taskDef)
                    throws PortalException

Throws:

PortalException

getClassLoader

ClassLoader getClassLoader(ITask task)
                    throws PortalException

Throws:

PortalException

getRulesList

List<IThingID> getRulesList(IThingID folderID,
                            boolean nested,
                            boolean includeNotFired)
                     throws PortalException

Returns sorted list of enabled rules from the given folder and subfolders

Parameters:

folderID -

includeNotFired - TODO

Throws:

PortalException

writableMap

<K,V> Map<K,V> writableMap(Map<K,V> map)

Ensures map container is not read-only

Parameters:

map -

Returns:

getTaskRuleSet

String getTaskRuleSet(ITask task)
               throws PortalException

Returns rule set value for given task

Throws:

PortalException

needExecuteRule

boolean needExecuteRule(ITask task,
                        com.webmethods.caf.rules.IRule rule)
                 throws PortalException

Determines whether given rule should be executed fro given task

Throws:

PortalException

getRuleBuilder

com.webmethods.caf.rules.IRuleBuilder getRuleBuilder()
                                              throws PortalException

Throws:

PortalException

getRuleMechanics

IPortalRulesMechanics getRuleMechanics()
                                throws PortalException

Throws:

PortalException

getThingID

IThingID getThingID(IURI uri)
             throws PortalException

Throws:

PortalException

getIntStatus

int getIntStatus(String status)

getStringStatus

String getStringStatus(int status)

getStatusDisplayName

String getStatusDisplayName(int status)

getIntPriority

int getIntPriority(String priority)

getPriorityDisplayName

String getPriorityDisplayName(int priority)

getStringPriority

String getStringPriority(int priority)

getIntOperation

int getIntOperation(String operation)

getStringOperation

String getStringOperation(int operation)

getOperationDisplayName

String getOperationDisplayName(int operation)

getStatusTitlesCSV

String getStatusTitlesCSV()

getStatusValuesCSV

String getStatusValuesCSV()

getPriorityTitlesCSV

String getPriorityTitlesCSV()

getPriorityValuesCSV

String getPriorityValuesCSV()

lookupPrincipal

IURI lookupPrincipal(Object id,
                     int type)
              throws PortalException

Throws:

PortalException

lookupPrincipal

IURI lookupPrincipal(Object id)
              throws PortalException

Throws:

PortalException

lookupUser

IThingID lookupUser(String userID)
             throws PortalException

Throws:

PortalException

sortAndPageList

ITaskList sortAndPageList(IThingID userID,
                          ITaskList taskList,
                          IPagingCookie cookie,
                          int rights)
                   throws PortalException

Throws:

PortalException

pageList

ITaskList pageList(List<? extends ITask> list,
                   IPagingCookie cookie,
                   int endIndex,
                   int startIndex)

Splits the list according to the paging cookie

getRunningDisplayName

String getRunningDisplayName(boolean isRunning)

stringArrayToUriList

List<IURI> stringArrayToUriList(String[] array)
                         throws PortalException

Throws:

PortalException

toString

String toString(Object data)

stringToUriList

List<IURI> stringToUriList(String str)
                    throws PortalException

Throws:

PortalException

uriListToStringArray

String[] uriListToStringArray(List<? extends IURI> list)
                       throws PortalException

Throws:

PortalException

getDisplayName

String getDisplayName(List<? extends IURI> uriList)
               throws PortalException

Throws:

PortalException

getDisplayName

String getDisplayName(IURI uri)
               throws PortalException

Throws:

PortalException

getDisplayName

String getDisplayName(ITaskChangedEvent event)

getTaskDefinitionByName

ITaskDefinition getTaskDefinitionByName(String taskDefName)
                                 throws PortalException

Throws:

PortalException

getTaskMechanics

ITaskMechanics getTaskMechanics()
                         throws PortalException

Throws:

PortalException

sortPrincipalList

<T extends IURI> List<T> sortPrincipalList(List<T> list)
                                    throws Exception

Parameters:

list - contains principal URI

Returns:

sorted list contains unique principal URI and sorted based on user principal name (UID)

Throws:

PortalException

Exception

principalName

String principalName(IURI uri)
              throws Exception

Returns displayName for a principal

Parameters:

uri -

Returns:

Throws:

Exception

isRuleEnabled

boolean isRuleEnabled(IURI ruleURI)
               throws PortalException

Determines if specified rule is enabled

Parameters:

ruleID -

Throws:

PortalException

getRule

com.webmethods.caf.rules.IRule getRule(IURI ruleURI)
                                throws PortalException

Throws:

PortalException

getRuleType

String getRuleType(IURI ruleURI)
            throws PortalException

Throws:

PortalException

convertDecisionTablesFromXml

Map<String,Map<Object,Object>> convertDecisionTablesFromXml(Object decisionTablesXml)
                                                     throws PortalException

Throws:

PortalException

convertDecisionTablesFromXml

Map<String,Map<Object,Object>> convertDecisionTablesFromXml(Object decisionTablesXml,
                                                            FacesContext facesContext)
                                                     throws PortalException

Throws:

PortalException

getPrincipalsFromDecisionTable

List<IURI> getPrincipalsFromDecisionTable(Map<String,Map<Object,Object>> paramMap)
                                   throws PortalException

Throws:

PortalException

lookupPrincipal

IURI lookupPrincipal(Object principal,
                     String principalType)
              throws PortalException

Throws:

PortalException

getPrincipalsList

IURI[] getPrincipalsList(Object principals)
                  throws PortalException

Returns list of principals uris from object

Throws:

PortalException

getPrincipalsList

IURI[] getPrincipalsList(Object principals,
                         Object principalTypes)
                  throws PortalException

Throws:

PortalException

isRuleType

boolean isRuleType(IThingID ruleID)

Checks if given thingID points to a Rule thing

Parameters:

ruleID -

Returns:

isTaskType

boolean isTaskType(IThingID taskID)

Checks if given thingID is a valid task ID

Parameters:

taskID -