Class: ListingRequest

tibco.objectapi.pfe.common.ListingRequest

new ListingRequest()

Generic request description. Constructs a new ListingRequest.

The following features are supported:

Extends

Members

getTotalCount :boolean

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.) This property holds the value of the 'Get Total Count' attribute.
Type:
  • boolean
Overrides:

includeFormalParameters :boolean

Boolean value defining whether the response should include items that have formal parameters. If not specified the default value is FALSE. This property holds the value of the 'Include Formal Parameters' attribute.
Type:
  • boolean

includeFormalParameters :boolean

Boolean value defining whether the response should include items that have formal parameters. If not specified the default value is FALSE. This property holds the value of the 'Include Formal Parameters' attribute.
Type:
  • boolean

numberOfItems :string

Number of items (in the list) to include in this page. This property holds the value of the 'Number Of Items' attribute.
Type:
  • string
Overrides:

orderFilterCriteria :tibco.objectapi.pfe.common.OrderFilterCriteria

**PRIVATE API - Reserved for internal use** Specification of sort/filter criteria to be applied to the list. This property holds the value of the 'Order Filter Criteria' containment reference.
Type:
Overrides:

startPosition :string

Position in the list from which to start this page. This property holds the value of the 'Start Position' attribute.
Type:
  • string
Overrides:

tibco.objectapi.pfe.common.ListingRequest

new ListingRequest()

Generic request description. Constructs a new ListingRequest.

The following features are supported:

Extends

Members

getTotalCount :boolean

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.) This property holds the value of the 'Get Total Count' attribute.
Type:
  • boolean
Overrides:

includeFormalParameters :boolean

Boolean value defining whether the response should include items that have formal parameters. If not specified the default value is FALSE. This property holds the value of the 'Include Formal Parameters' attribute.
Type:
  • boolean

includeFormalParameters :boolean

Boolean value defining whether the response should include items that have formal parameters. If not specified the default value is FALSE. This property holds the value of the 'Include Formal Parameters' attribute.
Type:
  • boolean

numberOfItems :string

Number of items (in the list) to include in this page. This property holds the value of the 'Number Of Items' attribute.
Type:
  • string
Overrides:

orderFilterCriteria :tibco.objectapi.pfe.common.OrderFilterCriteria

**PRIVATE API - Reserved for internal use** Specification of sort/filter criteria to be applied to the list. This property holds the value of the 'Order Filter Criteria' containment reference.
Type:
Overrides:

startPosition :string

Position in the list from which to start this page. This property holds the value of the 'Start Position' attribute.
Type:
  • string
Overrides: