Classes
Type | Class | Description |
---|---|---|
![]() | FilterElement |
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:
|
![]() | PropertyFilter |
Represents information, used in conjunction with one or more FilterElement
objects, 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.
A PropertyFilter object has the following components:
In addition, a PropertyFilter object has attributes you can set that control how property values are retrieved. These attributes act as global defaults for the PropertyFilter object. You can override each of these attributes for an individual FilterElement object when you call an addIncludeProperty or addIncludeType method. For any attribute not specified for a FilterElement object, the global attribute value for the PropertyFilter object applies. If a global value is unspecified, a default value applies. Each of the following attributes can be set by the appropriate PropertyFilter method:
Property filter precedence rules:
|
Interfaces
Type | Interface | Description |
---|---|---|
![]() | IProperties |
Represents a collection of Property values that you can manipulate.
|
![]() | IProperty |
Represents the base interface for a property belonging to a Content Engine object.
Property objects allow you to access property values in an object's
Properties collection. Each Property subinterface represents a
Content Engine property that holds a value of a specific data type.
|
![]() | IPropertyBinary |
Represents a Content Engine property that holds a byte (8-bit signed integer)
array intended for a binary value.
|
![]() | IPropertyBinaryList |
Represents a Content Engine property that holds an BinaryList object.
An BinaryList object is a collection (ordered, non-unique)
of byte (8-bit signed integer) array elements, each of which is
intended to hold a binary value.
|
![]() | IPropertyBoolean |
Represents a Content Engine property that holds a Boolean value.
|
![]() | IPropertyBooleanList |
Represents a Content Engine property that holds a BooleanList object.
A BooleanList object is a collection (ordered, non-unique)
of Boolean values.
|
![]() | IPropertyContent |
Represents a Content Engine property that holds an InputStream object
intended for reading bytes of content data from a file source.
|
![]() | IPropertyDateTime |
Represents a Content Engine property that holds a Date object
for specifying a date and time.
|
![]() | IPropertyDateTimeList |
Represents a Content Engine property that holds a DateTimeList object.
A DateTimeList object is a collection (ordered, non-unique)
of Date values.
|
![]() | IPropertyDependentObjectList |
Represents a Content Engine property that holds an DependentObjectList object.
A DependentObjectList object is a collection (ordered, non-unique)
of DependentObject objects.
|
![]() | IPropertyEngineObject |
Represents a Content Engine property that holds an EngineObject object.
|
![]() | IPropertyFloat64 |
Represents a Content Engine property that holds a Double
(64-bit floating point) value.
|
![]() | IPropertyFloat64List |
Represents a Content Engine property that holds a Float64List object.
A Float64List object is a collection (ordered, non-unique)
of Double (64-bit floating point) values.
|
![]() | IPropertyId |
Represents a Content Engine property that holds an Id (GUID string) value.
|
![]() | IPropertyIdList |
Represents a Content Engine property that holds an IdList object.
An IdList object is a collection (ordered, non-unique)
of Id objects, each of which represents a GUID String value.
|
![]() | IPropertyIndependentObjectSet |
Represents a Content Engine property that holds an IndependentObjectSet object.
An IndependentObjectSet object is a collection (ordered, non-unique)
of IndependentObject objects.
|
![]() | IPropertyInteger32 |
Represents a Content Engine property that holds an Integer
(32-bit signed integer) value.
|
![]() | IPropertyInteger32List |
Represents a Content Engine property that holds an Integer32List object.
An Integer32List object is a collection (ordered, non-unique)
of Integer values.
|
![]() | IPropertyString |
Represents a Content Engine property that holds a String value.
|
![]() | IPropertyStringList |
Represents a Content Engine property that holds a StringList object.
A StringList object is a collection (ordered, non-unique)
of String values.
|