Content Engine Java API: Property

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

PropertyBinary, PropertyBinaryList, PropertyBoolean, PropertyBooleanList, PropertyContent, PropertyDateTime, PropertyDateTimeList, PropertyDependentObjectList, PropertyEngineObject, PropertyFloat64, PropertyFloat64List, PropertyId, PropertyIdList, PropertyIndependentObjectSet, PropertyInteger32, PropertyInteger32List, PropertyString, PropertyStringList
```
public interface Property
extends java.io.Serializable
```
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.

Method Summary

Methods
Modifier and Type	Method and Description
`BinaryList`	`getBinaryListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyBinaryList` object.
`byte[]`	`getBinaryValue()` Returns the value held by the Content Engine property represented by this `PropertyBinary` object.
`BooleanList`	`getBooleanListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyBooleanList` object.
`java.lang.Boolean`	`getBooleanValue()` Returns the value held by the Content Engine property represented by this `PropertyBoolean` object.
`DateTimeList`	`getDateTimeListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyDateTimeList` object.
`java.util.Date`	`getDateTimeValue()` Returns the value held by the Content Engine property represented by this `PropertyDateTime` object.
`DependentObjectList`	`getDependentObjectListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyDependentObjectList` object.
`EngineObject`	`getEngineObjectValue()` Returns the value held by the Content Engine property represented by this `PropertyEngineObject` object.
`Float64List`	`getFloat64ListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyFloat64List` object.
`java.lang.Double`	`getFloat64Value()` Returns the value held by the Content Engine property represented by this `PropertyFloat64` object.
`IdList`	`getIdListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyIdList` object.
`Id`	`getIdValue()` Returns the value held by the Content Engine property represented by this `PropertyId` object.
`IndependentObjectSet`	`getIndependentObjectSetValue()` Returns the set of values held by the Content Engine property collection represented by this `PropertyIndependentObjectSet` object.
`java.io.InputStream`	`getInputStreamValue()` Returns the value held by the Content Engine property represented by this `PropertyContent` object.
`Integer32List`	`getInteger32ListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyInteger32List` object.
`java.lang.Integer`	`getInteger32Value()` Returns the value held by the Content Engine property represented by this `PropertyInteger32` object.
`java.lang.Object`	`getObjectValue()` Returns the value held by the Content Engine property represented by this `Property` object.
`java.lang.String`	`getPropertyName()` Returns the name of the Content Engine property represented by this `Property` object.
`EngineRuntimeException`	`getRetrievalErrorValue()` Returns the error code held by this `Property` object when the Content Engine property that it represents cannot be accessed.
`PropertyState`	`getState()` Returns a `PropertyState` constant that specifies the type of value held by this `Property` object as it relates to a particular Content Engine property.
`StringList`	`getStringListValue()` Returns the list of values held by the Content Engine property collection represented by this `PropertyStringList` object.
`java.lang.String`	`getStringValue()` Returns the value held by the Content Engine property represented by this `PropertyString` object.
`boolean`	`isDirty()` Specifies whether the value of the Content Engine property represented by this `Property` object has changed since it was last saved (`true`) or not (`false`).
`boolean`	`isSettable()` Specifies whether the value of the Content Engine property represented by this `Property` object can be set by an application (`true`) or not (`false`).
`void`	`setObjectValue(java.lang.Object val)` Sets the value of the Content Engine property represented by this `Property` object to the specified `Object`.

- Method Detail
  - setObjectValue
```
void setObjectValue(java.lang.Object val)
```
    Sets the value of the Content Engine property represented by this Property object to the specified Object.
    Parameters:
    val - An Object specifying the new property value. Only the following Object subclasses are allowed; each of which corresponds to the data type that a property represented by a particular Property object type can hold:
    
    Boolean (PropertyBoolean value)
    
    byte (PropertyBinary value)
    
    Date (PropertyDateTime value)
    
    Double (PropertyFloat64 value)
    
    Id (PropertyId value)
    
    Integer (PropertyInteger32 value)
    
    String (PropertyString value)
    
    InputStream (PropertyContent value)
    
    EngineObject (PropertyEngineObject value)
    
    ObjectReference (PropertyEngineObject value)
    
    BinaryList (PropertyBinaryList value)
    
    BooleanList (PropertyBooleanList value)
    
    DateTimeList (PropertyDateTimeList value)
    
    DependentObjectList (PropertyDependentObjectList value)
    
    Float64List (PropertyFloat64List value)
    
    IdList (PropertyIdList value)
    
    IndependentObjectSet (PropertyIndependentObjectSet value)
    
    Integer32List (PropertyInteger32List value)
    
    StringList (PropertyStringList value)
    Throws:
    
    API_UNSUPPORTED_PROPERTY_TYPE - if val specifies a null or an invalid object type.
    
    E_READ_ONLY - if an attempt is made to update a property that is not settable (its Property.isSettable method returns false).
  - getObjectValue
```
java.lang.Object getObjectValue()
```
    Returns the value held by the Content Engine property represented by this Property object. If the property holds an unevaluated object or a reference object, this method makes a round trip to the server to retrieve the object value.
    
    Returns:
    An Object specifying the property value.
  - getStringValue
```
java.lang.String getStringValue()
```
    Returns the value held by the Content Engine property represented by this PropertyString object.
    
    Returns:
    A String specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyString.
  - getDateTimeValue
```
java.util.Date getDateTimeValue()
```
    Returns the value held by the Content Engine property represented by this PropertyDateTime object.
    
    Returns:
    A Date specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyDateTime.
  - getInteger32Value
```
java.lang.Integer getInteger32Value()
```
    Returns the value held by the Content Engine property represented by this PropertyInteger32 object.
    
    Returns:
    An Integer specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyInteger32.
  - getBooleanValue
```
java.lang.Boolean getBooleanValue()
```
    Returns the value held by the Content Engine property represented by this PropertyBoolean object.
    
    Returns:
    A Boolean specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyBoolean.
  - getFloat64Value
```
java.lang.Double getFloat64Value()
```
    Returns the value held by the Content Engine property represented by this PropertyFloat64 object.
    
    Returns:
    A Double specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyFloat64.
  - getBinaryValue
```
byte[] getBinaryValue()
```
    Returns the value held by the Content Engine property represented by this PropertyBinary object.
    
    Returns:
    A byte array specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyBinary.
  - getIdValue
```
Id getIdValue()
```
    Returns the value held by the Content Engine property represented by this PropertyId object.
    
    Returns:
    An Id object specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyId.
  - getEngineObjectValue
```
EngineObject getEngineObjectValue()
```
    Returns the value held by the Content Engine property represented by this PropertyEngineObject object.
    
    Returns:
    An EngineObject object specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyEngineObject.
  - getDependentObjectListValue
```
DependentObjectList getDependentObjectListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyDependentObjectList object.
    
    Returns:
    A DependentObjectList object specifying a collection of DependentObject objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyDependentObjectList.
  - getIndependentObjectSetValue
```
IndependentObjectSet getIndependentObjectSetValue()
```
    Returns the set of values held by the Content Engine property collection represented by this PropertyIndependentObjectSet object.
    
    Returns:
    A IndependentObjectSet object specifying a collection of IndependentObject objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyIndependentObjectSet.
  - getStringListValue
```
StringList getStringListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyStringList object.
    
    Returns:
    A StringList object specifying a collection of String objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyStringList.
  - getBooleanListValue
```
BooleanList getBooleanListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyBooleanList object.
    
    Returns:
    A BooleanList object specifying a collection of Boolean objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyBooleanList.
  - getInteger32ListValue
```
Integer32List getInteger32ListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyInteger32List object.
    
    Returns:
    An Integer32List object specifying a collection of Integer objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyInteger32List.
  - getFloat64ListValue
```
Float64List getFloat64ListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyFloat64List object.
    
    Returns:
    A Float64List object specifying a collection of Double objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyInteger32List.
  - getDateTimeListValue
```
DateTimeList getDateTimeListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyDateTimeList object.
    
    Returns:
    A DateTimeList object specifying a collection of Date objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyDateTimeList.
  - getBinaryListValue
```
BinaryList getBinaryListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyBinaryList object.
    
    Returns:
    A BinaryList object specifying a collection of byte arrays.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyBinaryList.
  - getIdListValue
```
IdList getIdListValue()
```
    Returns the list of values held by the Content Engine property collection represented by this PropertyIdList object.
    
    Returns:
    An IdList object specifying a collection of Id objects.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyIdList.
  - getInputStreamValue
```
java.io.InputStream getInputStreamValue()
```
    Returns the value held by the Content Engine property represented by this PropertyContent object.
    
    Returns:
    An InputStream object specifying the property value.
    
    Throws:
    
    API_INVALID_PROPERTY_TYPE - if this method is called by a Property object type other than PropertyContent.
  - getRetrievalErrorValue
```
EngineRuntimeException getRetrievalErrorValue()
```
    Returns the error code held by this Property object when the Content Engine property that it represents cannot be accessed.
    
    Returns:
    An EngineRuntimeException object specifying the error. If the Property object holds a valid Content Engine property value, this method returns null.
  - getState
```
PropertyState getState()
```
    Returns a PropertyState constant that specifies the type of value held by this Property object as it relates to a particular Content Engine property. Possible values are:
    - NO_VALUE: Indicates that a Content Engine property is either null (if it has single cardinality) or refers to an empty collection (if it has list or enumeration cardinality).
    - REFERENCE: Indicate that this Property object holds an ObjectReference object that specifies a reference to the object returned by a Content Engine property.
    - RETRIEVAL_ERROR: Indicates that this Property object holds an EngineRuntimeException object representing an error has occurred during retrieval of a Content Engine property value.
    - UNEVALUATED: Indicates that a Content Engine property returns an object whose value has not yet been determined.
    - VALUE: Indicates that this Property object holds an object that specifies a valid value of a Content Engine property.
    Returns:
    A PropertyState constant.
  - getPropertyName
```
java.lang.String getPropertyName()
```
    Returns the name of the Content Engine property represented by this Property object.
    
    Returns:
    A String specifying the property name.
  - isSettable
```
boolean isSettable()
```
    Specifies whether the value of the Content Engine property represented by this Property object can be set by an application (true) or not (false).
    
    Returns:
    true if the property is settable; otherwise, returns false.
  - isDirty
```
boolean isDirty()
```
    Specifies whether the value of the Content Engine property represented by this Property object has changed since it was last saved (true) or not (false).
    
    Returns:
    true if the value of the property has changed; otherwise, returns false.

setObjectValue

getObjectValue

getStringValue

getDateTimeValue

getInteger32Value

getBooleanValue

getFloat64Value

getBinaryValue

getIdValue

getEngineObjectValue

getDependentObjectListValue

getIndependentObjectSetValue

getStringListValue

getBooleanListValue

getInteger32ListValue

getFloat64ListValue

getDateTimeListValue

getBinaryListValue

getIdListValue

getInputStreamValue

getRetrievalErrorValue

getState

getPropertyName

isSettable

isDirty