Class: GetWorkListItemsForViewResponseType

tibco.objectapi.brm.GetWorkListItemsForViewResponseType

new GetWorkListItemsForViewResponseType()

Contains a page of work item returned from a user request. Constructs a new GetWorkListItemsForViewResponseType.

The following features are supported:

Members

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

endPosition :string

Position in the work item list of the last work item on this page. This property holds the value of the 'End Position' attribute.
Type:
  • string

startPosition :string

Position in the work item list of the first work item on this page. This property holds the value of the 'Start Position' attribute.
Type:
  • string

totalItems :string

The value returned in this attribute depends on the value specified for the getTotalCount attribute in the request. If: - getTotalCount was 'true', totalItems returns the total number of work items in the work item list. - getTotalCount was 'false', totalItems returns -1 if the work item list contains at least one work item, or 0 (zero) if the work item list is empty. This property holds the value of the 'Total Items' attribute.
Type:
  • string

workItems :Array.<tibco.objectapi.brm.WorkItem>

Complete details of each work item in this page of the work item list. This property holds the value of the 'Work Items' containment reference list.
Type:

workListFacade :tibco.objectapi.brm.WorkListFacade

If the request is made with getEnhancedAttributes set, and any are defined then this will list any display names that are specified for any Work Item Attributes. This property holds the value of the 'Work List Facade' containment reference.
Type: