System.Object
PropertyFilterType
Client Declaration
public class PropertyFilterType
Represents information, used in conjunction with one or more FilterElementType
elements, for controlling which properties of a Content Engine object (and with what level of detail) will appear in the output of an operation.
When processing a property filter, the server obeys the following rules:
ListOfObject
properties, if the property is included and the current recursion level is less than or equal to the value of maxRecursion
, the property object's Property
element is generated, with extra metadata if required, and the value(s) of the property is omitted.SingletonObject
or EnumOfObject
properties, the considerations above apply with the following exceptions:
maxRecursion
, the property is expanded recursively.maxRecursion
, the value is given by reference or is unevaluated (for SingletonObject
) or omitted (for EnumOfObject
).In order for content to be returned via the Content
pseudo-property (ContentData
element) of a ContentTransfer
object, the Content
property must be specified for inclusion with a maxRecursion
value of at least 1 (one level below the document to which the content belongs) and recursive traversal of the ContentElements
property must be enabled. To simplify matters, the server treats an IncludeProperties
element specifying the Content
property as implicitly including the ContentElements
property at the same recursion level.
Elements
FilterElementType[]
IncludeProperties
: [request] Specifies the properties to
be included in the output. This element can consist of zero or more FilterElementType
elements, each of which specifies a space-separated list of symbolic names or GUIDs identifying the properties. If a property is included more than once, the options from its first appearance takes precedence.FilterElementType[]
IncludeTypes
: [request] Specifies the type of properties to
be included in the output. This element can consist of zero or more FilterElementType
elements, each of which specifies a space-separated list of property type specifiers. All properties of the specified type will be included in the output unless explicitly excluded by the ExcludeProperties
attribute. If a property is included more than once as the result of a wildcard, the options from its most specific occurrence takes precedence (for example, xyz* takes precedence over *); otherwise, its first appearance applies. String[]
ExcludeProperties
: [request] Optional element specifying a space-separated list of symbolic names or GUIDs identifying the properties to be excluded in the output. ExcludeProperties
is used in conjunction with IncludeTypes
to remove specific properties that would otherwise be included based on data type. ExcludeProperties
overrides any properties specified in the IncludeProperties
attribute.NOTE The above elements must appear in the order shown. If a property is included by both IncludeProperties
and IncludeTypes
, its inclusion in IncludeProperties
takes precedence. If neither IncludeProperties
or IncludeTypes
is present, it is equivalent to using the following IncludeTypes
filter: Singleton* List* EnumOfObject
.
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) for any filtered object collection that is returned. If this attribute is omitted or a value of -1 is specified, a default page size will apply.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 of 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. 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="PropertyFilterType"> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0" name="IncludeProperties" type="FilterElementType"/> <xsd:element maxOccurs="unbounded" minOccurs="0" name="IncludeTypes" type="FilterElementType"/> <xsd:element maxOccurs="unbounded" minOccurs="0" name="ExcludeProperties" type="xsd:string"/> </xsd:sequence> <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:complexType>