com.ibm.jarm.api.property

Interface RMProperty


  • public interface RMProperty
    Represents a single property value that is a member of a RMProperties collection.

    A RMProperty instance can only be acquired as a member of its parent RMProperties collection.

    A new RMProperty instance is created using the RMProperties.add method or one of the various RMProperties.putXXXValue() methods.

    A existing RMProperty instance can be removed from its corresponding parent collection using the RMProperties.remove method.

    • Method Detail

      • getSymbolicName

        java.lang.String getSymbolicName()
        Returns the symbolic name of the property.
        Returns:
        A String value.

      • getDataType

        DataType getDataType()
        Returns the DataType defined for this RMProperty instance.
        Returns:
        A DataType value.

      • isDirty

        boolean isDirty()
        Indicates if the value of this property has been modified since the last time that its corresponding repository entity was saved.
        Returns:
        true if the property has been modified, false otherwise.

      • isSettable

        boolean isSettable()
        Indicates whether the value of this property can be set.
        Returns:
        true if the property can be set, false otherwise.

      • setBinaryValue

        void setBinaryValue(byte[] value)
        Sets the value of a RMProperty instance whose data type is DataType.Binary. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a byte[]. Can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setBinaryValue

        void setBinaryValue(java.util.List<byte[]> values)
        Sets the value of a RMProperty instance whose data type is DataType.Binary and whose cardinality is multi-valued.
        Parameters:
        values - a List<byte[]>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setBooleanValue

        void setBooleanValue(java.lang.Boolean value)
        Sets the value of a RMProperty instance whose data type is DataType.Boolean. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a Boolean. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setBooleanValue

        void setBooleanValue(java.util.List<java.lang.Boolean> values)
        Sets the value of a RMProperty instance whose data type is DataType.Boolean and whose cardinality is multi-valued.
        Parameters:
        values - a List<Boolean>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setDateTimeValue

        void setDateTimeValue(java.util.Date value)
        Sets the value of a RMProperty instance whose data type is DataType.DateTime. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a Date. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setDateTimeValue

        void setDateTimeValue(java.util.List<java.util.Date> values)
        Sets the value of a RMProperty instance whose data type is DataType.DateTime and whose cardinality is multi-valued.
        Parameters:
        values - a List<Date>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setDoubleValue

        void setDoubleValue(java.lang.Double value)
        Sets the value of a RMProperty instance whose data type is DataType.Double. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a Double. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setDoubleValue

        void setDoubleValue(java.util.List<java.lang.Double> value)
        Sets the value of a RMProperty instance whose data type is DataType.Double and whose cardinality is multi-valued.
        Parameters:
        value - a List<Double>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setGuidValue

        void setGuidValue(java.lang.String value)
        Sets the value of a RMProperty instance whose data type is DataType.Guid. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a Guid String. Can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setGuidValue

        void setGuidValue(java.util.List<java.lang.String> values)
        Sets the value of a RMProperty instance whose data type is DataType.Guid and whose cardinality is multi-valued.
        Parameters:
        values - a Guid List<String>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setIntegerValue

        void setIntegerValue(java.lang.Integer value)
        Sets the value of a RMProperty instance whose data type is DataType.Integer. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a Integer. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setIntegerValue

        void setIntegerValue(java.util.List<java.lang.Integer> value)
        Sets the value of a RMProperty instance whose data type is DataType.Integer and whose cardinality is multi-valued.
        Parameters:
        value - a List<Integer>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setObjectValue

        void setObjectValue(java.lang.Object value)
        Sets the value of a RMProperty instance whose data type is DataType.Object. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - an Object. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setObjectValue

        void setObjectValue(java.util.List<java.lang.Object> values)
        Sets the value of a RMProperty instance whose data type is DataType.Object and whose cardinality is multi-valued.

        This method is NOT supported for P8 Content Engine repositories.

        Parameters:
        values - a List<Object>. This entry can be null or empty.
        Throws:
        API_OPERATION_NOT_SUPPORTED - this method is NOT supported for P8 Content Engine repositories.

      • setStringValue

        void setStringValue(java.lang.String value)
        Sets the value of a RMProperty instance whose data type is DataType.String. This method is applicable to a property of single-valued cardinality or a multi-valued property whose value contains a single member.
        Parameters:
        value - a String. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • setStringValue

        void setStringValue(java.util.List<java.lang.String> values)
        Sets the value of a RMProperty instance whose data type is DataType.String and whose cardinality is multi-valued.
        Parameters:
        values - a List<String>. This entry can be null or empty.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
        RAL_PROPERTY_SET_ERROR - for any value handling error.

      • getBinaryValue

        byte[] getBinaryValue()
        Returns the value of a RMProperty of data type DataType.Binary and cardinality single-valued.
        Returns:
        A byte[]. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getBinaryListValue

        java.util.List<byte[]> getBinaryListValue()
        Returns the value of a RMProperty of data type DataType.Binary and cardinality multi-valued.
        Returns:
        A List<byte[]>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getBooleanValue

        java.lang.Boolean getBooleanValue()
        Returns the value of a RMProperty of data type DataType.Boolean and cardinality single-valued.
        Returns:
        A Boolean. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getBooleanListValue

        java.util.List<java.lang.Boolean> getBooleanListValue()
        Returns the value of a RMProperty of data type DataType.Boolean and cardinality multi-valued.
        Returns:
        A List<Boolean>. This entry can be null.

      • getDateTimeValue

        java.util.Date getDateTimeValue()
        Returns the value of a RMProperty of data type DataType.DateTime and cardinality single-valued.
        Returns:
        A Date. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getDateTimeListValue

        java.util.List<java.util.Date> getDateTimeListValue()
        Returns the value of a RMProperty of data type DataType.DateTime and cardinality multi-valued.
        Returns:
        A List<Date>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getDoubleValue

        java.lang.Double getDoubleValue()
        Returns the value of a RMProperty of data type DataType.Double and cardinality single-valued.
        Returns:
        A Double. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getDoubleListValue

        java.util.List<java.lang.Double> getDoubleListValue()
        Returns the value of a RMProperty of data type DataType.Double and cardinality multi-valued.
        Returns:
        A List<Double>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getGuidValue

        java.lang.String getGuidValue()
        Returns the value of a RMProperty of data type DataType.Guid and cardinality single-valued.
        Returns:
        A String. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getGuidListValue

        java.util.List<java.lang.String> getGuidListValue()
        Returns the value of a RMProperty of data type DataType.Guid and cardinality multi-valued.
        Returns:
        A List<String>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getIntegerValue

        java.lang.Integer getIntegerValue()
        Returns the value of a RMProperty of data type DataType.Integer and cardinality single-valued.
        Returns:
        An Integer. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getIntegerListValue

        java.util.List<java.lang.Integer> getIntegerListValue()
        Returns the value of a RMProperty of data type DataType.Integer and cardinality multi-valued.
        Returns:
        A List<Integer>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getObjectValue

        java.lang.Object getObjectValue()
        Returns the value of a RMProperty of data type DataType.Object and cardinality single-valued. Note that an attempt is made to resolve a non-null object value into the appropriate JARM type if possible. This process can result in additional round trips to the repository. Alternatively, the getRawObjectValue() method can be used to avoid any background round trip activity.
        Returns:
        An Object. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getRawObjectValue

        java.lang.Object getRawObjectValue()
        Returns the raw value of a RMProperty instance.
        Returns:
        An Object. This entry can be null.

      • getObjectListValue

        java.util.List<java.lang.Object> getObjectListValue()
        Returns the value of a RMProperty of data type DataType.Object and cardinality multi-valued.
        Returns:
        A List<Object>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.

      • getStringValue

        java.lang.String getStringValue()
        Returns the value of a RMProperty of data type DataType.String and cardinality single-valued.

        As a convenience, this method will attempt to return a string-version of a non-DataType.String-type scalar property when possible.

        Returns:
        A String. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if property is not single-valued or not easily represented as a String type.

      • getStringListValue

        java.util.List<java.lang.String> getStringListValue()
        Returns the value of a RMProperty of data type DataType.String and cardinality multi-valued.
        Returns:
        A List<String>. This entry can be null.
        Throws:
        API_INVALID_PROPERTY_DATATYPE - if this RMProperty does not support this data type.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corp. 2010, 2014. All Rights Reserved.