ITaskDefinition (server-common-api)

All Superinterfaces:

IView, Serializable
```
public interface ITaskDefinition
extends IView
```
Class ITaskDefinition

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUDIT_ALL`
`static int`	`AUDIT_CREATE`
`static int`	`AUDIT_ERROR`
`static int`	`AUDIT_NONE`
`static int`	`AUDIT_REVERT`
`static int`	`AUDIT_TASK_DATA`
`static int`	`AUDIT_TASK_RULES`
`static int`	`AUDIT_UPDATE`

Fields inherited from interface com.webmethods.portal.service.view.IView
PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.softwareag.caf.shared.task.core.model.AgileAppsInfo`	`getAgileAppsInfo()` Returns AgileApps related information if there is one Will return null if this task definition has no such information defined
`String`	`getAttachmentsStorageType()` Returns configured storage type for attachments.
`int`	`getAuditOptions()` Returns task auditing options
`String`	`getCollaborationLayout()` Default layout direction for this task collaboration process
`IURI[]`	`getCollaborationTasks()` Returns list of uris of collaboration task types which could be used for this type
`String`	`getCommentsStorageType()` Returns configured storage type for comments
`IURI`	`getDelegationRulesFolderURI()` Returns uri for the folder where escalation rules for this task definition are stored
`String`	`getDescription()` Returns description for task definition
`DisplayIndexTable`	`getDisplayIndexTable()` Returns Task Index Table display information if there is task index table Will return null if no Task Index Table was created for this task definition
`IURI`	`getDistributionFiltersFolderURI()` Returns uri of the folder where distribution rules for this task definition are stored
`IURI`	`getDistributionRulesFolderURI()` Returns uri of the folder where distribution rules for this task definition are stored
`long`	`getEdaDataMask()` Returns the EDA task data emit configuration mask
`long`	`getEdaEmitMask()` Returns the EDA emit configuration mask
`HpstraIndexTable`	`getHpstraIndexTable()` Returns HPSTRA Index Table information if there is task index table Will return null if no HPSTRA Index Table was created for this task definition
`List<String>`	`getIndexProperties()` Returns list of defined properties
`String`	`getIndexTypeDefinition()` Returns xtype name which defines indexing schema for this task type
`String`	`getName()` Returns name of the task definition.
`String`	`getParentTaskTypeID()` Returns defined parent task type ID.
`IURI[]`	`getQueueTaskPortletURIs()` Returns uri for queue new task portlet
`IURI`	`getScheduleRulesFolderURI()` Returns uri for the folder where escalation rules for this task definition are stored
`IURI`	`getSecurityRealmURI()` Returns uri of the security realm which is shared by all tasks of this type
`IURI`	`getSubscriptionSourcesFolderURI()` Returns uri of the folder where task type subscription sources are stored
`String`	`getTaskApplicationName()` Returns the name of the task portlet application
`String`	`getTaskClientName()` Returns name of JSF bean for task content provider
`String`	`getTaskDataImplClass()` Returns registered name of implementation class for task data
`com.softwareag.caf.shared.task.core.model.TaskDataDefTable`	`getTaskDataTable()` Returns Task Data Definition Table information if there is task data information Will return null if this task definition has no task business data defined
`String`	`getTaskDescription()` Returns configured Task Description for attachments.
`String`	`getTaskDetailGadgetURIs()` Returns uri for task Detail Gadget
`String`	`getTaskStepIcon()` Returns icon to use for this task of this type
`String`	`getTaskTypeID()` Returns task Type ID
`String`	`getTaskVotingTable()` Returns the task's voting table containing the voting strategy and its configuration
`IURI`	`getTriggerRulesFolderURI()` Returns uri of the folder where trigger rules for this task definition are stored
`IURI[]`	`getViewTaskPortletURIs()` Returns URIs of the view task portlets
`boolean`	`isAnalyticsEnabled()` Returns is analytics is enabled for this task type
`boolean`	`isCollaborationEnabled()` If collaboration is enabled for this task type
`boolean`	`isCommentingEnabled()` If commenting is enabled for this task type
`boolean`	`isDataSharingEnabled()` Indicates if data sharing enabled for this task type
`boolean`	`isEnabled()` Gets status of this task definition
`boolean`	`isHpstraEnabled()` If HPSTRA is enabled for this task type
`boolean`	`isOrchestrationEnabled()` Wherther collaboration process orchestration is enabled for this task
`boolean`	`isSystemTaskType()` If this is a system task type
`boolean`	`isVotable()` Returns if the task is votable or not

Methods inherited from interface com.webmethods.portal.service.view.IView
getProperties, getProperty, getPropertyNames, getURI

- Field Detail
  - AUDIT_NONE
```
static final int AUDIT_NONE
```
    See Also:
    
    Constant Field Values
  - AUDIT_CREATE
```
static final int AUDIT_CREATE
```
    See Also:
    
    Constant Field Values
  - AUDIT_UPDATE
```
static final int AUDIT_UPDATE
```
    See Also:
    
    Constant Field Values
  - AUDIT_TASK_DATA
```
static final int AUDIT_TASK_DATA
```
    See Also:
    
    Constant Field Values
  - AUDIT_TASK_RULES
```
static final int AUDIT_TASK_RULES
```
    See Also:
    
    Constant Field Values
  - AUDIT_ERROR
```
static final int AUDIT_ERROR
```
    See Also:
    
    Constant Field Values
  - AUDIT_REVERT
```
static final int AUDIT_REVERT
```
    See Also:
    
    Constant Field Values
  - AUDIT_ALL
```
static final int AUDIT_ALL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getTaskTypeID
```
String getTaskTypeID()
              throws PortalException
```
    Returns task Type ID
    
    Throws:
    
    PortalException
  - getName
```
String getName()
        throws PortalException
```
    Returns name of the task definition. Must be unique amond all task definitions
    
    Throws:
    
    PortalException
  - getDescription
```
String getDescription()
               throws PortalException
```
    Returns description for task definition
    
    Throws:
    
    PortalException
  - getViewTaskPortletURIs
```
IURI[] getViewTaskPortletURIs()
                       throws PortalException
```
    Returns URIs of the view task portlets
    
    Throws:
    
    PortalException
  - getQueueTaskPortletURIs
```
IURI[] getQueueTaskPortletURIs()
                        throws PortalException
```
    Returns uri for queue new task portlet
    
    Throws:
    
    PortalException
  - getTaskDetailGadgetURIs
```
String getTaskDetailGadgetURIs()
                        throws PortalException
```
    Returns uri for task Detail Gadget
    
    Throws:
    
    PortalException
  - getTaskApplicationName
```
String getTaskApplicationName()
                       throws PortalException
```
    Returns the name of the task portlet application
    
    Throws:
    
    PortalException
  - isEnabled
```
boolean isEnabled()
           throws PortalException
```
    Gets status of this task definition
    
    Throws:
    
    PortalException
  - getDistributionRulesFolderURI
```
IURI getDistributionRulesFolderURI()
                            throws PortalException
```
    Returns uri of the folder where distribution rules for this task definition are stored
    
    Throws:
    
    PortalException
  - getDistributionFiltersFolderURI
```
IURI getDistributionFiltersFolderURI()
                              throws PortalException
```
    Returns uri of the folder where distribution rules for this task definition are stored
    
    Throws:
    
    PortalException
  - getTriggerRulesFolderURI
```
IURI getTriggerRulesFolderURI()
                       throws PortalException
```
    Returns uri of the folder where trigger rules for this task definition are stored
    
    Throws:
    
    PortalException
  - getScheduleRulesFolderURI
```
IURI getScheduleRulesFolderURI()
                        throws PortalException
```
    Returns uri for the folder where escalation rules for this task definition are stored
    
    Throws:
    
    PortalException
  - getDelegationRulesFolderURI
```
IURI getDelegationRulesFolderURI()
                          throws PortalException
```
    Returns uri for the folder where escalation rules for this task definition are stored
    
    Throws:
    
    PortalException
  - getSecurityRealmURI
```
IURI getSecurityRealmURI()
                  throws PortalException
```
    Returns uri of the security realm which is shared by all tasks of this type
    
    Throws:
    
    PortalException
  - getSubscriptionSourcesFolderURI
```
IURI getSubscriptionSourcesFolderURI()
                              throws PortalException
```
    Returns uri of the folder where task type subscription sources are stored
    
    Throws:
    
    PortalException
  - getAuditOptions
```
int getAuditOptions()
             throws PortalException
```
    Returns task auditing options
    
    Throws:
    
    PortalException
  - getTaskDataImplClass
```
String getTaskDataImplClass()
                     throws PortalException
```
    Returns registered name of implementation class for task data
    
    Throws:
    
    PortalException
  - getTaskClientName
```
String getTaskClientName()
                  throws PortalException
```
    Returns name of JSF bean for task content provider
    
    Throws:
    
    PortalException
  - isAnalyticsEnabled
```
boolean isAnalyticsEnabled()
                    throws PortalException
```
    Returns is analytics is enabled for this task type
    
    Throws:
    
    PortalException
  - getTaskStepIcon
```
String getTaskStepIcon()
                throws PortalException
```
    Returns icon to use for this task of this type
    
    Throws:
    
    PortalException
  - isDataSharingEnabled
```
boolean isDataSharingEnabled()
                      throws PortalException
```
    Indicates if data sharing enabled for this task type
    
    Returns:
    
    Throws:
    
    PortalException
  - getCollaborationTasks
```
IURI[] getCollaborationTasks()
                      throws PortalException
```
    Returns list of uris of collaboration task types which could be used for this type
    
    Throws:
    
    PortalException
  - isCommentingEnabled
```
boolean isCommentingEnabled()
                     throws PortalException
```
    If commenting is enabled for this task type
    
    Throws:
    
    PortalException
  - isCollaborationEnabled
```
boolean isCollaborationEnabled()
                        throws PortalException
```
    If collaboration is enabled for this task type
    
    Throws:
    
    PortalException
  - isOrchestrationEnabled
```
boolean isOrchestrationEnabled()
                        throws PortalException
```
    Wherther collaboration process orchestration is enabled for this task
    
    Throws:
    
    PortalException
  - isSystemTaskType
```
boolean isSystemTaskType()
                  throws PortalException
```
    If this is a system task type
    
    Throws:
    
    PortalException
  - getCollaborationLayout
```
String getCollaborationLayout()
                       throws PortalException
```
    Default layout direction for this task collaboration process
    
    Returns:
    
    Throws:
    
    PortalException
  - getTaskDescription
```
String getTaskDescription()
                   throws PortalException
```
    Returns configured Task Description for attachments.
    
    Throws:
    
    PortalException
  - getAttachmentsStorageType
```
String getAttachmentsStorageType()
                          throws PortalException
```
    Returns configured storage type for attachments.
    
    Throws:
    
    PortalException
  - getCommentsStorageType
```
String getCommentsStorageType()
                       throws PortalException
```
    Returns configured storage type for comments
    
    Throws:
    
    PortalException
  - getParentTaskTypeID
```
String getParentTaskTypeID()
                    throws PortalException
```
    Returns defined parent task type ID. May be null
    
    Throws:
    
    PortalException
  - getIndexTypeDefinition
```
String getIndexTypeDefinition()
                       throws PortalException
```
    Returns xtype name which defines indexing schema for this task type
    
    Throws:
    
    PortalException
  - getIndexProperties
```
List<String> getIndexProperties()
                         throws PortalException
```
    Returns list of defined properties
    
    Throws:
    
    PortalException
  - getDisplayIndexTable
```
DisplayIndexTable getDisplayIndexTable()
                                throws PortalException
```
    Returns Task Index Table display information if there is task index table Will return null if no Task Index Table was created for this task definition
    
    Returns:
    
    Throws:
    
    PortalException
  - getHpstraIndexTable
```
HpstraIndexTable getHpstraIndexTable()
                              throws PortalException
```
    Returns HPSTRA Index Table information if there is task index table Will return null if no HPSTRA Index Table was created for this task definition
    
    Returns:
    
    Throws:
    
    PortalException
  - isHpstraEnabled
```
boolean isHpstraEnabled()
                 throws PortalException
```
    If HPSTRA is enabled for this task type
    
    Throws:
    
    PortalException
  - getEdaEmitMask
```
long getEdaEmitMask()
             throws PortalException
```
    Returns the EDA emit configuration mask
    
    Throws:
    
    PortalException
  - getEdaDataMask
```
long getEdaDataMask()
             throws PortalException
```
    Returns the EDA task data emit configuration mask
    
    Throws:
    
    PortalException
  - getTaskDataTable
```
com.softwareag.caf.shared.task.core.model.TaskDataDefTable getTaskDataTable()
                                                                     throws PortalException
```
    Returns Task Data Definition Table information if there is task data information Will return null if this task definition has no task business data defined
    
    Returns:
    
    Throws:
    
    PortalException
  - getAgileAppsInfo
```
com.softwareag.caf.shared.task.core.model.AgileAppsInfo getAgileAppsInfo()
                                                                  throws PortalException
```
    Returns AgileApps related information if there is one Will return null if this task definition has no such information defined
    
    Returns:
    
    Throws:
    
    PortalException
  - isVotable
```
boolean isVotable()
           throws PortalException
```
    Returns if the task is votable or not
    
    Returns:
    
    Throws:
    
    PortalException
  - getTaskVotingTable
```
String getTaskVotingTable()
                   throws PortalException
```
    Returns the task's voting table containing the voting strategy and its configuration
    
    Returns:
    
    Throws:
    
    PortalException

Interface ITaskDefinition

Field Summary

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

Method Summary

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

Field Detail

AUDIT_NONE

AUDIT_CREATE

AUDIT_UPDATE

AUDIT_TASK_DATA

AUDIT_TASK_RULES

AUDIT_ERROR

AUDIT_REVERT

AUDIT_ALL

Method Detail

getTaskTypeID

getName

getDescription

getViewTaskPortletURIs

getQueueTaskPortletURIs

getTaskDetailGadgetURIs

getTaskApplicationName

isEnabled

getDistributionRulesFolderURI

getDistributionFiltersFolderURI

getTriggerRulesFolderURI

getScheduleRulesFolderURI

getDelegationRulesFolderURI

getSecurityRealmURI

getSubscriptionSourcesFolderURI

getAuditOptions

getTaskDataImplClass

getTaskClientName

isAnalyticsEnabled

getTaskStepIcon

isDataSharingEnabled

getCollaborationTasks

isCommentingEnabled

isCollaborationEnabled

isOrchestrationEnabled

isSystemTaskType

getCollaborationLayout

getTaskDescription

getAttachmentsStorageType

getCommentsStorageType

getParentTaskTypeID

getIndexTypeDefinition

getIndexProperties

getDisplayIndexTable

getHpstraIndexTable

isHpstraEnabled

getEdaEmitMask

getEdaDataMask

getTaskDataTable

getAgileAppsInfo

isVotable

getTaskVotingTable