complexType WorkListViewCommon

diagram |
namespace | http://api.brm.n2.tibco.com
children | entityID resourcesRequired orderFilterCriteria
used by |
complexTypes | WorkListViewEdit WorkListViewPageItem
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | derived by: xs:string | required |  |  |
documentation
The user defined name of the view.
description | derived by: xs:string |  |  |  |
documentation
Optional description that can be given to the work list view.
owner | derived by: xs:string |  |  |  |
documentation
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.
public | xs:boolean |  |  |  |
documentation
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.
getAllocatedItems | xs:boolean |  |  |  |
documentation
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.
annotation |
documentation
Definition of common base object used for reading and writing work list views.
source | <xs:complexType name="WorkListViewCommon"> <xs:annotation> <xs:documentation>Definition of common base object used for reading and writing work list views.</xs:documentation> </xs:annotation> <xs:sequence minOccurs="0"> <xs:choice> <xs:element name="entityID" type="orgdto:XmlModelEntityId" minOccurs="0"> <xs:annotation> <xs:documentation>ID of the organization model entity that this view is to be for.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="resourcesRequired" type="ResourcesRequiredType" minOccurs="0"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xs:annotation> <xs:documentation>Specification of sort/filter criteria to be applied to the work item list.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="name" use="required"> <xs:annotation> <xs:documentation>The user defined name of the view.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="64"/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="description"> <xs:annotation> <xs:documentation>Optional description that can be given to the work list view.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="255"/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="owner"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="36"/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="public" type="xs:boolean"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="getAllocatedItems" type="xs:boolean"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute WorkListViewCommon/@name

type | restriction of xs:string
properties |
use | required
facets |
Kind | Value | Annotation
maxLength | 64 |
annotation |
documentation
The user defined name of the view.
source | <xs:attribute name="name" use="required"> <xs:annotation> <xs:documentation>The user defined name of the view.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="64"/> </xs:restriction> </xs:simpleType> </xs:attribute>

attribute WorkListViewCommon/@description

type | restriction of xs:string
facets |
Kind | Value | Annotation
maxLength | 255 |
annotation |
documentation
Optional description that can be given to the work list view.
source | <xs:attribute name="description"> <xs:annotation> <xs:documentation>Optional description that can be given to the work list view.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="255"/> </xs:restriction> </xs:simpleType> </xs:attribute>

attribute WorkListViewCommon/@owner

type | restriction of xs:string
facets |
Kind | Value | Annotation
maxLength | 36 |
annotation |
documentation
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.
source | <xs:attribute name="owner"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:maxLength value="36"/> </xs:restriction> </xs:simpleType> </xs:attribute>

attribute WorkListViewCommon/@public

type | xs:boolean
annotation |
documentation
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.
source | <xs:attribute name="public" type="xs:boolean"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:attribute>

attribute WorkListViewCommon/@getAllocatedItems

type | xs:boolean
annotation |
documentation
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.
source | <xs:attribute name="getAllocatedItems" type="xs:boolean"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:attribute>

element WorkListViewCommon/entityID

diagram |
type | XmlModelEntityId
properties |
minOcc | 0
maxOcc | 1
content | complex
children | dynamic-id-attr qualifierSet
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type | OrganisationalEntityType | required |  |  |
documentation
Enumerated value defining the type of the organization model entity.
guid | xs:string | required |  |  |
documentation
Globally unique ID of the organization model entity. (Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier | xs:string | optional |  |  |
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges. These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation |
documentation
ID of the organization model entity that this view is to be for.
source | <xs:element name="entityID" type="orgdto:XmlModelEntityId" minOccurs="0"> <xs:annotation> <xs:documentation>ID of the organization model entity that this view is to be for.</xs:documentation> </xs:annotation> </xs:element>

element WorkListViewCommon/resourcesRequired

diagram |
type | ResourcesRequiredType
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | ALL |
enumeration | MINE |
annotation |
documentation
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.
source | <xs:element name="resourcesRequired" type="ResourcesRequiredType" minOccurs="0"> <xs:annotation> <xs:documentation>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.</xs:documentation> </xs:annotation> </xs:element>

element WorkListViewCommon/orderFilterCriteria

diagram |
type | OrderFilterCriteria
properties |
minOcc | 0
maxOcc | 1
content | complex
children | order filter
annotation |
documentation
Specification of sort/filter criteria to be applied to the work item list.
source | <xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xs:annotation> <xs:documentation>Specification of sort/filter criteria to be applied to the work item list.</xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy