System.Object
ObjectRequestType
Client Declaration
public class ObjectRequestType
Represents information required to identify a Content Engine object or collection of objects. An array
of ObjectRequestType
elements is used to construct the input
for a GetObjects
operation.
The value of SourceSpecification
determines the type of
each object specified in the corresponding ObjectResponseType
array response returned by the GetObjects
operation:
ObjectValue
element. ObjectSetType
element. ErrorStackType
element.
Elements
PropertyFilterType
PropertyFilter
: [request] Optional element specifying the object properties to be returned.ObjectReference
SourceSpecification
: [request] Required element identifying the object that is the source of the object request. The value of SourceSpecification
determines the type of
each corresponding object returned in the ObjectResponseType
array response of the GetObjects
operation:
ObjectValue
element is returned. ObjectSetType
element is returned. ErrorStackType
element is returned.Attributes
cacheAllowed
: [request] Optional expression specifying whether
the server is permitted to satisfy the request from cached data or must retrieve
fresh data from the underlying storage.String
continueFrom
: [request] Optional expression specifying the
value of the CollectionTerminator
element from a previously
returned page. This value indicates the start point of the current page. If omitted, the start of the collection
is implied. String
id
: [request] Optional identifying string reflected in the corresponding
ObjectResponseType
element of the GetObjects
response, acting as a correlation
between request and response elements. Int32
maxElements
: [request] Optional expression specifying the page
size for the currently requested page. A value of -1 returns the entire collection. Note that if the number of objects returned in a GetObjects
object set collection is equal to the value of maxElements
, the value of CollectionTerminator
returned in the ObjectSetType
element is EndOfPage
(instead of EndOfCollection
).Attributes Specific to .NET Clients
Boolean
cacheAllowedSpecified
: Optional expression specifying whether cacheAllowed
has a value (true
) or not (false
).Boolean
maxElementsSpecified
: Optional expression specifying whether maxElementsSpecified
has a value (true
) or not (false
).
<xsd:complexType name="ObjectRequestType"> <xsd:sequence> <xsd:element name="SourceSpecification" type="ObjectReference"/> <xsd:element name="PropertyFilter" type="PropertyFilterType" minOccurs="0"/> </xsd:sequence> <xsd:attribute name="id" type="xsd:ID"/> <xsd:attribute name="cacheAllowed" type="xsd:boolean"/> <xsd:attribute name="maxElements" type="xsd:int"/> <xsd:attribute name="continueFrom" type="xsd:string"/> </xsd:complexType>