com.filenet.api.property

Interface Properties

  • All Superinterfaces:
    java.io.Serializable


    public interface Properties
    extends java.io.Serializable
    Represents a collection of Property values that you can manipulate.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      Property find(java.lang.String propertyName)
      Returns the Property object specified by name in this Properties collection.
      Property get(java.lang.String propertyName)
      Returns the Property object specified by name in this Properties collection.
      BinaryList getBinaryListValue(java.lang.String propertyName)
      Locates a PropertyBinaryList property by name in this Properties collection and returns the value it holds.
      byte[] getBinaryValue(java.lang.String propertyName)
      Locates a PropertyBinary property by name in this Properties collection and returns the value it holds.
      BooleanList getBooleanListValue(java.lang.String propertyName)
      Locates a PropertyBooleanList property by name in this Properties collection and returns the value it holds.
      java.lang.Boolean getBooleanValue(java.lang.String propertyName)
      Locates a PropertyBoolean property by name in this Properties collection and returns the value it holds.
      DateTimeList getDateTimeListValue(java.lang.String propertyName)
      Locates a PropertyDateTimeList property by name in this Properties collection and returns the value it holds.
      java.util.Date getDateTimeValue(java.lang.String propertyName)
      Locates a PropertyDateTime property by name in this Properties collection and returns the value it holds.
      DependentObjectList getDependentObjectListValue(java.lang.String propertyName)
      Locates a PropertyDependentObjectList property by name in this Properties collection and returns the value it holds.
      EngineObject getEngineObjectValue(java.lang.String propertyName)
      Locates a PropertyEngineObject property by name in this Properties collection and returns the value it holds.
      Float64List getFloat64ListValue(java.lang.String propertyName)
      Locates a PropertyFloat64List property by name in this Properties collection and returns the value it holds.
      java.lang.Double getFloat64Value(java.lang.String propertyName)
      Locates a PropertyFloat64 property by name in this Properties collection and returns the value it holds.
      IdList getIdListValue(java.lang.String propertyName)
      Locates a PropertyIdList property by name in this Properties collection and returns the value it holds.
      Id getIdValue(java.lang.String propertyName)
      Locates a PropertyId property by name in this Properties collection and returns the value it holds.
      IndependentObjectSet getIndependentObjectSetValue(java.lang.String propertyName)
      Locates a PropertyIndependentObjectSet property by name in this Properties collection and returns the value it holds.
      java.io.InputStream getInputStreamValue(java.lang.String propertyName)
      Locates a PropertyContent property by name in this Properties collection and returns the value it holds.
      Integer32List getInteger32ListValue(java.lang.String propertyName)
      Locates a PropertyInteger32List property by name in this Properties collection and returns the value it holds.
      java.lang.Integer getInteger32Value(java.lang.String propertyName)
      Locates a PropertyInteger32 property by name in this Properties collection and returns the value it holds.
      java.lang.Object getObjectValue(java.lang.String propertyName)
      Locates a property by name in this Properties collection and returns the value it holds.
      StringList getStringListValue(java.lang.String propertyName)
      Locates a PropertyStringList property by name in this Properties collection and returns the value it holds.
      java.lang.String getStringValue(java.lang.String propertyName)
      Locates a PropertyString property by name in this Properties collection and returns the value it holds.
      boolean isDirty()
      Specifies whether this Properties collection has changed since it was last saved (true) or not (false).
      boolean isPropertyPresent(java.lang.String propertyName)
      Returns whether this Properties collection holds a Property instance having the given property name (true) or not (false).
      java.util.Iterator iterator()
      Returns a Java Iterator 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 a Property instance in this Properties collection.
      void putValue(java.lang.String propertyName, BinaryList value)
      Creates or updates a PropertyBinaryList instance in this Properties collection.
      void putValue(java.lang.String propertyName, boolean value)
      Creates or updates a PropertyBoolean instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.lang.Boolean value)
      Creates or updates a PropertyBoolean instance in this Properties collection.
      void putValue(java.lang.String propertyName, BooleanList value)
      Creates or updates a PropertyBooleanList instance in this Properties collection.
      void putValue(java.lang.String propertyName, byte[] value)
      Creates or updates a PropertyBinary instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.util.Date value)
      Creates or updates a PropertyDateTime instance in this Properties collection.
      void putValue(java.lang.String propertyName, DateTimeList value)
      Creates or updates a PropertyDateTimeList instance in this Properties collection.
      void putValue(java.lang.String propertyName, DependentObjectList value)
      Creates or updates a PropertyDependentObjectList instance in this Properties collection.
      void putValue(java.lang.String propertyName, double value)
      Creates or updates a PropertyFloat64 instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.lang.Double value)
      Creates or updates a PropertyFloat64 instance in this Properties collection.
      void putValue(java.lang.String propertyName, EngineObject value)
      Creates or updates a PropertyEngineObject instance in this Properties collection.
      void putValue(java.lang.String propertyName, Float64List value)
      Creates or updates a PropertyFloat64List instance in this Properties collection.
      void putValue(java.lang.String propertyName, Id value)
      Creates or updates a PropertyId instance in this Properties collection.
      void putValue(java.lang.String propertyName, IdList value)
      Creates or updates a PropertyIdList instance in this Properties collection.
      void putValue(java.lang.String propertyName, IndependentObjectSet value)
      Creates or updates a PropertyIndependentObjectSet instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.io.InputStream value)
      Creates or updates a PropertyContent instance in this Properties collection.
      void putValue(java.lang.String propertyName, int value)
      Creates or updates a PropertyInteger32 instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.lang.Integer value)
      Creates or updates a PropertyInteger32 instance in this Properties collection.
      void putValue(java.lang.String propertyName, Integer32List value)
      Creates or updates a PropertyInteger32List instance in this Properties collection.
      void putValue(java.lang.String propertyName, java.lang.String value)
      Creates or updates a PropertyString instance in this Properties collection.
      void putValue(java.lang.String propertyName, StringList value)
      Creates or updates a PropertyStringList instance in this Properties collection.
      void removeFromCache(java.lang.String propertyName)
      Removes the Property object specified by name from this Properties collection cache.
      void removeFromCache(java.lang.String[] propertyNames)
      Removes the Property objects specified by their names in a String array from this Properties collection cache.
      int size()
      Returns the number of Property objects in this Properties collection.
      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 Java Iterator 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 of Property objects in this Properties collection.
        Returns:
        An int specifying the number of elements in the collection.
      • get

        Property get(java.lang.String propertyName)
        Returns the Property object specified by name in this Properties collection.
        Parameters:
        propertyName - A String 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 the Property object specified by name in this Properties collection.
        Parameters:
        propertyName - A String 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 this Properties collection holds a Property instance having the given property name (true) or not (false).
        Parameters:
        propertyName - A String specifying a property name.
        Returns:
        true if a property with the given name is found; otherwise, returns false.
      • isDirty

        boolean isDirty()
        Specifies whether this Properties collection has changed since it was last saved (true) or not (false).
        Returns:
        true if the value of the collection has changed; otherwise, returns false.
      • removeFromCache

        void removeFromCache(java.lang.String propertyName)
        Removes the Property object specified by name from this Properties collection cache. Note that the Properties collection on the server remains unchanged. Properties are only removed from the local properties cache.
        Parameters:
        propertyName - A String specifying the name of the property to remove.
      • removeFromCache

        void removeFromCache(java.lang.String[] propertyNames)
        Removes the Property objects specified by their names in a String array from this Properties collection cache. Note that the Properties collection on the server remains unchanged. Properties are only removed from the local properties cache.
        Parameters:
        propertyNames - A String 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 the Properties collection.
      • putObjectValue

        void putObjectValue(java.lang.String propertyName,
                          java.lang.Object value)
        Creates or updates a Property instance in this Properties collection. The type of Property created or updated is determined by the object type of the value parameter. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An object 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 by value 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.lang.String value)
        Creates or updates a PropertyString instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A String 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.util.Date value)
        Creates or updates a PropertyDateTime instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A Date 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.lang.Integer value)
        Creates or updates a PropertyInteger32 instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An Integer 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    int value)
        Creates or updates a PropertyInteger32 instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An int 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.lang.Boolean value)
        Creates or updates a PropertyBoolean instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A Boolean 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    boolean value)
        Creates or updates a PropertyBoolean instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A boolean 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.lang.Double value)
        Creates or updates a PropertyFloat64 instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A Double 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    double value)
        Creates or updates a PropertyFloat64 instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A double 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    byte[] value)
        Creates or updates a PropertyBinary instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - A byte 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    Id value)
        Creates or updates a PropertyId instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An Id 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    EngineObject value)
        Creates or updates a PropertyEngineObject instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An EngineObject 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    DependentObjectList value)
        Creates or updates a PropertyDependentObjectList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A DependentObjectList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    IndependentObjectSet value)
        Creates or updates a PropertyIndependentObjectSet instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - An IndependentObjectSet 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    StringList value)
        Creates or updates a PropertyStringList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A StringList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    BooleanList value)
        Creates or updates a PropertyBooleanList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A BooleanList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    Integer32List value)
        Creates or updates a PropertyInteger32List instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - An Integer32List 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    Float64List value)
        Creates or updates a PropertyFloat64List instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A Float64List 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    DateTimeList value)
        Creates or updates a PropertyDateTimeList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A DateTimeList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    BinaryList value)
        Creates or updates a PropertyBinaryList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - A BinaryList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    IdList value)
        Creates or updates a PropertyIdList instance in this Properties 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 by value, this method will be ignored.
        Parameters:
        propertyName - A String specifying a property name.
        value - An IdList 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 (its Property.isSettable method returns false).
      • putValue

        void putValue(java.lang.String propertyName,
                    java.io.InputStream value)
        Creates or updates a PropertyContent instance in this Properties collection. If a property with the same name already exists in the collection, its value will be replaced with the value provided.
        Parameters:
        propertyName - A String specifying a property name.
        value - An InputStream 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 (its Property.isSettable method returns false).
      • getObjectValue

        java.lang.Object getObjectValue(java.lang.String propertyName)
        Locates a property by name in this Properties 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 - A String specifying a property name.
        Returns:
        An Object specifying the value of the property. If the property's value cannot be retrieved, an EngineRuntimeException 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 a PropertyString property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyString instance.
      • getDateTimeValue

        java.util.Date getDateTimeValue(java.lang.String propertyName)
        Locates a PropertyDateTime property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyDateTime instance.
      • getInteger32Value

        java.lang.Integer getInteger32Value(java.lang.String propertyName)
        Locates a PropertyInteger32 property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyInteger32 instance.
      • getBooleanValue

        java.lang.Boolean getBooleanValue(java.lang.String propertyName)
        Locates a PropertyBoolean property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyBoolean instance.
      • getFloat64Value

        java.lang.Double getFloat64Value(java.lang.String propertyName)
        Locates a PropertyFloat64 property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyFloat64 instance.
      • getBinaryValue

        byte[] getBinaryValue(java.lang.String propertyName)
        Locates a PropertyBinary property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyBinary instance.
      • getIdValue

        Id getIdValue(java.lang.String propertyName)
        Locates a PropertyId property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyId instance.
      • getEngineObjectValue

        EngineObject getEngineObjectValue(java.lang.String propertyName)
        Locates a PropertyEngineObject property by name in this Properties 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 - A String specifying a property name.
        Returns:
        An EngineObject specifying the value of the property. If the property's value cannot be retrieved, an EngineRuntimeException object will be returned.
        Throws:
        EngineRuntimeException - if the property cannot be found in the collection, is not a PropertyEngineObject instance, or a retrieval error has occurred (Property.PropertyState = RETRIEVAL_ERROR).
        See Also:
        PropertyState
      • getDependentObjectListValue

        DependentObjectList getDependentObjectListValue(java.lang.String propertyName)
        Locates a PropertyDependentObjectList property by name in this Properties 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 - A String specifying a property name.
        Returns:
        A DependentEngineObjectList collection specifying the value of the property. If the property's value cannot be retrieved, an EngineRuntimeException object will be returned.
        Throws:
        EngineRuntimeException - if the property cannot be found in the collection, is not a PropertyDependentObjectList instance, or a retrieval error has occurred (Property.PropertyState = RETRIEVAL_ERROR).
        See Also:
        PropertyState
      • getIndependentObjectSetValue

        IndependentObjectSet getIndependentObjectSetValue(java.lang.String propertyName)
        Locates a PropertyIndependentObjectSet property by name in this Properties 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 - A String specifying a property name.
        Returns:
        An IndependentObjectSet collection specifying the value of the property. If the property's value cannot be retrieved, an EngineRuntimeException object will be returned.
        Throws:
        EngineRuntimeException - if the property cannot be found in the collection, is not a PropertyIndependentObjectSet instance, or a retrieval error has occurred (Property.PropertyState = RETRIEVAL_ERROR).
        See Also:
        PropertyState
      • getStringListValue

        StringList getStringListValue(java.lang.String propertyName)
        Locates a PropertyStringList property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyStringList instance.
      • getBooleanListValue

        BooleanList getBooleanListValue(java.lang.String propertyName)
        Locates a PropertyBooleanList property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyBooleanList instance.
      • getInteger32ListValue

        Integer32List getInteger32ListValue(java.lang.String propertyName)
        Locates a PropertyInteger32List property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyInteger32List instance.
      • getFloat64ListValue

        Float64List getFloat64ListValue(java.lang.String propertyName)
        Locates a PropertyFloat64List property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyFloat64List instance.
      • getDateTimeListValue

        DateTimeList getDateTimeListValue(java.lang.String propertyName)
        Locates a PropertyDateTimeList property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyDateTimeList instance.
      • getBinaryListValue

        BinaryList getBinaryListValue(java.lang.String propertyName)
        Locates a PropertyBinaryList property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyBinaryList instance.
      • getIdListValue

        IdList getIdListValue(java.lang.String propertyName)
        Locates a PropertyIdList property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyIdList instance.
      • getInputStreamValue

        java.io.InputStream getInputStreamValue(java.lang.String propertyName)
        Locates a PropertyContent property by name in this Properties collection and returns the value it holds.
        Parameters:
        propertyName - A String 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 a PropertyContent instance.

© Copyright IBM Corporation 2006, 2013. All rights reserved.