com.filenet.api.property
Interface Properties
-
- All Superinterfaces:
- java.io.Serializable
public interface Properties extends java.io.SerializableRepresents a collection ofPropertyvalues that you can manipulate.
-
-
Method Summary
Methods Modifier and Type Method and Description Propertyfind(java.lang.String propertyName)Returns thePropertyobject specified by name in thisPropertiescollection.Propertyget(java.lang.String propertyName)Returns thePropertyobject specified by name in thisPropertiescollection.BinaryListgetBinaryListValue(java.lang.String propertyName)Locates aPropertyBinaryListproperty by name in thisPropertiescollection and returns the value it holds.byte[]getBinaryValue(java.lang.String propertyName)Locates aPropertyBinaryproperty by name in thisPropertiescollection and returns the value it holds.BooleanListgetBooleanListValue(java.lang.String propertyName)Locates aPropertyBooleanListproperty by name in thisPropertiescollection and returns the value it holds.java.lang.BooleangetBooleanValue(java.lang.String propertyName)Locates aPropertyBooleanproperty by name in thisPropertiescollection and returns the value it holds.DateTimeListgetDateTimeListValue(java.lang.String propertyName)Locates aPropertyDateTimeListproperty by name in thisPropertiescollection and returns the value it holds.java.util.DategetDateTimeValue(java.lang.String propertyName)Locates aPropertyDateTimeproperty by name in thisPropertiescollection and returns the value it holds.DependentObjectListgetDependentObjectListValue(java.lang.String propertyName)Locates aPropertyDependentObjectListproperty by name in thisPropertiescollection and returns the value it holds.EngineObjectgetEngineObjectValue(java.lang.String propertyName)Locates aPropertyEngineObjectproperty by name in thisPropertiescollection and returns the value it holds.Float64ListgetFloat64ListValue(java.lang.String propertyName)Locates aPropertyFloat64Listproperty by name in thisPropertiescollection and returns the value it holds.java.lang.DoublegetFloat64Value(java.lang.String propertyName)Locates aPropertyFloat64property by name in thisPropertiescollection and returns the value it holds.IdListgetIdListValue(java.lang.String propertyName)Locates aPropertyIdListproperty by name in thisPropertiescollection and returns the value it holds.IdgetIdValue(java.lang.String propertyName)Locates aPropertyIdproperty by name in thisPropertiescollection and returns the value it holds.IndependentObjectSetgetIndependentObjectSetValue(java.lang.String propertyName)Locates aPropertyIndependentObjectSetproperty by name in thisPropertiescollection and returns the value it holds.java.io.InputStreamgetInputStreamValue(java.lang.String propertyName)Locates aPropertyContentproperty by name in thisPropertiescollection and returns the value it holds.Integer32ListgetInteger32ListValue(java.lang.String propertyName)Locates aPropertyInteger32Listproperty by name in thisPropertiescollection and returns the value it holds.java.lang.IntegergetInteger32Value(java.lang.String propertyName)Locates aPropertyInteger32property by name in thisPropertiescollection and returns the value it holds.java.lang.ObjectgetObjectValue(java.lang.String propertyName)Locates a property by name in thisPropertiescollection and returns the value it holds.StringListgetStringListValue(java.lang.String propertyName)Locates aPropertyStringListproperty by name in thisPropertiescollection and returns the value it holds.java.lang.StringgetStringValue(java.lang.String propertyName)Locates aPropertyStringproperty by name in thisPropertiescollection and returns the value it holds.booleanisDirty()Specifies whether thisPropertiescollection has changed since it was last saved (true) or not (false).booleanisPropertyPresent(java.lang.String propertyName)Returns whether thisPropertiescollection holds aPropertyinstance having the given property name (true) or not (false).java.util.Iteratoriterator()Returns a JavaIteratorobject that provides methods necessary to enumerate through a series of elements in a collection.voidputObjectValue(java.lang.String propertyName, java.lang.Object value)Creates or updates aPropertyinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, BinaryList value)Creates or updates aPropertyBinaryListinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, boolean value)Creates or updates aPropertyBooleaninstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.lang.Boolean value)Creates or updates aPropertyBooleaninstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, BooleanList value)Creates or updates aPropertyBooleanListinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, byte[] value)Creates or updates aPropertyBinaryinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.util.Date value)Creates or updates aPropertyDateTimeinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, DateTimeList value)Creates or updates aPropertyDateTimeListinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, DependentObjectList value)Creates or updates aPropertyDependentObjectListinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, double value)Creates or updates aPropertyFloat64instance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.lang.Double value)Creates or updates aPropertyFloat64instance in thisPropertiescollection.voidputValue(java.lang.String propertyName, EngineObject value)Creates or updates aPropertyEngineObjectinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, Float64List value)Creates or updates aPropertyFloat64Listinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, Id value)Creates or updates aPropertyIdinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, IdList value)Creates or updates aPropertyIdListinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, IndependentObjectSet value)Creates or updates aPropertyIndependentObjectSetinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.io.InputStream value)Creates or updates aPropertyContentinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, int value)Creates or updates aPropertyInteger32instance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.lang.Integer value)Creates or updates aPropertyInteger32instance in thisPropertiescollection.voidputValue(java.lang.String propertyName, Integer32List value)Creates or updates aPropertyInteger32Listinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, java.lang.String value)Creates or updates aPropertyStringinstance in thisPropertiescollection.voidputValue(java.lang.String propertyName, StringList value)Creates or updates aPropertyStringListinstance in thisPropertiescollection.voidremoveFromCache(java.lang.String propertyName)Removes thePropertyobject specified by name from thisPropertiescollection cache.voidremoveFromCache(java.lang.String[] propertyNames)Removes thePropertyobjects specified by their names in aStringarray from thisPropertiescollection cache.intsize()Returns the number ofPropertyobjects in thisPropertiescollection.Property[]toArray()Provides a means of traversing the property instances held in the collection using a positional value.
-
-
-
Method Detail
-
iterator
java.util.Iterator iterator()
Returns a JavaIteratorobject 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
Iteratorobject.
-
size
int size()
Returns the number ofPropertyobjects in thisPropertiescollection.- Returns:
- An
intspecifying the number of elements in the collection.
-
get
Property get(java.lang.String propertyName)
Returns thePropertyobject specified by name in thisPropertiescollection.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Propertyobject. - Throws:
API_PROPERTY_NOT_IN_CACHE- if the property cannot be found.
-
find
Property find(java.lang.String propertyName)
Returns thePropertyobject specified by name in thisPropertiescollection.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Propertyobject, or null if the property is not present.
-
isPropertyPresent
boolean isPropertyPresent(java.lang.String propertyName)
Returns whether thisPropertiescollection holds aPropertyinstance having the given property name (true) or not (false).- Parameters:
propertyName- AStringspecifying a property name.- Returns:
trueif a property with the given name is found; otherwise, returnsfalse.
-
isDirty
boolean isDirty()
Specifies whether thisPropertiescollection has changed since it was last saved (true) or not (false).- Returns:
trueif the value of the collection has changed; otherwise, returnsfalse.
-
removeFromCache
void removeFromCache(java.lang.String propertyName)
Removes thePropertyobject specified by name from thisPropertiescollection cache. Note that thePropertiescollection on the server remains unchanged. Properties are only removed from the local properties cache.- Parameters:
propertyName- AStringspecifying the name of the property to remove.
-
removeFromCache
void removeFromCache(java.lang.String[] propertyNames)
Removes thePropertyobjects specified by their names in aStringarray from thisPropertiescollection cache. Note that thePropertiescollection on the server remains unchanged. Properties are only removed from the local properties cache.- Parameters:
propertyNames- AStringarray 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
Propertyarray containing all of the properties in thePropertiescollection.
-
putObjectValue
void putObjectValue(java.lang.String propertyName, java.lang.Object value)Creates or updates aPropertyinstance in thisPropertiescollection. The type ofPropertycreated or updated is determined by the object type of thevalueparameter. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- Anobjectspecifying the value of a new or an existing property. The following object values are allowed. You can also pass a null value.Boolean(PropertyBooleanvalue)bytearray (PropertyBinaryvalue)Date(PropertyDateTimevalue)Double(PropertyFloat64value)Id(PropertyIdvalue)Integer(PropertyInteger32value)String(PropertyStringvalue)InputStream(PropertyContentvalue)EngineObject(PropertyEngineObjectvalue)ObjectReference(PropertyEngineObjectvalue)BinaryList(PropertyBinaryListvalue)BooleanList(PropertyBooleanListvalue)DateTimeList(PropertyDateTimeListvalue)DependentObjectList(PropertyDependentObjectListvalue)Float64List(PropertyFloat64Listvalue)IdList(PropertyIdListvalue)IndependentObjectSet(PropertyIndependentObjectSetvalue)Integer32List(PropertyInteger32Listvalue)StringList(PropertyStringListvalue)
- Throws:
API_UNSUPPORTED_PROPERTY_TYPE- if the type of object specified byvaluedoes 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.lang.String value)Creates or updates aPropertyStringinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- AStringspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.util.Date value)Creates or updates aPropertyDateTimeinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- ADatespecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Integer value)Creates or updates aPropertyInteger32instance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- AnIntegerspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, int value)Creates or updates aPropertyInteger32instance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- Anintspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Boolean value)Creates or updates aPropertyBooleaninstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- ABooleanspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, boolean value)Creates or updates aPropertyBooleaninstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- Abooleanspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.lang.Double value)Creates or updates aPropertyFloat64instance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- ADoublespecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, double value)Creates or updates aPropertyFloat64instance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- Adoublespecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, byte[] value)Creates or updates aPropertyBinaryinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- Abytearray 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, Id value)Creates or updates aPropertyIdinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- AnIdspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, EngineObject value)Creates or updates aPropertyEngineObjectinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- AnEngineObjectspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, DependentObjectList value)Creates or updates aPropertyDependentObjectListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- ADependentObjectListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, IndependentObjectSet value)Creates or updates aPropertyIndependentObjectSetinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- AnIndependentObjectSetspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, StringList value)Creates or updates aPropertyStringListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- AStringListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, BooleanList value)Creates or updates aPropertyBooleanListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- ABooleanListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, Integer32List value)Creates or updates aPropertyInteger32Listinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- AnInteger32Listspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, Float64List value)Creates or updates aPropertyFloat64Listinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- AFloat64Listspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, DateTimeList value)Creates or updates aPropertyDateTimeListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- ADateTimeListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, BinaryList value)Creates or updates aPropertyBinaryListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- ABinaryListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, IdList value)Creates or updates aPropertyIdListinstance in thisPropertiescollection. 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- AStringspecifying a property name.value- AnIdListspecifying 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.isSettablemethod returnsfalse).
-
putValue
void putValue(java.lang.String propertyName, java.io.InputStream value)Creates or updates aPropertyContentinstance in thisPropertiescollection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.- Parameters:
propertyName- AStringspecifying a property name.value- AnInputStreamspecifying 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.isSettablemethod returnsfalse).
-
getObjectValue
java.lang.Object getObjectValue(java.lang.String propertyName)
Locates a property by name in thisPropertiescollection 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- AStringspecifying a property name.- Returns:
- An
Objectspecifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeExceptionobject 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 aPropertyStringproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Stringspecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyStringinstance.
-
getDateTimeValue
java.util.Date getDateTimeValue(java.lang.String propertyName)
Locates aPropertyDateTimeproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Datespecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyDateTimeinstance.
-
getInteger32Value
java.lang.Integer getInteger32Value(java.lang.String propertyName)
Locates aPropertyInteger32property by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- An
Integerspecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyInteger32instance.
-
getBooleanValue
java.lang.Boolean getBooleanValue(java.lang.String propertyName)
Locates aPropertyBooleanproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Booleanspecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyBooleaninstance.
-
getFloat64Value
java.lang.Double getFloat64Value(java.lang.String propertyName)
Locates aPropertyFloat64property by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Doublespecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyFloat64instance.
-
getBinaryValue
byte[] getBinaryValue(java.lang.String propertyName)
Locates aPropertyBinaryproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
bytearray specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyBinaryinstance.
-
getIdValue
Id getIdValue(java.lang.String propertyName)
Locates aPropertyIdproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- An
Idspecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyIdinstance.
-
getEngineObjectValue
EngineObject getEngineObjectValue(java.lang.String propertyName)
Locates aPropertyEngineObjectproperty by name in thisPropertiescollection 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- AStringspecifying a property name.- Returns:
- An
EngineObjectspecifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeExceptionobject will be returned. - Throws:
EngineRuntimeException- if the property cannot be found in the collection, is not aPropertyEngineObjectinstance, or a retrieval error has occurred (Property.PropertyState=RETRIEVAL_ERROR).- See Also:
PropertyState
-
getDependentObjectListValue
DependentObjectList getDependentObjectListValue(java.lang.String propertyName)
Locates aPropertyDependentObjectListproperty by name in thisPropertiescollection 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- AStringspecifying a property name.- Returns:
- A
DependentEngineObjectListcollection specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeExceptionobject will be returned. - Throws:
EngineRuntimeException- if the property cannot be found in the collection, is not aPropertyDependentObjectListinstance, or a retrieval error has occurred (Property.PropertyState=RETRIEVAL_ERROR).- See Also:
PropertyState
-
getIndependentObjectSetValue
IndependentObjectSet getIndependentObjectSetValue(java.lang.String propertyName)
Locates aPropertyIndependentObjectSetproperty by name in thisPropertiescollection 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- AStringspecifying a property name.- Returns:
- An
IndependentObjectSetcollection specifying the value of the property. If the property's value cannot be retrieved, anEngineRuntimeExceptionobject will be returned. - Throws:
EngineRuntimeException- if the property cannot be found in the collection, is not aPropertyIndependentObjectSetinstance, or a retrieval error has occurred (Property.PropertyState=RETRIEVAL_ERROR).- See Also:
PropertyState
-
getStringListValue
StringList getStringListValue(java.lang.String propertyName)
Locates aPropertyStringListproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
StringListcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyStringListinstance.
-
getBooleanListValue
BooleanList getBooleanListValue(java.lang.String propertyName)
Locates aPropertyBooleanListproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
BooleanListcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyBooleanListinstance.
-
getInteger32ListValue
Integer32List getInteger32ListValue(java.lang.String propertyName)
Locates aPropertyInteger32Listproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- An
Integer32Listcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyInteger32Listinstance.
-
getFloat64ListValue
Float64List getFloat64ListValue(java.lang.String propertyName)
Locates aPropertyFloat64Listproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
Float64Listcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyFloat64Listinstance.
-
getDateTimeListValue
DateTimeList getDateTimeListValue(java.lang.String propertyName)
Locates aPropertyDateTimeListproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
DateTimeListcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyDateTimeListinstance.
-
getBinaryListValue
BinaryList getBinaryListValue(java.lang.String propertyName)
Locates aPropertyBinaryListproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- A
BinaryListcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyBinaryListinstance.
-
getIdListValue
IdList getIdListValue(java.lang.String propertyName)
Locates aPropertyIdListproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- An
IdListcollection specifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyIdListinstance.
-
getInputStreamValue
java.io.InputStream getInputStreamValue(java.lang.String propertyName)
Locates aPropertyContentproperty by name in thisPropertiescollection and returns the value it holds.- Parameters:
propertyName- AStringspecifying a property name.- Returns:
- An
InputStreamspecifying the value of the property. - Throws:
EngineRuntimeException- if the property cannot be found in the collection or is not aPropertyContentinstance.
-
-