public interface RMProperties extends java.lang.Iterable<RMProperty>
RMProperty
instances.
The RMProperties
collection for an entity can be acquired using the
entity's getProperties
method.
Any changes to a RMProperties
collection or any of its contained
RMProperty
instances are not persisted until the corresponding entity is saved
using its Persistable.save
method.
Modifier and Type | Method and Description |
---|---|
void |
add(RMProperties properties)
Each
RMProperty member of the given RMProperties collection is added
(or updated) to this RMProperties collection. |
void |
add(RMProperty property)
Adds (or updates) the specified
RMProperty instance to this RMProperties
collection. |
void |
add(java.lang.String symbolicName,
DataType dataType,
RMCardinality cardinality,
java.lang.Object value)
Adds (or updates) a new
RMProperty to this collection. |
RMProperty |
get(java.lang.String symbolicName)
Returns the
RMProperty as
specified by its symbolic name string. |
java.util.List<byte[]> |
getBinaryListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Binary value. |
byte[] |
getBinaryValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Binary value. |
java.util.List<java.lang.Boolean> |
getBooleanListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Boolean value. |
java.lang.Boolean |
getBooleanValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Boolean value. |
java.util.List<java.util.Date> |
getDateTimeListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.DateTime value. |
java.util.Date |
getDateTimeValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.DateTime value. |
java.util.List<java.lang.Double> |
getDoubleListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Double value. |
java.lang.Double |
getDoubleValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Double value. |
java.util.List<java.lang.String> |
getGuidListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Guid value. |
java.lang.String |
getGuidValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Guid value. |
java.util.List<java.lang.Integer> |
getIntegerListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Integer value. |
java.lang.Integer |
getIntegerValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Integer value. |
java.util.List<java.lang.Object> |
getObjectListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.Object value. |
java.lang.Object |
getObjectValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.Object value. |
java.util.List<java.lang.String> |
getStringListValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its multi-valued,
DataType.String value. |
java.lang.String |
getStringValue(java.lang.String symbolicName)
Locates a property in this collection by its symbolic name
and returns its single-valued,
DataType.String value. |
boolean |
isDirty()
Indicates if this property collection has been modified since the last time that
its corresponding repository entity has been saved.
|
boolean |
isPropertyPresent(java.lang.String symbolicName)
Indicates if the collection contains a
RMProperty
instance corresponding to the specified symbolic name. |
void |
putBinaryListValue(java.lang.String symbolicName,
java.util.List<byte[]> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Binary based
on the specified symbolic name. |
void |
putBinaryValue(java.lang.String symbolicName,
byte[] value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Binary based
on the specified symbolic name. |
void |
putBooleanListValue(java.lang.String symbolicName,
java.util.List<java.lang.Boolean> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Boolean based
on the specified symbolic name. |
void |
putBooleanValue(java.lang.String symbolicName,
java.lang.Boolean value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Boolean based
on the specified symbolic name. |
void |
putDateTimeListValue(java.lang.String symbolicName,
java.util.List<java.util.Date> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.DateTime based
on the specified symbolic name. |
void |
putDateTimeValue(java.lang.String symbolicName,
java.util.Date value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.DateTime based
on the specified symbolic name. |
void |
putDoubleListValue(java.lang.String symbolicName,
java.util.List<java.lang.Double> value)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Double based
on the specified symbolic name. |
void |
putDoubleValue(java.lang.String symbolicName,
java.lang.Double value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Double based
on the specified symbolic name. |
void |
putGuidListValue(java.lang.String symbolicName,
java.util.List<java.lang.String> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Guid based
on the specified symbolic name. |
void |
putGuidValue(java.lang.String symbolicName,
java.lang.String value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Guid based
on the specified symbolic name. |
void |
putIntegerListValue(java.lang.String symbolicName,
java.util.List<java.lang.Integer> value)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Integer based
on the specified symbolic name. |
void |
putIntegerValue(java.lang.String symbolicName,
java.lang.Integer value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Integer based
on the specified symbolic name. |
void |
putObjectListValue(java.lang.String symbolicName,
java.util.List<java.lang.Object> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.Object based
on the specified symbolic name. |
void |
putObjectValue(java.lang.String symbolicName,
java.lang.Object value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.Object based
on the specified symbolic name. |
void |
putStringListValue(java.lang.String symbolicName,
java.util.List<java.lang.String> values)
Adds a new property to this collection or updates an existing property of
this collection of type multi-valued
DataType.String based
on the specified symbolic name. |
void |
putStringValue(java.lang.String symbolicName,
java.lang.String value)
Adds a new property to this collection or updates an existing property of
this collection of type single-valued
DataType.String based
on the specified symbolic name. |
void |
remove(java.lang.String symbolicName)
Removes the specified
RMProperty
from this collection. |
void |
remove(java.lang.String[] symbolicNames)
Removes the specified
RMProperty instances
from this collection as specified by their individual symbolic name. |
int |
size()
Returns the current number of property instances in this collection.
|
RMProperty[] |
toArray()
Returns an array containing the contents of the property collection.
|
void add(java.lang.String symbolicName, DataType dataType, RMCardinality cardinality, java.lang.Object value)
RMProperty
to this collection. If the collection already
contains a property with the same symbolic name, then the existing instance is
updated with the new property value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
nor blank.dataType
- the DataType
of the new property.
This entry cannot be null
.cardinality
- the RMCardinality
of the new property.
This entry cannot be null
.value
- the value for the new property. This parameter's type must match with
the property's specified data type and cardinality value.
For example, a List<Boolean> value cannot be assigned to a single-valued
DateTime property.
This parameter can be null
to ensure that the
persisted value of the corresponding property is set to null
.void add(RMProperty property)
RMProperty
instance to this RMProperties
collection. If the collection already contains a property with the same symbolic name,
then the existing instance is replaced by the new RMProperty
instance.property
- the RMProperty
instance to add.
This entry cannot be null
.void add(RMProperties properties)
RMProperty
member of the given RMProperties
collection is added
(or updated) to this RMProperties
collection.properties
- the RMProperties
collection to add.
This entry cannot be null
.boolean isDirty()
true
if the collection has been modified, false
otherwise.boolean isPropertyPresent(java.lang.String symbolicName)
RMProperty
instance corresponding to the specified symbolic name.symbolicName
- the symbolic name of the property in question.
This entry cannot be null
nor blank.true
if a corresponding RMProperty
does exist in this collection, false
otherwise.void remove(java.lang.String symbolicName)
RMProperty
from this collection.symbolicName
- the symbolic name of the property to remove.
This entry cannot be null
nor blank.void remove(java.lang.String[] symbolicNames)
RMProperty
instances
from this collection as specified by their individual symbolic name.symbolicNames
- a String
array of the symbolic names of the properties to remove.
This entry cannot be null
.int size()
int
value.RMProperty[] toArray()
RMProperty
instances.RMProperty get(java.lang.String symbolicName)
RMProperty
as
specified by its symbolic name string.symbolicName
- the symbolic name value for the desired property.
This entry cannot be null
or blank.RMProperty
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides
this collection.void putBinaryValue(java.lang.String symbolicName, byte[] value)
DataType.Binary
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a byte[]
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putBinaryListValue(java.lang.String symbolicName, java.util.List<byte[]> values)
DataType.Binary
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a List<byte[]>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putBooleanValue(java.lang.String symbolicName, java.lang.Boolean value)
DataType.Boolean
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a Boolean
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putBooleanListValue(java.lang.String symbolicName, java.util.List<java.lang.Boolean> values)
DataType.Boolean
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a List<Boolean>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putDateTimeValue(java.lang.String symbolicName, java.util.Date value)
DataType.DateTime
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a Date
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putDateTimeListValue(java.lang.String symbolicName, java.util.List<java.util.Date> values)
DataType.DateTime
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a List<Date>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putDoubleValue(java.lang.String symbolicName, java.lang.Double value)
DataType.Double
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a Double
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putDoubleListValue(java.lang.String symbolicName, java.util.List<java.lang.Double> value)
DataType.Double
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a List<Double>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putGuidValue(java.lang.String symbolicName, java.lang.String value)
DataType.Guid
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a GUID String
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putGuidListValue(java.lang.String symbolicName, java.util.List<java.lang.String> values)
DataType.Guid
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a GUID List<String>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putIntegerValue(java.lang.String symbolicName, java.lang.Integer value)
DataType.Integer
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- an Integer
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putIntegerListValue(java.lang.String symbolicName, java.util.List<java.lang.Integer> value)
DataType.Integer
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a List<Integer>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putObjectValue(java.lang.String symbolicName, java.lang.Object value)
DataType.Object
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- an Object
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putObjectListValue(java.lang.String symbolicName, java.util.List<java.lang.Object> values)
DataType.Object
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a List<Object>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putStringValue(java.lang.String symbolicName, java.lang.String value)
DataType.String
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.value
- a String
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.void putStringListValue(java.lang.String symbolicName, java.util.List<java.lang.String> values)
DataType.String
based
on the specified symbolic name.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.values
- a List<String>
.
This entry can be null
.RAL_PROPERTY_ADD_ERROR
- for any value handling error.byte[] getBinaryValue(java.lang.String symbolicName)
DataType.Binary
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.byte[]
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Binary
type.java.util.List<byte[]> getBinaryListValue(java.lang.String symbolicName)
DataType.Binary
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<byte[]>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Binary
type.java.lang.Boolean getBooleanValue(java.lang.String symbolicName)
DataType.Boolean
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.Boolean
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Boolean
type.java.util.List<java.lang.Boolean> getBooleanListValue(java.lang.String symbolicName)
DataType.Boolean
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<Boolean>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Boolean
type.java.util.Date getDateTimeValue(java.lang.String symbolicName)
DataType.DateTime
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.Date
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.DateTime
type.java.util.List<java.util.Date> getDateTimeListValue(java.lang.String symbolicName)
DataType.DateTime
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<Date>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.DateTime
type.java.lang.Double getDoubleValue(java.lang.String symbolicName)
DataType.Double
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.Double
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Double
type.java.util.List<java.lang.Double> getDoubleListValue(java.lang.String symbolicName)
DataType.Double
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<Double>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Double
type.java.lang.String getGuidValue(java.lang.String symbolicName)
DataType.Guid
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.String
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Guid
type.java.util.List<java.lang.String> getGuidListValue(java.lang.String symbolicName)
DataType.Guid
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<String>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Guid
type.java.lang.Integer getIntegerValue(java.lang.String symbolicName)
DataType.Integer
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.Integer
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Integer
type.java.util.List<java.lang.Integer> getIntegerListValue(java.lang.String symbolicName)
DataType.Integer
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<Integer>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Integer
type.java.lang.Object getObjectValue(java.lang.String symbolicName)
DataType.Object
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.Object
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not single-valued, DataType.Object
type.java.util.List<java.lang.Object> getObjectListValue(java.lang.String symbolicName)
DataType.Object
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<Object>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.Object
type.java.lang.String getStringValue(java.lang.String symbolicName)
DataType.String
value.
As a convenience, this method will attempt to return a
string-version of a non-DataType.String
-type scalar
property when possible.
symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.String
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.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(java.lang.String symbolicName)
DataType.String
value.symbolicName
- the symbolic name String
of the property.
This entry cannot be null
or blank.List<String>
.
This entry can be null
.API_PROPERTY_NOT_IN_CACHE
- if no such property currently resides in this collection.API_INVALID_PROPERTY_DATATYPE
- if property is not multi-valued, DataType.String
type.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.