public interface RMProperty
RMProperties
collection.
A RMProperty
instance can only be acquired as a member
of its parent RMProperties
collection.
A new RMProperty
instance is created using the
RMProperties.add
method or one of the
various RMProperties
.putXXXValue()
methods.
A existing RMProperty
instance can be removed from
its corresponding parent collection using the
RMProperties.remove
method.
Modifier and Type | Method and Description |
---|---|
java.util.List<byte[]> |
getBinaryListValue()
Returns the value of a
RMProperty of data type DataType.Binary
and cardinality multi-valued. |
byte[] |
getBinaryValue()
Returns the value of a
RMProperty of data type DataType.Binary
and cardinality single-valued. |
java.util.List<java.lang.Boolean> |
getBooleanListValue()
Returns the value of a
RMProperty of data type DataType.Boolean
and cardinality multi-valued. |
java.lang.Boolean |
getBooleanValue()
Returns the value of a
RMProperty of data type DataType.Boolean
and cardinality single-valued. |
RMCardinality |
getCardinality()
Returns the
Cardinality defined
for this RMProperty instance. |
DataType |
getDataType()
Returns the
DataType defined
for this RMProperty instance. |
java.util.List<java.util.Date> |
getDateTimeListValue()
Returns the value of a
RMProperty of data type DataType.DateTime
and cardinality multi-valued. |
java.util.Date |
getDateTimeValue()
Returns the value of a
RMProperty of data type DataType.DateTime
and cardinality single-valued. |
java.util.List<java.lang.Double> |
getDoubleListValue()
Returns the value of a
RMProperty of data type DataType.Double
and cardinality multi-valued. |
java.lang.Double |
getDoubleValue()
Returns the value of a
RMProperty of data type DataType.Double
and cardinality single-valued. |
java.util.List<java.lang.String> |
getGuidListValue()
Returns the value of a
RMProperty of data type DataType.Guid
and cardinality multi-valued. |
java.lang.String |
getGuidValue()
Returns the value of a
RMProperty of data type DataType.Guid
and cardinality single-valued. |
java.util.List<java.lang.Integer> |
getIntegerListValue()
Returns the value of a
RMProperty of data type DataType.Integer
and cardinality multi-valued. |
java.lang.Integer |
getIntegerValue()
Returns the value of a
RMProperty of data type DataType.Integer
and cardinality single-valued. |
java.util.List<java.lang.Object> |
getObjectListValue()
Returns the value of a
RMProperty of data type DataType.Object
and cardinality multi-valued. |
java.lang.Object |
getObjectValue()
Returns the value of a
RMProperty of data type DataType.Object
and cardinality single-valued. |
java.util.List<java.lang.String> |
getStringListValue()
Returns the value of a
RMProperty of data type DataType.String
and cardinality multi-valued. |
java.lang.String |
getStringValue()
Returns the value of a
RMProperty of data type DataType.String
and cardinality single-valued. |
java.lang.String |
getSymbolicName()
Returns the symbolic name of the property.
|
boolean |
isDirty()
Indicates if the value of this property has been modified since the last time that
its corresponding repository entity was saved.
|
boolean |
isSettable()
Indicates whether the value of this property can be set.
|
void |
setBinaryValue(byte[] value)
Sets the value of a
RMProperty instance whose data type is
DataType.Binary . |
void |
setBinaryValue(java.util.List<byte[]> values)
Sets the value of a
RMProperty instance whose data type is
DataType.Binary and whose cardinality is multi-valued. |
void |
setBooleanValue(java.lang.Boolean value)
Sets the value of a
RMProperty instance whose data type is
DataType.Boolean . |
void |
setBooleanValue(java.util.List<java.lang.Boolean> values)
Sets the value of a
RMProperty instance whose data type is
DataType.Boolean and whose cardinality is multi-valued. |
void |
setDateTimeValue(java.util.Date value)
Sets the value of a
RMProperty instance whose data type is
DataType.DateTime . |
void |
setDateTimeValue(java.util.List<java.util.Date> values)
Sets the value of a
RMProperty instance whose data type is
DataType.DateTime and whose cardinality is multi-valued. |
void |
setDoubleValue(java.lang.Double value)
Sets the value of a
RMProperty instance whose data type is
DataType.Double . |
void |
setDoubleValue(java.util.List<java.lang.Double> value)
Sets the value of a
RMProperty instance whose data type is
DataType.Double and whose cardinality is multi-valued. |
void |
setGuidValue(java.util.List<java.lang.String> values)
Sets the value of a
RMProperty instance whose data type is
DataType.Guid and whose cardinality is multi-valued. |
void |
setGuidValue(java.lang.String value)
Sets the value of a
RMProperty instance whose data type is
DataType.Guid . |
void |
setIntegerValue(java.lang.Integer value)
Sets the value of a
RMProperty instance whose data type is
DataType.Integer . |
void |
setIntegerValue(java.util.List<java.lang.Integer> value)
Sets the value of a
RMProperty instance whose data type is
DataType.Integer and whose cardinality is multi-valued. |
void |
setObjectValue(java.util.List<java.lang.Object> values)
Sets the value of a
RMProperty instance whose data type is
DataType.Object and whose cardinality is multi-valued. |
void |
setObjectValue(java.lang.Object value)
Sets the value of a
RMProperty instance whose data type is
DataType.Object . |
void |
setStringValue(java.util.List<java.lang.String> values)
Sets the value of a
RMProperty instance whose data type is
DataType.String and whose cardinality is multi-valued. |
void |
setStringValue(java.lang.String value)
Sets the value of a
RMProperty instance whose data type is
DataType.String . |
java.lang.String getSymbolicName()
String
value.DataType getDataType()
DataType
defined
for this RMProperty
instance.DataType
value.RMCardinality getCardinality()
Cardinality
defined
for this RMProperty
instance.Cardinality
value.boolean isDirty()
true
if the property has been modified, false
otherwise.boolean isSettable()
true
if the property can be set, false
otherwise.void setBinaryValue(byte[] value)
RMProperty
instance whose data type is
DataType.Binary
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a byte[]
. Can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setBinaryValue(java.util.List<byte[]> values)
RMProperty
instance whose data type is
DataType.Binary
and whose cardinality is multi-valued.values
- a List<byte[]>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setBooleanValue(java.lang.Boolean value)
RMProperty
instance whose data type is
DataType.Boolean
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a Boolean
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setBooleanValue(java.util.List<java.lang.Boolean> values)
RMProperty
instance whose data type is
DataType.Boolean
and whose cardinality is multi-valued.values
- a List<Boolean>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setDateTimeValue(java.util.Date value)
RMProperty
instance whose data type is
DataType.DateTime
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a Date
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setDateTimeValue(java.util.List<java.util.Date> values)
RMProperty
instance whose data type is
DataType.DateTime
and whose cardinality is multi-valued.values
- a List<Date>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setDoubleValue(java.lang.Double value)
RMProperty
instance whose data type is
DataType.Double
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a Double
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setDoubleValue(java.util.List<java.lang.Double> value)
RMProperty
instance whose data type is
DataType.Double
and whose cardinality is multi-valued.value
- a List<Double>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setGuidValue(java.lang.String value)
RMProperty
instance whose data type is
DataType.Guid
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a Guid String
. Can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setGuidValue(java.util.List<java.lang.String> values)
RMProperty
instance whose data type is
DataType.Guid
and whose cardinality is multi-valued.values
- a Guid List<String>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setIntegerValue(java.lang.Integer value)
RMProperty
instance whose data type is
DataType.Integer
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a Integer
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setIntegerValue(java.util.List<java.lang.Integer> value)
RMProperty
instance whose data type is
DataType.Integer
and whose cardinality is multi-valued.value
- a List<Integer>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setObjectValue(java.lang.Object value)
RMProperty
instance whose data type is
DataType.Object
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- an Object
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setObjectValue(java.util.List<java.lang.Object> values)
RMProperty
instance whose data type is
DataType.Object
and whose cardinality is multi-valued.
This method is NOT supported for P8 Content Engine repositories.
values
- a List<Object>
. This entry can be null
or empty.API_OPERATION_NOT_SUPPORTED
- this method is NOT supported for P8 Content Engine repositories.void setStringValue(java.lang.String value)
RMProperty
instance whose data type is
DataType.String
. This method is applicable to a property of single-valued
cardinality or a multi-valued property whose value
contains a single member.value
- a String
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.void setStringValue(java.util.List<java.lang.String> values)
RMProperty
instance whose data type is
DataType.String
and whose cardinality is multi-valued.values
- a List<String>
. This entry can be null
or empty.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.RAL_PROPERTY_SET_ERROR
- for any value handling error.byte[] getBinaryValue()
RMProperty
of data type DataType.Binary
and cardinality single-valued.byte[]
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<byte[]> getBinaryListValue()
RMProperty
of data type DataType.Binary
and cardinality multi-valued.List<byte[]>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.Boolean getBooleanValue()
RMProperty
of data type DataType.Boolean
and cardinality single-valued.Boolean
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.lang.Boolean> getBooleanListValue()
RMProperty
of data type DataType.Boolean
and cardinality multi-valued.List<Boolean>
. This entry can be null
.java.util.Date getDateTimeValue()
RMProperty
of data type DataType.DateTime
and cardinality single-valued.Date
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.util.Date> getDateTimeListValue()
RMProperty
of data type DataType.DateTime
and cardinality multi-valued.List<Date>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.Double getDoubleValue()
RMProperty
of data type DataType.Double
and cardinality single-valued.Double
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.lang.Double> getDoubleListValue()
RMProperty
of data type DataType.Double
and cardinality multi-valued.List<Double>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.String getGuidValue()
RMProperty
of data type DataType.Guid
and cardinality single-valued.String
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.lang.String> getGuidListValue()
RMProperty
of data type DataType.Guid
and cardinality multi-valued.List<String>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.Integer getIntegerValue()
RMProperty
of data type DataType.Integer
and cardinality single-valued.Integer
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.lang.Integer> getIntegerListValue()
RMProperty
of data type DataType.Integer
and cardinality multi-valued.List<Integer>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.Object getObjectValue()
RMProperty
of data type DataType.Object
and cardinality single-valued.Object
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.util.List<java.lang.Object> getObjectListValue()
RMProperty
of data type DataType.Object
and cardinality multi-valued.List<Object>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.java.lang.String getStringValue()
RMProperty
of data type DataType.String
and cardinality single-valued.
As a convenience, this method will attempt to return a
string-version of a non-DataType.String
-type scalar
property when possible.
String
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued or not easily represented as a String type.java.util.List<java.lang.String> getStringListValue()
RMProperty
of data type DataType.String
and cardinality multi-valued.List<String>
. This entry can be null
.API_INVALID_PROPERTY_DATATYPE
- if this RMProperty
does not support this data type.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.