complexType PagingAndSorting

diagram |
namespace | http://common.api.pfe.n2.tibco.com
children | orderFilterCriteria
used by |
complexType | ListingRequest
attributes |
Name | Type | Use | Default | Fixed | Annotation
startPosition | xs:long |  |  |  |
documentation
Position in the list from which to start this page.
numberOfItems | xs:long |  |  |  |
documentation
Number of items (in the list) to include in this page.
getTotalCount | xs:boolean | optional | true |  |
documentation
Boolean value defining whether the Page Flow Engine builds a count of the total number of items in the list. (If 'false' the total is set to -1.)
annotation |
documentation
Paging and sorting parameters to enable clients to manipulate the size of a response into manageable chunks of data.
source | <xs:complexType name="PagingAndSorting"> <xs:annotation> <xs:documentation>Paging and sorting parameters to enable clients to manipulate the size of a response into manageable chunks of data.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xs:annotation> <xs:documentation>**PRIVATE API - Reserved for internal use** Specification of sort/filter criteria to be applied to the list.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="startPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the list from which to start this page.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="numberOfItems" type="xs:long"> <xs:annotation> <xs:documentation>Number of items (in the list) to include in this page.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true"> <xs:annotation> <xs:documentation>Boolean value defining whether the Page Flow Engine builds a count of the total number of items in the list. (If 'false' the total is set to -1.) </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute PagingAndSorting/@startPosition

type | xs:long
annotation |
documentation
Position in the list from which to start this page.
source | <xs:attribute name="startPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the list from which to start this page.</xs:documentation> </xs:annotation> </xs:attribute>

attribute PagingAndSorting/@numberOfItems

type | xs:long
annotation |
documentation
Number of items (in the list) to include in this page.
source | <xs:attribute name="numberOfItems" type="xs:long"> <xs:annotation> <xs:documentation>Number of items (in the list) to include in this page.</xs:documentation> </xs:annotation> </xs:attribute>

attribute PagingAndSorting/@getTotalCount

type | xs:boolean
properties |
use | optional
default | true
annotation |
documentation
Boolean value defining whether the Page Flow Engine builds a count of the total number of items in the list. (If 'false' the total is set to -1.)
source | <xs:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true"> <xs:annotation> <xs:documentation>Boolean value defining whether the Page Flow Engine builds a count of the total number of items in the list. (If 'false' the total is set to -1.) </xs:documentation> </xs:annotation> </xs:attribute>

element PagingAndSorting/orderFilterCriteria

diagram |
type | OrderFilterCriteria
properties |
minOcc | 0
maxOcc | 1
content | complex
children | order filter
annotation |
documentation
**PRIVATE API - Reserved for internal use** Specification of sort/filter criteria to be applied to the list.
source | <xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xs:annotation> <xs:documentation>**PRIVATE API - Reserved for internal use** Specification of sort/filter criteria to be applied to the list.</xs:documentation> </xs:annotation> </xs:element>

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