com.filenet.api.property
Interface Properties
-
- All Superinterfaces:
- java.io.Serializable
public interface Properties extends java.io.Serializable
Represents a collection ofProperty
values that you can manipulate.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Property
find(java.lang.String propertyName)
Returns theProperty
object specified by name in thisProperties
collection.Property
get(java.lang.String propertyName)
Returns theProperty
object specified by name in thisProperties
collection.BinaryList
getBinaryListValue(java.lang.String propertyName)
Locates aPropertyBinaryList
property by name in thisProperties
collection and returns the value it holds.byte[]
getBinaryValue(java.lang.String propertyName)
Locates aPropertyBinary
property by name in thisProperties
collection and returns the value it holds.BooleanList
getBooleanListValue(java.lang.String propertyName)
Locates aPropertyBooleanList
property by name in thisProperties
collection and returns the value it holds.java.lang.Boolean
getBooleanValue(java.lang.String propertyName)
Locates aPropertyBoolean
property by name in thisProperties
collection and returns the value it holds.DateTimeList
getDateTimeListValue(java.lang.String propertyName)
Locates aPropertyDateTimeList
property by name in thisProperties
collection and returns the value it holds.java.util.Date
getDateTimeValue(java.lang.String propertyName)
Locates aPropertyDateTime
property by name in thisProperties
collection and returns the value it holds.DependentObjectList
getDependentObjectListValue(java.lang.String propertyName)
Locates aPropertyDependentObjectList
property by name in thisProperties
collection and returns the value it holds.EngineObject
getEngineObjectValue(java.lang.String propertyName)
Locates aPropertyEngineObject
property by name in thisProperties
collection and returns the value it holds.Float64List
getFloat64ListValue(java.lang.String propertyName)
Locates aPropertyFloat64List
property by name in thisProperties
collection and returns the value it holds.java.lang.Double
getFloat64Value(java.lang.String propertyName)
Locates aPropertyFloat64
property by name in thisProperties
collection and returns the value it holds.IdList
getIdListValue(java.lang.String propertyName)
Locates aPropertyIdList
property by name in thisProperties
collection and returns the value it holds.Id
getIdValue(java.lang.String propertyName)
Locates aPropertyId
property by name in thisProperties
collection and returns the value it holds.IndependentObjectSet
getIndependentObjectSetValue(java.lang.String propertyName)
Locates aPropertyIndependentObjectSet
property by name in thisProperties
collection and returns the value it holds.java.io.InputStream
getInputStreamValue(java.lang.String propertyName)
Locates aPropertyContent
property by name in thisProperties
collection and returns the value it holds.Integer32List
getInteger32ListValue(java.lang.String propertyName)
Locates aPropertyInteger32List
property by name in thisProperties
collection and returns the value it holds.java.lang.Integer
getInteger32Value(java.lang.String propertyName)
Locates aPropertyInteger32
property by name in thisProperties
collection and returns the value it holds.java.lang.Object
getObjectValue(java.lang.String propertyName)
Locates a property by name in thisProperties
collection and returns the value it holds.StringList
getStringListValue(java.lang.String propertyName)
Locates aPropertyStringList
property by name in thisProperties
collection and returns the value it holds.java.lang.String
getStringValue(java.lang.String propertyName)
Locates aPropertyString
property by name in thisProperties
collection and returns the value it holds.boolean
isDirty()
Specifies whether thisProperties
collection has changed since it was last saved (true
) or not (false
).boolean
isPropertyPresent(java.lang.String propertyName)
Returns whether thisProperties
collection holds aProperty
instance having the given property name (true
) or not (false
).java.util.Iterator
iterator()
Returns a JavaIterator
object that provides methods necessary to enumerate through a series of elements in a collection.void
putObjectValue(java.lang.String propertyName, java.lang.Object value)
Creates or updates aProperty
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, BinaryList value)
Creates or updates aPropertyBinaryList
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, boolean value)
Creates or updates aPropertyBoolean
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.lang.Boolean value)
Creates or updates aPropertyBoolean
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, BooleanList value)
Creates or updates aPropertyBooleanList
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, byte[] value)
Creates or updates aPropertyBinary
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.util.Date value)
Creates or updates aPropertyDateTime
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, DateTimeList value)
Creates or updates aPropertyDateTimeList
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, DependentObjectList value)
Creates or updates aPropertyDependentObjectList
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, double value)
Creates or updates aPropertyFloat64
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.lang.Double value)
Creates or updates aPropertyFloat64
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, EngineObject value)
Creates or updates aPropertyEngineObject
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, Float64List value)
Creates or updates aPropertyFloat64List
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, Id value)
Creates or updates aPropertyId
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, IdList value)
Creates or updates aPropertyIdList
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, IndependentObjectSet value)
Creates or updates aPropertyIndependentObjectSet
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.io.InputStream value)
Creates or updates aPropertyContent
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, int value)
Creates or updates aPropertyInteger32
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.lang.Integer value)
Creates or updates aPropertyInteger32
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, Integer32List value)
Creates or updates aPropertyInteger32List
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, java.lang.String value)
Creates or updates aPropertyString
instance in thisProperties
collection.void
putValue(java.lang.String propertyName, StringList value)
Creates or updates aPropertyStringList
instance in thisProperties
collection.void
removeFromCache(java.lang.String propertyName)
Removes theProperty
object specified by name from thisProperties
collection cache.void
removeFromCache(java.lang.String[] propertyNames)
Removes theProperty
objects specified by their names in aString
array from thisProperties
collection cache.int
size()
Returns the number ofProperty
objects in thisProperties
collection.Property[]
toArray()
Provides a means of traversing the property instances held in the collection using a positional value.void
updateDependentObjectListValue(java.lang.String propertyName, DependentObjectList value)
Applies a value to a dependent object list property in such a way that the supplied list is treated as a set of deltas to the existing stored values or to the default list applied during creation.
-
-
-
Method Detail
-
iterator
java.util.Iterator iterator()
Returns a JavaIterator
object that provides methods necessary to enumerate through a series of elements in a collection. There are no guarantees concerning the order in which the elements are returned.- Returns:
- A Java
Iterator
object.
-
size
int size()
Returns the number ofProperty
objects in thisProperties
collection.- Returns:
- An
int
specifying the number of elements in the collection.
-
get
Property get(java.lang.String propertyName)
Returns theProperty
object specified by name in thisProperties
collection.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Property
object. - Throws:
API_PROPERTY_NOT_IN_CACHE
- if the property cannot be found.
-
find
Property find(java.lang.String propertyName)
Returns theProperty
object specified by name in thisProperties
collection.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Property
object, or null if the property is not present.
-
isPropertyPresent
boolean isPropertyPresent(java.lang.String propertyName)
Returns whether thisProperties
collection holds aProperty
instance having the given property name (true
) or not (false
).- Parameters:
propertyName
- AString
specifying a property name.- Returns:
true
if a property with the given name is found; otherwise, returnsfalse
.
-
isDirty
boolean isDirty()
Specifies whether thisProperties
collection has changed since it was last saved (true
) or not (false
).- Returns:
true
if the value of the collection has changed; otherwise, returnsfalse
.
-
removeFromCache
void removeFromCache(java.lang.String propertyName)
Removes theProperty
object specified by name from thisProperties
collection cache. Note that theProperties
collection on the server remains unchanged. Properties are only removed from the local properties cache.- Parameters:
propertyName
- AString
specifying the name of the property to remove.
-
removeFromCache
void removeFromCache(java.lang.String[] propertyNames)
Removes theProperty
objects specified by their names in aString
array from thisProperties
collection cache. Note that theProperties
collection on the server remains unchanged. Properties are only removed from the local properties cache.- Parameters:
propertyNames
- AString
array specifying the names of the properties to remove.
-
toArray
Property[] toArray()
Provides a means of traversing the property instances held in the collection using a positional value.- Returns:
- A
Property
array containing all of the properties in theProperties
collection.
-
putObjectValue
void putObjectValue(java.lang.String propertyName, java.lang.Object value)
Creates or updates aProperty
instance in thisProperties
collection. The type ofProperty
created or updated is determined by the object type of thevalue
parameter. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- Anobject
specifying the value of a new or an existing property. The following object values are allowed. You can also pass a null value.Boolean
(PropertyBoolean
value)byte
array (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 the type of object specified byvalue
does not have a supported property type or does not match the property being updated.E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.lang.String value)
Creates or updates aPropertyString
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- AString
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.util.Date value)
Creates or updates aPropertyDateTime
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- ADate
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Integer value)
Creates or updates aPropertyInteger32
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- AnInteger
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, int value)
Creates or updates aPropertyInteger32
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- Anint
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Boolean value)
Creates or updates aPropertyBoolean
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- ABoolean
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, boolean value)
Creates or updates aPropertyBoolean
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- Aboolean
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Double value)
Creates or updates aPropertyFloat64
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- ADouble
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, double value)
Creates or updates aPropertyFloat64
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- Adouble
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, byte[] value)
Creates or updates aPropertyBinary
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- Abyte
array specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, Id value)
Creates or updates aPropertyId
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- AnId
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, EngineObject value)
Creates or updates aPropertyEngineObject
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- AnEngineObject
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, DependentObjectList value)
Creates or updates aPropertyDependentObjectList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- ADependentObjectList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, IndependentObjectSet value)
Creates or updates aPropertyIndependentObjectSet
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- AnIndependentObjectSet
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, StringList value)
Creates or updates aPropertyStringList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- AStringList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, BooleanList value)
Creates or updates aPropertyBooleanList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- ABooleanList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, Integer32List value)
Creates or updates aPropertyInteger32List
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- AnInteger32List
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, Float64List value)
Creates or updates aPropertyFloat64List
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- AFloat64List
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, DateTimeList value)
Creates or updates aPropertyDateTimeList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- ADateTimeList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, BinaryList value)
Creates or updates aPropertyBinaryList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- ABinaryList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, IdList value)
Creates or updates aPropertyIdList
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided; however, if the existing property already references the same object that is specified byvalue
, this method will be ignored.- Parameters:
propertyName
- AString
specifying a property name.value
- AnIdList
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
putValue
void putValue(java.lang.String propertyName, java.io.InputStream value)
Creates or updates aPropertyContent
instance in thisProperties
collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName
- AString
specifying a property name.value
- AnInputStream
specifying the value of a new or an existing property.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
getObjectValue
java.lang.Object getObjectValue(java.lang.String propertyName)
Locates a property by name in thisProperties
collection and returns the value it holds. If the property holds a reference object (Property.PropertyState
=REFERENCE
) or or is unevaluated (Property.PropertyState
=UNEVALUATED
), a round-trip is made to the server to fetch its value.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
Object
specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeException
object will be returned. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or a retrieval error has occurred (Property.PropertyState
=RETRIEVAL_ERROR
).- See Also:
PropertyState
-
getStringValue
java.lang.String getStringValue(java.lang.String propertyName)
Locates aPropertyString
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
String
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyString
instance.
-
getDateTimeValue
java.util.Date getDateTimeValue(java.lang.String propertyName)
Locates aPropertyDateTime
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Date
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyDateTime
instance.
-
getInteger32Value
java.lang.Integer getInteger32Value(java.lang.String propertyName)
Locates aPropertyInteger32
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
Integer
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyInteger32
instance.
-
getBooleanValue
java.lang.Boolean getBooleanValue(java.lang.String propertyName)
Locates aPropertyBoolean
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Boolean
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyBoolean
instance.
-
getFloat64Value
java.lang.Double getFloat64Value(java.lang.String propertyName)
Locates aPropertyFloat64
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Double
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyFloat64
instance.
-
getBinaryValue
byte[] getBinaryValue(java.lang.String propertyName)
Locates aPropertyBinary
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
byte
array specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyBinary
instance.
-
getIdValue
Id getIdValue(java.lang.String propertyName)
Locates aPropertyId
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
Id
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyId
instance.
-
getEngineObjectValue
EngineObject getEngineObjectValue(java.lang.String propertyName)
Locates aPropertyEngineObject
property by name in thisProperties
collection and returns the value it holds. If the property holds a reference object (Property.PropertyState
=REFERENCE
) or or is unevaluated (Property.PropertyState
=UNEVALUATED
), a round-trip is made to the server to fetch its value.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
EngineObject
specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeException
object will be returned. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection, is not aPropertyEngineObject
instance, or a retrieval error has occurred (Property.PropertyState
=RETRIEVAL_ERROR
).- See Also:
PropertyState
-
getDependentObjectListValue
DependentObjectList getDependentObjectListValue(java.lang.String propertyName)
Locates aPropertyDependentObjectList
property by name in thisProperties
collection and returns the value it holds. If the property holds a reference object (Property.PropertyState
=REFERENCE
) or or is unevaluated (Property.PropertyState
=UNEVALUATED
), a round-trip is made to the server to fetch its value.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
DependentEngineObjectList
collection specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeException
object will be returned. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection, is not aPropertyDependentObjectList
instance, or a retrieval error has occurred (Property.PropertyState
=RETRIEVAL_ERROR
).- See Also:
PropertyState
-
getIndependentObjectSetValue
IndependentObjectSet getIndependentObjectSetValue(java.lang.String propertyName)
Locates aPropertyIndependentObjectSet
property by name in thisProperties
collection and returns the value it holds. If the property holds a reference object (Property.PropertyState
=REFERENCE
) or or is unevaluated (Property.PropertyState
=UNEVALUATED
), a round-trip is made to the server to fetch its value.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
IndependentObjectSet
collection specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeException
object will be returned. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection, is not aPropertyIndependentObjectSet
instance, or a retrieval error has occurred (Property.PropertyState
=RETRIEVAL_ERROR
).- See Also:
PropertyState
-
getStringListValue
StringList getStringListValue(java.lang.String propertyName)
Locates aPropertyStringList
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
StringList
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyStringList
instance.
-
getBooleanListValue
BooleanList getBooleanListValue(java.lang.String propertyName)
Locates aPropertyBooleanList
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
BooleanList
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyBooleanList
instance.
-
getInteger32ListValue
Integer32List getInteger32ListValue(java.lang.String propertyName)
Locates aPropertyInteger32List
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
Integer32List
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyInteger32List
instance.
-
getFloat64ListValue
Float64List getFloat64ListValue(java.lang.String propertyName)
Locates aPropertyFloat64List
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
Float64List
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyFloat64List
instance.
-
getDateTimeListValue
DateTimeList getDateTimeListValue(java.lang.String propertyName)
Locates aPropertyDateTimeList
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
DateTimeList
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyDateTimeList
instance.
-
getBinaryListValue
BinaryList getBinaryListValue(java.lang.String propertyName)
Locates aPropertyBinaryList
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- A
BinaryList
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyBinaryList
instance.
-
getIdListValue
IdList getIdListValue(java.lang.String propertyName)
Locates aPropertyIdList
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
IdList
collection specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyIdList
instance.
-
getInputStreamValue
java.io.InputStream getInputStreamValue(java.lang.String propertyName)
Locates aPropertyContent
property by name in thisProperties
collection and returns the value it holds.- Parameters:
propertyName
- AString
specifying a property name.- Returns:
- An
InputStream
specifying the value of the property. - Throws:
EngineRuntimeException
- if the property cannot be found in the collection or is not aPropertyContent
instance.
-
updateDependentObjectListValue
void updateDependentObjectListValue(java.lang.String propertyName, DependentObjectList value)
Applies a value to a dependent object list property in such a way that the supplied list is treated as a set of deltas to the existing stored values or to the default list applied during creation.- Parameters:
propertyName
- AString
specifying a property name.value
- TheDependentObjectList
to be applied.
-
-