Class: WorkListView

tibco.objectapi.brm.WorkListView

new WorkListView()

Definition of a full work list view object. Constructs a new WorkListView.

The following features are supported:

Extends

Members

authors :Array.<tibco.objectapi.common.organisation.XmlModelEntityId>

Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view. This property holds the value of the 'Authors' containment reference list.
Type:
Inherited From:

creationDate :Date

The date the work view was created. This property holds the value of the 'Creation Date' attribute.
Type:
  • Date

customData :string

A string attribute the caller can use to provide and custom data they wish to store with the work list view. BRM will not look at or use this attribute value but will just store it with the work view definition. If storing XML data the value should be wrapped in a CDATA section. This property holds the value of the 'Custom Data' attribute.
Type:
  • string
Inherited From:

description :string

Optional description that can be given to the work list view. This property holds the value of the 'Description' attribute.
Type:
  • string
Inherited From:

entityID :tibco.objectapi.common.organisation.XmlModelEntityId

ID of the organization model entity that this view is to be for. This property holds the value of the 'Entity ID' containment reference.
Type:
Inherited From:

getAllocatedItems :boolean

Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items. This property holds the value of the 'Get Allocated Items' attribute.
Type:
  • boolean
Inherited From:

locker :string

The GUID of the resource that currently had this work list view locked for editing. This property holds the value of the 'Locker' attribute.
Type:
  • string

modificationDate :Date

The date the work view was last modified. This property holds the value of the 'Modification Date' attribute.
Type:
  • Date

name :string

The user defined name of the view. This property holds the value of the 'Name' attribute.
Type:
  • string
Inherited From:

orderFilterCriteria :tibco.objectapi.brm.OrderFilterCriteria

Specification of sort/filter criteria to be applied to the work item list. This property holds the value of the 'Order Filter Criteria' containment reference.
Type:
Inherited From:

owner :string

The resourceID of the owner of this view. If omitted the ID of the resource calling the createWorkListView API will be used. This resource can always edit or use this view. This property holds the value of the 'Owner' attribute.
Type:
  • string
Inherited From:

public :boolean

Is this view publlic, i.e. can it be used by any AMX-BPM user. If TRUE then it will be visible to ALL users, not just those in the "users" set. This property holds the value of the 'Public' attribute.
Type:
  • boolean
Inherited From:

resourcesRequired :tibco.objectapi.brm.ResourcesRequiredType

Specifying what if any resource processing is required on the Work List. If sspecified and the user has the correct priviliege, this will ignore any entity specified in the Work View itself. This property holds the value of the 'Resources Required' attribute.
Type:
Inherited From:

users :Array.<tibco.objectapi.common.organisation.XmlModelEntityId>

Array of XmlModelEntityId objects for resources who are allowed to use the view. This property holds the value of the 'Users' containment reference list.
Type:
Inherited From:

workViewID :string

The uniique ID of the work view. This property holds the value of the 'Work View ID' attribute.
Type:
  • string