# Namespace: brm

## tibco.objectapi.brm

### Classes

AddCurrentResourceToViewResponseType
AddCurrentResourceToViewType
AllocateAndOpenNextWorkItemResponseType
AllocateAndOpenNextWorkItemType
AllocateAndOpenWorkItemResponseType
AllocateAndOpenWorkItemType
AllocateWorkItemResponseType
AllocateWorkItemType
AllocationHistory
AsyncRescheduleWorkItemResponseType
AsyncResumeWorkItemResponseType
AsyncScheduleWorkItemResponseType
AsyncScheduleWorkItemWithModelResponseType
AsyncStartGroupResponseType
AsyncSuspendWorkItemResponseType
AsyncWorkItemDetails
BaseItemInfo
BaseModelInfo
CancelWorkItemResponseType
CancelWorkItemType
ChainedWorkItemNotificationType
CloseWorkItemResponseType
CloseWorkItemType
ColumnDefinition
ColumnOrder
CompleteWorkItemResponseType
CompleteWorkItemType
CreateWorkListViewResponseType
DeleteCurrentResourceFromViewResponseType
DeleteCurrentResourceFromViewType
DeleteOrgEntityConfigAttributesResponseType
DeleteOrgEntityConfigAttributesType
DeleteWorkListViewResponseType
DeleteWorkListViewType
DocumentRoot
EditWorkListViewResponseType
EditWorkListViewType
EnableWorkItemResponseType
EnableWorkItemType
EndGroupResponseType
EndGroupType
FacadeType
GetAllocatedWorkListItemsType
GetBatchGroupIdsResponseType
GetBatchWorkItemIdsResponseType
GetEditableWorkListViewsResponseType
GetEditableWorkListViewsType
GetOfferSetResponseType
GetOfferSetType
GetOrgEntityConfigAttributesAvailableResponseType
GetOrgEntityConfigAttributesAvailableType
GetOrgEntityConfigAttributesResponseType
GetOrgEntityConfigAttributesType
GetPublicWorkListViewsResponseType
GetPublicWorkListViewsType
GetResourceOrderFilterCriteriaResponseType
GetResourceOrderFilterCriteriaType
GetViewsForResourceResponseType
GetViewsForResourceType
GetWorkItemHeaderResponseType
GetWorkItemHeaderType
GetWorkItemOrderFilterResponseType
GetWorkItemOrderFilterType
GetWorkListItemsForGlobalDataResponseType
GetWorkListItemsForGlobalDataType
GetWorkListItemsForViewResponseType
GetWorkListItemsForViewType
GetWorkListItemsResponseType
GetWorkListItemsResponseType1
GetWorkListItemsType
GetWorkListViewDetailsType
GetWorkModelResponseType
GetWorkModelsResponseType
GetWorkModelsType
GetWorkModelType
GetWorkTypeResponseType
GetWorkTypesResponseType
GetWorkTypesType
GetWorkTypeType
HiddenPeriod
Item
ItemBody
ItemContext
ItemDuration
ItemPrivilege
ItemSchedule
ManagedObjectID
NextWorkItem
ObjectID
OnNotificationResponseType
OnNotificationType
OpenWorkItemResponseType
OpenWorkItemType
OrderFilterCriteria
OrgEntityConfigAttribute
OrgEntityConfigAttributesAvailable
OrgEntityConfigAttributeSet
ParameterType
PendWorkItem
PendWorkItemResponseType
PreviewWorkItemFromListResponseType
PreviewWorkItemFromListType
Privilege
PushNotificationType
ReallocateWorkItemData
ReallocateWorkItemDataResponseType
ReallocateWorkItemResponseType
ReallocateWorkItemType
RescheduleWorkItem
RescheduleWorkItemResponseType
ResumeWorkItemResponseType
ResumeWorkItemType
SaveOpenWorkItemResponseType
SaveOpenWorkItemType
ScheduleWorkItemResponseType
ScheduleWorkItemType
ScheduleWorkItemWithModelResponseType
ScheduleWorkItemWithModelType
SetOrgEntityConfigAttributesResponseType
SetOrgEntityConfigAttributesType
SetResourceOrderFilterCriteriaResponseType
SetResourceOrderFilterCriteriaType
SetWorkItemPriority
SetWorkItemPriorityResponseType
SkipWorkItemResponseType
SkipWorkItemType
StartGroupResponseType
StartGroupType
SuspendWorkItemResponseType
SuspendWorkItemType
UnallocateWorkItemResponseType
UnallocateWorkItemType
UnlockWorkListViewResponseType
UnlockWorkListViewType
WorkItem
WorkItemAttributes
WorkItemBody
WorkItemFlags
WorkItemHeader
WorkItemIDandPriorityType
WorkItemPreview
WorkItemPriorityType
WorkListFacade
WorkListView
WorkListViewCommon
WorkListViewEdit
WorkListViewPageItem
WorkModel
WorkModelEntities
WorkModelEntity
WorkModelList
WorkModelMapping
WorkModelScript
WorkModelScripts
WorkModelSpecification
WorkModelType
WorkModelTypes
WorkTypeList

### Namespaces

exception
workmodel

### Members

#### (static, readonly) ColumnCapability :string

Enumerated value defining the type of operations supported by a column for work list sorting and/or filtering (e.g. NONE, ORDER, FILTER).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`NONE` | string |
`ORDER` | string |
`FILTER` | string |
`BOTHORDERFILTER` | string |

#### (static, readonly) ColumnType :string

Enumerated value defining the type of a work list (e.g. COL_NUMERIC, COL_DATETIME).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`COLUNSPECIFIED` | string |
`COLNUMERIC` | string |
`COLSTRING` | string |
`COLDATETIME` | string |
`COLBOOLEAN` | string |
`COLSTATE` | string |
`COLDISTSTRATEGY` | string |

#### (static, readonly) DistributionStrategy :string

Enumerated value defining the the allowable types of distribution strategy (e.g. OFFER, ALLOCATE).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`OFFER` | string |
`ALLOCATE` | string |

#### (static, readonly) MethodAuthorisationAction :string

Defines the system actions required to perform an operation, those ending in PM are Process Manager levels rather than Work Manager.

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`SCHEDULE_WORK_ITEM` | string |
`CANCEL_WORK_ITEM` | string |
`SUSPEND_WORK_ITEM` | string |
`VIEW_WORK_LIST` | string |
`SET_RESOURCE_ORDER_FILTER_CRITERIA` | string |
`OPEN_OTHER_RESOURCES_ITEMS` | string |
`CLOSE_OTHER_RESOURCES_ITEMS` | string |
`SKIP_WORK_ITEM` | string |
`REALLOCATE_WORK_ITEM_TO_WORLD` | string |
`REALLOCATE_TO_OFFER_SET` | string |
`PEND_WORK_ITEM` | string |
`WORK_ITEM_ALLOCATION` | string |
`AUTO_OPEN_NEXT_WORK_ITEM` | string |
`RESCHEDULE_WORK_ITEM` | string |
`ENABLE_WORK_ITEM` | string |
`CHANGE_ALLOCATED_WORK_ITEM_PRIORITY` | string |
`CHANGE_ANY_WORK_ITEM_PRIORITY` | string |
`VIEW_GLOBAL_WORK_LIST` | string |
`AUTHENTICATED_USER` | string |

#### (static, readonly) MethodAuthorisationComponent :string

A representation of the literals of the enumeration 'Method Authorisation Component', and utility methods for working with them.

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`BRM` | string |
`PE` | string |

#### (static, readonly) ResourcesRequiredType :string

Enumerated value defining if specific resources are being requested. Currently the only supported option is ALL.

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`ALL` | string |
`MINE` | string |

#### (static, readonly) ScheduleStatus :string

Enumerated value defining whether a work item is within its schedule period (e.g. BEFORE, DURING, AFTER).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`NOSCHEDULE` | string |
`BEFORE` | string |
`DURING` | string |
`AFTER` | string |

#### (static, readonly) WorkGroupType :string

Enumerated value defining the the types of work group supported by BRM for implementing group patterns (e.g. CHAINING, SEPARATION_OF_CONCERNS).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`CHAINING` | string |
`SEPARATIONOFCONCERNS` | string |
`RETAINMOSTFAMILIAR` | string |
`RETAINFAMILIAR` | string |
`CASEHANDLING` | string |
`NOGROUP` | string |

#### (static, readonly) WorkItemScriptOperation :string

Enumerated value defining the operation on which a work item script is performed (e.g. OPEN, CLOSE, CANCEL).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`OPEN` | string |
`CLOSE` | string |
`COMPLETE` | string |
`PEND` | string |
`SCHEDULE` | string |
`RESCHEDULE` | string |
`SYSAPPEND` | string |

#### (static, readonly) WorkItemScriptType :string

Enumerated value defining the type of a work item script (e.g. JSCRIPT, JPYTHON).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`JSCRIPT` | string |
`JYTHON` | string |

#### (static, readonly) WorkItemState :string

Enumerated value defining the current lifecycle state of a work item (e.g. CREATED, OFFERED, ALLOCATED).

##### Type:

- string

##### Properties:

Name | Type | Description
--- | --- | ---
`CREATED` | string |
`OFFERED` | string |
`ALLOCATED` | string |
`OPENED` | string |
`PENDED` | string |
`PENDHIDDEN` | string |
`SUSPENDED` | string |
`COMPLETED` | string |
`CANCELLED` | string |