Content Engine Java API: FilteredPropertyType

java.lang.Object
- com.filenet.api.constants.FilteredPropertyType

All Implemented Interfaces:

java.io.Serializable
```
public final class FilteredPropertyType
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that are used by a property filter to indicate the type of Content Engine properties to be retrieved during an object retrieval or an object refresh.

See Also:
PropertyFilter, FilterElement, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static FilteredPropertyType`	`ANY` Indicates all properties.
`static int`	`ANY_AS_INT` An `int` value associated with the `ANY` instance of this class.
`static FilteredPropertyType`	`ANY_LIST` Indicates all properties with a cardinality of `LIST`.
`static int`	`ANY_LIST_AS_INT` An `int` value associated with the `ANY_LIST` instance of this class.
`static FilteredPropertyType`	`ANY_NON_OBJECT` Indicates all properties that do not return a Content Engine object as a value.
`static int`	`ANY_NON_OBJECT_AS_INT` An `int` value associated with the `ANY_NON_OBJECT` instance of this class.
`static FilteredPropertyType`	`ANY_SINGLETON` Indicates all properties with a cardinality of `SINGLE`.
`static int`	`ANY_SINGLETON_AS_INT` An `int` value associated with the `ANY_SINGLETON` instance of this class.
`static FilteredPropertyType`	`CONTENT_DATA` Indicates `PropertyContent` properties.
`static int`	`CONTENT_DATA_AS_INT` An `int` value associated with the `CONTENT_DATA` instance of this class.
`static FilteredPropertyType`	`ENUM_OF_OBJECT` Indicates `PropertyIndependentObjectSet` properties.
`static int`	`ENUM_OF_OBJECT_AS_INT` An `int` value associated with the `ENUM_OF_OBJECT` instance of this class.
`static FilteredPropertyType`	`LIST_OF_BINARY` Indicates `PropertyBinaryList` properties.
`static int`	`LIST_OF_BINARY_AS_INT` An `int` value associated with the `LIST_OF_BINARY` instance of this class.
`static FilteredPropertyType`	`LIST_OF_BOOLEAN` Indicates `PropertyBooleanList` properties.
`static int`	`LIST_OF_BOOLEAN_AS_INT` An `int` value associated with the `LIST_OF_BOOLEAN` instance of this class.
`static FilteredPropertyType`	`LIST_OF_DATE` Indicates `PropertyDateTimeList` properties.
`static int`	`LIST_OF_DATE_AS_INT` An `int` value associated with the `LIST_OF_DATE` instance of this class.
`static FilteredPropertyType`	`LIST_OF_DOUBLE` Indicates `PropertyFloat64List` properties.
`static int`	`LIST_OF_DOUBLE_AS_INT` An `int` value associated with the `LIST_OF_DOUBLE` instance of this class.
`static FilteredPropertyType`	`LIST_OF_GUID` Indicates `PropertyIdList` properties.
`static int`	`LIST_OF_GUID_AS_INT` An `int` value associated with the `LIST_OF_GUID` instance of this class.
`static FilteredPropertyType`	`LIST_OF_LONG` Indicates `PropertyInteger32List` properties.
`static int`	`LIST_OF_LONG_AS_INT` An `int` value associated with the `LIST_OF_LONG` instance of this class.
`static FilteredPropertyType`	`LIST_OF_OBJECT` Indicates `PropertyDependentObjectList` properties.
`static int`	`LIST_OF_OBJECT_AS_INT` An `int` value associated with the `LIST_OF_OBJECT` instance of this class.
`static FilteredPropertyType`	`LIST_OF_STRING` Indicates `PropertyStringList` properties.
`static int`	`LIST_OF_STRING_AS_INT` An `int` value associated with the `LIST_OF_STRING` instance of this class.
`static FilteredPropertyType`	`SINGLETON_BINARY` Indicates `PropertyBinary` properties.
`static int`	`SINGLETON_BINARY_AS_INT` An `int` value associated with the `SINGLETON_BINARY` instance of this class.
`static FilteredPropertyType`	`SINGLETON_BOOLEAN` Indicates `PropertyBoolean` properties.
`static int`	`SINGLETON_BOOLEAN_AS_INT` An `int` value associated with the `SINGLETON_BOOLEAN` instance of this class.
`static FilteredPropertyType`	`SINGLETON_DATE` Indicates `PropertyDateTime` properties.
`static int`	`SINGLETON_DATE_AS_INT` An `int` value associated with the `SINGLETON_DATE` instance of this class.
`static FilteredPropertyType`	`SINGLETON_DOUBLE` Indicates `PropertyFloat64` properties.
`static int`	`SINGLETON_DOUBLE_AS_INT` An `int` value associated with the `SINGLETON_DOUBLE` instance of this class.
`static FilteredPropertyType`	`SINGLETON_GUID` Indicates `PropertyId` properties.
`static int`	`SINGLETON_GUID_AS_INT` An `int` value associated with the `SINGLETON_GUID` instance of this class.
`static FilteredPropertyType`	`SINGLETON_LONG` Indicates `PropertyInteger32` properties.
`static int`	`SINGLETON_LONG_AS_INT` An `int` value associated with the `SINGLETON_LONG` instance of this class.
`static FilteredPropertyType`	`SINGLETON_OBJECT` Indicates `PropertyEngineObject` properties.
`static int`	`SINGLETON_OBJECT_AS_INT` An `int` value associated with the `SINGLETON_OBJECT` instance of this class.
`static FilteredPropertyType`	`SINGLETON_STRING` Indicates `PropertyString` properties.
`static int`	`SINGLETON_STRING_AS_INT` An `int` value associated with the `SINGLETON_STRING` instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static FilteredPropertyType`	`getInstanceFromString(java.lang.String value)` Returns an instance of this class using its associated `String` value.
`int`	`getIntValue()` Returns an `int` value associated with a specific instance of this class.
`java.lang.String`	`getStringValue()` Returns a `String` value associated with a specific instance of this class.
`java.lang.String`	`getValue()` Returns a `String` value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SINGLETON_BINARY_AS_INT
```
public static final int SINGLETON_BINARY_AS_INT
```
    An int value associated with the SINGLETON_BINARY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_BINARY
```
public static final FilteredPropertyType SINGLETON_BINARY
```
    Indicates PropertyBinary properties. Equivalent to the "SingletonBinary" string specification.
  - SINGLETON_BOOLEAN_AS_INT
```
public static final int SINGLETON_BOOLEAN_AS_INT
```
    An int value associated with the SINGLETON_BOOLEAN instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_BOOLEAN
```
public static final FilteredPropertyType SINGLETON_BOOLEAN
```
    Indicates PropertyBoolean properties. Equivalent to the "SingletonBoolean" string specification.
  - SINGLETON_DATE_AS_INT
```
public static final int SINGLETON_DATE_AS_INT
```
    An int value associated with the SINGLETON_DATE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_DATE
```
public static final FilteredPropertyType SINGLETON_DATE
```
    Indicates PropertyDateTime properties. Equivalent to the "SingletonDateTime" string specification.
  - SINGLETON_DOUBLE_AS_INT
```
public static final int SINGLETON_DOUBLE_AS_INT
```
    An int value associated with the SINGLETON_DOUBLE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_DOUBLE
```
public static final FilteredPropertyType SINGLETON_DOUBLE
```
    Indicates PropertyFloat64 properties. Equivalent to the "SingletonFloat64" string specification.
  - SINGLETON_GUID_AS_INT
```
public static final int SINGLETON_GUID_AS_INT
```
    An int value associated with the SINGLETON_GUID instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_GUID
```
public static final FilteredPropertyType SINGLETON_GUID
```
    Indicates PropertyId properties. Equivalent to the "SingletonId" string specification.
  - SINGLETON_LONG_AS_INT
```
public static final int SINGLETON_LONG_AS_INT
```
    An int value associated with the SINGLETON_LONG instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_LONG
```
public static final FilteredPropertyType SINGLETON_LONG
```
    Indicates PropertyInteger32 properties. Equivalent to the "SingletonInteger32" string specification.
  - SINGLETON_STRING_AS_INT
```
public static final int SINGLETON_STRING_AS_INT
```
    An int value associated with the SINGLETON_STRING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_STRING
```
public static final FilteredPropertyType SINGLETON_STRING
```
    Indicates PropertyString properties. Equivalent to the "SingletonString" string specification.
  - SINGLETON_OBJECT_AS_INT
```
public static final int SINGLETON_OBJECT_AS_INT
```
    An int value associated with the SINGLETON_OBJECT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SINGLETON_OBJECT
```
public static final FilteredPropertyType SINGLETON_OBJECT
```
    Indicates PropertyEngineObject properties. Equivalent to the "SingletonObject" string specification.
  - LIST_OF_BINARY_AS_INT
```
public static final int LIST_OF_BINARY_AS_INT
```
    An int value associated with the LIST_OF_BINARY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_BINARY
```
public static final FilteredPropertyType LIST_OF_BINARY
```
    Indicates PropertyBinaryList properties. Equivalent to the "ListOfBinary" string specification.
  - LIST_OF_BOOLEAN_AS_INT
```
public static final int LIST_OF_BOOLEAN_AS_INT
```
    An int value associated with the LIST_OF_BOOLEAN instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_BOOLEAN
```
public static final FilteredPropertyType LIST_OF_BOOLEAN
```
    Indicates PropertyBooleanList properties. Equivalent to the "ListOfBoolean" string specification.
  - LIST_OF_DATE_AS_INT
```
public static final int LIST_OF_DATE_AS_INT
```
    An int value associated with the LIST_OF_DATE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_DATE
```
public static final FilteredPropertyType LIST_OF_DATE
```
    Indicates PropertyDateTimeList properties. Equivalent to the "ListOfDateTime" string specification.
  - LIST_OF_DOUBLE_AS_INT
```
public static final int LIST_OF_DOUBLE_AS_INT
```
    An int value associated with the LIST_OF_DOUBLE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_DOUBLE
```
public static final FilteredPropertyType LIST_OF_DOUBLE
```
    Indicates PropertyFloat64List properties. Equivalent to the "ListOfFloat64" string specification.
  - LIST_OF_GUID_AS_INT
```
public static final int LIST_OF_GUID_AS_INT
```
    An int value associated with the LIST_OF_GUID instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_GUID
```
public static final FilteredPropertyType LIST_OF_GUID
```
    Indicates PropertyIdList properties. Equivalent to the "ListOfId" string specification.
  - LIST_OF_LONG_AS_INT
```
public static final int LIST_OF_LONG_AS_INT
```
    An int value associated with the LIST_OF_LONG instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_LONG
```
public static final FilteredPropertyType LIST_OF_LONG
```
    Indicates PropertyInteger32List properties. Equivalent to the "ListOfInteger32" string specification.
  - LIST_OF_STRING_AS_INT
```
public static final int LIST_OF_STRING_AS_INT
```
    An int value associated with the LIST_OF_STRING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_STRING
```
public static final FilteredPropertyType LIST_OF_STRING
```
    Indicates PropertyStringList properties. Equivalent to the "ListOfString" string specification.
  - LIST_OF_OBJECT_AS_INT
```
public static final int LIST_OF_OBJECT_AS_INT
```
    An int value associated with the LIST_OF_OBJECT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - LIST_OF_OBJECT
```
public static final FilteredPropertyType LIST_OF_OBJECT
```
    Indicates PropertyDependentObjectList properties. Equivalent to the "ListOfObject" string specification.
  - ENUM_OF_OBJECT_AS_INT
```
public static final int ENUM_OF_OBJECT_AS_INT
```
    An int value associated with the ENUM_OF_OBJECT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ENUM_OF_OBJECT
```
public static final FilteredPropertyType ENUM_OF_OBJECT
```
    Indicates PropertyIndependentObjectSet properties. Equivalent to the "EnumOfObject" string specification.
  - CONTENT_DATA_AS_INT
```
public static final int CONTENT_DATA_AS_INT
```
    An int value associated with the CONTENT_DATA instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - CONTENT_DATA
```
public static final FilteredPropertyType CONTENT_DATA
```
    Indicates PropertyContent properties. Equivalent to the "ContentData" string specification.
  - ANY_SINGLETON_AS_INT
```
public static final int ANY_SINGLETON_AS_INT
```
    An int value associated with the ANY_SINGLETON instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ANY_SINGLETON
```
public static final FilteredPropertyType ANY_SINGLETON
```
    Indicates all properties with a cardinality of SINGLE. Equivalent to the "Singleton*" string specification.
  - ANY_LIST_AS_INT
```
public static final int ANY_LIST_AS_INT
```
    An int value associated with the ANY_LIST instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ANY_LIST
```
public static final FilteredPropertyType ANY_LIST
```
    Indicates all properties with a cardinality of LIST. Equivalent to the "List*" string specification.
  - ANY_AS_INT
```
public static final int ANY_AS_INT
```
    An int value associated with the ANY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ANY
```
public static final FilteredPropertyType ANY
```
    Indicates all properties. Equivalent to the "*" string specification.
  - ANY_NON_OBJECT_AS_INT
```
public static final int ANY_NON_OBJECT_AS_INT
```
    An int value associated with the ANY_NON_OBJECT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ANY_NON_OBJECT
```
public static final FilteredPropertyType ANY_NON_OBJECT
```
    Indicates all properties that do not return a Content Engine object as a value. Equivalent to the "!Object" string specification.
- Method Detail
  - getValue
```
public java.lang.String getValue()
```
    Returns a String value associated with a specific instance of this class.
    
    Returns:
    A String value.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns a String value associated with a specific instance of this class.
    
    Returns:
    A String value.
  - getIntValue
```
public int getIntValue()
```
    Returns an int value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
  - getInstanceFromString
```
public static final FilteredPropertyType getInstanceFromString(java.lang.String value)
```
    Returns an instance of this class using its associated String value.
    
    Parameters:
    value - A String value.
    
    Returns:
    The enumeration instance associated with the given String value.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.

Methods inherited from class java.lang.Object

SINGLETON_BINARY_AS_INT

SINGLETON_BINARY

SINGLETON_BOOLEAN_AS_INT

SINGLETON_BOOLEAN

SINGLETON_DATE_AS_INT

SINGLETON_DATE

SINGLETON_DOUBLE_AS_INT

SINGLETON_DOUBLE

SINGLETON_GUID_AS_INT

SINGLETON_GUID

SINGLETON_LONG_AS_INT

SINGLETON_LONG

SINGLETON_STRING_AS_INT

SINGLETON_STRING

SINGLETON_OBJECT_AS_INT

SINGLETON_OBJECT

LIST_OF_BINARY_AS_INT

LIST_OF_BINARY

LIST_OF_BOOLEAN_AS_INT

LIST_OF_BOOLEAN

LIST_OF_DATE_AS_INT

LIST_OF_DATE

LIST_OF_DOUBLE_AS_INT

LIST_OF_DOUBLE

LIST_OF_GUID_AS_INT

LIST_OF_GUID

LIST_OF_LONG_AS_INT

LIST_OF_LONG

LIST_OF_STRING_AS_INT

LIST_OF_STRING

LIST_OF_OBJECT_AS_INT

LIST_OF_OBJECT

ENUM_OF_OBJECT_AS_INT

ENUM_OF_OBJECT

CONTENT_DATA_AS_INT

CONTENT_DATA

ANY_SINGLETON_AS_INT

ANY_SINGLETON

ANY_LIST_AS_INT

ANY_LIST

ANY_AS_INT

ANY

ANY_NON_OBJECT_AS_INT

ANY_NON_OBJECT

getValue

getStringValue

getIntValue

getInstanceFromString

toString