Represents information, used in conjunction with a
PropertyFilter
object, for controlling which properties of a Content Engine object (and with what level of detail) to return from the server during an object retrieval or an object refresh. Because the number and size of properties may be large for certain objects, using a property filter to retrieve a subset of the available properties can result in better performance by reducing the amount of data that is retrieved from the server.
In order to create a property filter, a FilterElement
object must be created for each set of properties that you wish to add. First, create a PropertyFilter
object, then call its AddIncludeProperty
or AddIncludeType
methods to specify one or more FilterElement
objects. Depending on which method you choose to use, you can either create a FilterElement
object directly and pass it as a method parameter or let the server create the object for you based on the values that you provide for the method parameters.
A FilterElement
object can specify one or more properties, either by identifier or by type. When specifying properties by identifier, a FilterElement
object is created by setting a parameter of the appropriate constructor to a space-separated list of symbolic names. When specifying properties by type, a FilterElement
object is created by setting a parameter of the appropriate constructor to a space-separated list of type specifiers or a FilteredPropertyType
constant.
In addition, a FilterElement
object also has attributes you can set that control how property values are retrieved. These attributes override any global attributes that may be specified by the associated PropertyFilter
object. If an attribute is not set in a FilterElement
object, the attribute's global value in the PropertyFilter
object will be used instead. If a global value is unspecified, a default value applies. The following attributes are set by the parameters of a FilterElement
constructor:
- levelDependents: A
Boolean
that specifies 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
). - maxRecursion: A zero-based
Integer
that specifies the maximum allowable recursion depth to use when retrieving property relationships. This attribute determines the level of depth at which property values are included. If unspecified, the default is zero. - maxSize: A
Long
that specifies the maximum size, in bytes
, of content data that can be returned when properties that hold content data are retrieved. If the amount of content data held by retrieved properties exceeds this size, no content data is returned. If unspecified, the default is to return all content data, no matter how large. - pageSize: An
Integer
that specifies the iterator page size for independent object sets returned by PropertyIndependentObjectSet
properties. The iterator page size determines how many elements of an independent object set are retrieved from the server during each fetch. If unspecified, all of the elements in an independent object set are retrieved during a single fetch.
The following tables list the members exposed by FilterElement.
Public Constructors
Protected Constructors
Public Methods
| Name | Description |
---|
 | Equals | Determines whether the specified Object is equal to the current Object. (inherited from Object) |
 | GetHashCode | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object) |
 | GetLevelDependents | Returns whether the recursion level to use when retrieving a dependent object specified by this FilterElement object is the same as that of the independent object to which it belongs (True ) or one level deeper (False ). |
 | GetMaxRecursion | Returns the maximum recursion depth to use when retrieving property relationships specified by this FilterElement object. |
 | GetMaxSize | Returns the maximum size of the content data that can be returned when properties that hold content data specified by this FilterElement object are retrieved. If the amount of content data held by retrieved properties exceeds this size, no content data is returned. |
 | GetObjectData | This method is exposed to satisfy the ISerializable interface. |
 | GetPageSize | Returns the iterator page size for independent object sets returned by PropertyIndependentObjectSet properties specified by this FilterElement object . The iterator page size determines how many elements of an independent object set are retrieved from the server during each fetch. |
 | GetType | Gets the Type of the current instance. (inherited from Object) |
 | GetValue | Returns a space-separated list of one or more property identifiers or a space-separated list of one or more property types that are specified by this FilterElement object. |
 | ToString | Overridden. Returns a String describing this FilterElement object, including its class name, list of included properties, list of included property types, list of excluded properties, and its maxRecursion, maxSize, levelDependents, and pageSize attributes. |
Top
Protected Methods
| Name | Description |
---|
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object) |
 | MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object) |
Top
Explicit Interface Implementations
See Also