queryOptions

Defines the options associated with the content » query(searchPath, properties, sortBy, options) method.

References

Used by the following properties:
Used by the following method parameters:

Properties

This class has the following properties.

dataEncoding

Specifies the encoding used for binary properties in the result set.

This property

maxDataBytes

Specifies the maximum number of bytes of data for binary properties in the result set. Use with skipDataBytes to partition a large binary property value.

For example, you can use this option to implement PDF byte serving. Note that for values of zero or less, all the data is returned.

This property

  • is of type integer

    is encoded as type xs:integer

maxObjects

Specifies the maximum number of objects in the result set. Use with skipObjects to partition a large result set.

For example, you can use this option to select the set of rendered items when scrolling in your Web portal. Note that for values of zero or less, all selected objects are returned.

This property

  • is of type integer

    is encoded as type xs:integer

permission

Specifies that a fault will be thrown if the caller does not have the specified permission on any object selected by the search parameter of the request.

This property

  • is of type string

    is encoded as type xs:string

refProps

Specifies the names of properties to be retrieved for objects referenced by retrieved properties. For example, use to specify that the names and descriptions of the members of a group be returned.

This property

  • is an array of type bibus » refProp

    is encoded as type tns:refPropArray

schemaInfo

Specifies whether additional property information is returned with the property values.

This property

  • is of type boolean

    is encoded as type xs:boolean

skipDataBytes

Specifies the number of data bytes to be skipped for binary properties in the result set. Use with maxDataBytes to partition a large binary property value.

For example, you can use this option to implement PDF byte serving. Use negative values to indicate the number of bytes to skip from the end of the data.

This property

  • is of type integer

    is encoded as type xs:integer

skipObjects

Specifies the number of objects to be skipped in the result set. Use with maxObjects to partition a large result set.

For example, you can use this option to select the set of rendered items when scrolling in your Web portal. Use negative values to indicate the number of objects to skip from the end of the result set.

This property

  • is of type integer

    is encoded as type xs:integer