System.Object
FilterElementType
Client Declaration
public class FilterElementType
Represents information, used in conjunction with a PropertyFilterType
element, for controlling which properties of a Content Engine object (and with what level of detail) will appear in the output of an operation.
Attributes
Boolean
levelDependents
: [request] Optional expression specifying whether the recursion level to use when retrieving a dependent object is the same as that of the independent object to which it belongs (true
) or one level deeper (false
). Int32
maxElements
: [request] Optional expression specifying the
maximum number of elements (page size) returned for any filtered object collection that is returned. A value of -1 returns the entire collection.Int32
maxRecursion
: [request] Optional expression specifying the maximum recursion level (zero-based) at which the property is included. The default is zero. To prevent infinite recursion in the case of an unrefined filter, the server has a mechanism to suppress recursion if more than two identical objects are returned. If the duplicate object is reached as the value of a singleton property, that property value is returned as an object reference (instead as an object value); if the duplicate object is reached through a collection, it appears as empty (no properties are present). UInt64
maxSize
: [request] Optional expression specifying the maximum
size allowed for content data. This attribute is valid only for the Content
pseudo-property. String
Value
: [request] Required expression specifying the properties to be included in the output, either by indentifier or type.
PropertyBoolean
properties. PropertyBinary
properties. PropertyDateTime
properties. PropertyFloat64
properties. PropertyId
properties. PropertyInteger32
properties. PropertyEngineObject
properties. PropertyString
properties. PropertyContent
properties. PropertyBooleanList
properties. PropertyBinaryList
properties. PropertyDateTimeList
properties. PropertyFloat64List
properties. PropertyIdList
properties. PropertyInteger32List
properties. PropertyDependentObjectList
properties. PropertyStringList
properties. PropertyIndependentObjectSet
properties. Attributes Specific to .NET Clients
Boolean
levelDependentsSpecified
: Optional expression specifying whether levelDependents
has a value (true
) or not (false
).Boolean
maxElementsSpecified
: Optional expression specifying whether maxElements
has a value (true
) or not (false
). Boolean
maxRecursionSpecified
: Optional expression specifying whether maxRecursion
has a value (true
) or not (false
). Boolean
maxSizeSpecified
: Optional expression specifying whether maxSize
has a value (true
) or not (false
).
<xsd:complexType name="FilterElementType"> <xsd:simpleContent> <xsd:extension base="xsd:string"> <xsd:attribute name="maxRecursion" type="xsd:int"/> <xsd:attribute name="maxSize" type="xsd:unsignedLong"/> <xsd:attribute name="maxElements" type="xsd:int"/> <xsd:attribute name="levelDependents" type="xsd:boolean"/> </xsd:extension> </xsd:simpleContent> </xsd:complexType>