public interface Property
extends java.io.Serializable
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.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 . |
void setObjectValue(java.lang.Object val)
Property
object to the specified Object
.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)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
).java.lang.Object getObjectValue()
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.Object
specifying the property value.java.lang.String getStringValue()
PropertyString
object.String
specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyString
.java.util.Date getDateTimeValue()
PropertyDateTime
object.Date
specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyDateTime
.java.lang.Integer getInteger32Value()
PropertyInteger32
object.Integer
specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyInteger32
.java.lang.Boolean getBooleanValue()
PropertyBoolean
object.Boolean
specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyBoolean
.java.lang.Double getFloat64Value()
PropertyFloat64
object.Double
specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyFloat64
.byte[] getBinaryValue()
PropertyBinary
object.byte
array specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyBinary
.Id getIdValue()
PropertyId
object.Id
object specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyId
.EngineObject getEngineObjectValue()
PropertyEngineObject
object.EngineObject
object specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyEngineObject
.DependentObjectList getDependentObjectListValue()
PropertyDependentObjectList
object.DependentObjectList
object specifying a collection of
DependentObject
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyDependentObjectList
.IndependentObjectSet getIndependentObjectSetValue()
PropertyIndependentObjectSet
object.IndependentObjectSet
object specifying a collection of
IndependentObject
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyIndependentObjectSet
.StringList getStringListValue()
PropertyStringList
object.StringList
object specifying a collection of
String
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyStringList
.BooleanList getBooleanListValue()
PropertyBooleanList
object.BooleanList
object specifying a collection of
Boolean
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyBooleanList
.Integer32List getInteger32ListValue()
PropertyInteger32List
object.Integer32List
object specifying a collection of
Integer
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyInteger32List
.Float64List getFloat64ListValue()
PropertyFloat64List
object.Float64List
object specifying a collection of
Double
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyInteger32List
.DateTimeList getDateTimeListValue()
PropertyDateTimeList
object.DateTimeList
object specifying a collection of
Date
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyDateTimeList
.BinaryList getBinaryListValue()
PropertyBinaryList
object.BinaryList
object specifying a collection of
byte
arrays.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyBinaryList
.IdList getIdListValue()
PropertyIdList
object.IdList
object specifying a collection of
Id
objects.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyIdList
.java.io.InputStream getInputStreamValue()
PropertyContent
object.InputStream
object specifying the property value.API_INVALID_PROPERTY_TYPE
- if this method is called by a
Property
object type other than PropertyContent
.EngineRuntimeException getRetrievalErrorValue()
Property
object when
the Content Engine property that it represents cannot be accessed.EngineRuntimeException
object specifying the
error. If the Property
object holds a valid Content Engine
property value, this method returns null
.PropertyState getState()
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.PropertyState
constant.java.lang.String getPropertyName()
Property
object.String
specifying the property name.boolean isSettable()
Property
object can be set by an application (true
)
or not (false
).true
if the property is settable;
otherwise, returns false
.boolean isDirty()
Property
object has changed since it was last saved (true
)
or not (false
).true
if the value of the property has changed;
otherwise, returns false
.© Copyright IBM Corporation 2006, 2015. All rights reserved.