contentManagerQueryOptionEnum

Provides the list of content manager query options.

References

Used by the following properties:

Members

maximumDataBytes

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.

To specify this option, use the bibus » contentManagerQueryOptionInt class.

Default: 0

maximumObjects

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.

To specify this option, use the bibus » contentManagerQueryOptionInt class.

Default: 0

permission

Specifies that a fault will be thrown if the caller does not have the specified permission on any object selected by the content » query(searchPath, properties, sortBy, options) » searchPath parameter.

To specify this option, use the bibus » contentManagerQueryOptionString class.

properties

Specifies the set of properties to be returned.

If you specify a reference property, properties of the referenced object can also be returned. By default, only the searchPath property is returned for each referenced object. If the reference property is ID-based, the storeID property is also returned.

If you specify the referenceProperties option, only the searchPath property is returned for the referenced object. You must then specify additional properties if you want to have them returned for the referenced object.

If the data property is specified and attachmentEncoding is specified as MIME or MIMECompressed, the data is returned in a MIME attachment. Otherwise, data is returned inline using base64 encoding.

To specify this option, use the bibus » contentManagerQueryOptionPropEnumArray class.

Default: { searchPath }

referenceProperties

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

To specify this option, use the bibus » contentManagerQueryOptionRefPropArray class.

schemaInfo

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

To specify this option, use the bibus » contentManagerQueryOptionBoolean class.

Default: false

skipDataBytes

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

For example, you can use this option to implement PDF byte-serving. Note that a negative value indicates the number of bytes from the end of the data.

To specify this option, use the bibus » contentManagerQueryOptionInt class.

Default: 0

skipObjects

Specifies the number of objects to be skipped in the result set. Use with maximumObjects 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 a negative value indicates the number of objects from the end of the result set.

To specify this option, use the bibus » contentManagerQueryOptionInt class.

Default: 0