|
Name |
Description |
|
AddExcludeProperty
|
Adds one or more properties to be excluded during an object retrieval or object refresh. Any properties specified for exclusion will override those properties that are specified in an IncludeProperty or IncludeType specification. |
|
AddIncludeProperty
|
Overloaded. Adds one or more properties, specified in a FilterElement object, to be included during an object retrieval or object refresh. |
|
AddIncludeType
|
Overloaded. Adds properties identified by type in a FilterElement object to be included during an object retrieval or object refresh. The property type can be specified in the FilterElement object by a single FilteredPropertyType constant or a space-separated list of type specifiers. |
|
Equals |
Determines whether the specified Object is equal to the current Object. (inherited from Object) |
|
GetExcludeProperties
|
Returns an array of ExcludeProperty specifications, each of which identifies the properties to be excluded during an object retrieval or object refresh. Any properties specified for exclusion will override those properties that are specified in an IncludeProperty or IncludeType specification. |
|
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) |
|
GetIncludeProperties
|
Returns an array of FilterElement objects, each of which identifies one or more properties to be included during an object retrieval or object refresh. |
|
GetIncludeTypes
|
Returns an array of FilterElement objects, each of which identifies properties to be included by type during an object retrieval or object refresh. |
|
GetLevelDependents
|
Returns whether the recursion level that the property filter uses when retrieving a dependent object is the same as that of the independent object to which it belongs (True ) or one level deeper (False ). The returned value is a global value for this PropertyFilter object. You can set this value by calling one of the SetLevelDependents methods of this PropertyFilter object. |
|
GetMaxRecursion
|
Returns the maximum recursion depth for the property filter to use when retrieving property relationships. The returned value is the global value for this PropertyFilter object. You can set this value by calling one of the setMaxRecursion methods of this PropertyFilter object. |
|
GetMaxSize
|
Returns the maximum size of content data that the property filter is allowed to retrieve. If this size is exceeded, no content data is retrieved. The returned value is a global value for this PropertyFilter object. You can set this value by calling the SetMaxSize method of this PropertyFilter object. |
|
GetObjectData
|
This method is exposed to satisfy the ISerializable interface. |
|
GetPageSize
|
Returns 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. You can set this value by calling one of the setPageSize methods of this PropertyFilter object. |
|
GetType |
Gets the Type of the current instance. (inherited from Object) |
|
SetLevelDependents
|
Overloaded. Sets whether the recursion level that the property filter uses when retrieving a dependent object is the same as that of the independent object to which it belongs (True ) or one level deeper (False ). The value set is the global value for this PropertyFilter object. If the filter element of a property has a value for levelDependents , the server uses the filter element's value instead of this global value. If neither the global value nor the filter element value is specified, the default is False . |
|
SetMaxRecursion
|
Overloaded. Sets the maximum recursion depth for the property filter to use when retrieving property relationships. The value set is the global value for this PropertyFilter object. If the filter element of a property has a value for maxRecursion , the server uses the filter element's value instead of this global value. If neither the global value nor the filter element value is specified, the default is 0. |
|
SetMaxSize
|
Sets the maximum size of content data that the property filter is allowed to retrieve. |
|
SetPageSize
|
Overloaded. Sets 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 the filter element of a property has a value for pageSize, the server uses the filter element's value instead of this global value. If neither the global value nor the filter element value is specified, by default the server uses the value of the QueryPageDefaultSize property of the ServerCacheConfiguration object (the default for this property is 500). If the page size exceeds the value of the QueryPageMaxSize property of the ServerCacheConfiguration object (the default for this property is 1000), the server uses the value of the QueryPageMaxSize property instead. |
|
ToString
|
Overridden. Returns a String describing this PropertyFilter object. The string includes the object's class name and its maxRecursion, maxSize, pageSize, and levelDependents attributes. In addition, the string includes the object's list of included properties, list of included property types, and list of excluded properties. |