com.filenet.rm.bds

Interface PropertyValue



  • public interface PropertyValue
    This interface defines a value for a specified property that will apply to a new document or record object.

    The various SYMNAME_ constants define the non-localized, symbolic name strings of various commonly used CE Properties for Records Manager.

    • Method Detail

      • getSymbolicName

        java.lang.String getSymbolicName()
        Returns the SymbolicName String assigned to this PropertyValue instance.
        Returns:
        the SymbolicName String.
      • getDataType

        DataType getDataType()
        Returns the enumerated DataType member describing the type of data contained by this PropertyValue instance.
        Returns:
        an enumerated DataType instance.
      • isMultiValued

        boolean isMultiValued()
        Returns multi-valued nature of this PropertyValue instance.
        Returns:
        true if the associated property is multi-valued; otherwise false for a single-valued property.
      • getValue

        java.lang.Object getValue()
        Returns this PropertyValue instance's current value as an Object.
        Returns:
        the contained value of the PropertyValue instance. Can be null. If not null and if is multi-valued, then will return a homogeneous array of the simple type as defined by the instance's DataType. If not null and if is not multi-valued then will return a single wrapped simple type (e.g. Integer, Double, etc.) as defined by the instance's DataType.
      • setValueNull

        void setValueNull()
        Sets the PropertyValue instance's contained value to null.
      • setValue

        void setValue(byte[] value)
        Populates a single-valued DataType.TYPE_BINARY PropertyValue instance.
        Parameters:
        value - byte[] of binary data.
      • setValue

        void setValue(byte[][] value)
        Populates a multi-valued DataType.TYPE_BINARY PropertyValue instance.
        Parameters:
        value - array of byte[] data.
      • setValue

        void setValue(boolean value)
        Populates a single-valued DataType.TYPE_BOOLEAN PropertyValue instance.
        Parameters:
        value - Single-valued boolean property data.
      • setValue

        void setValue(boolean[] value)
        Populates a multi-valued DataType.TYPE_BOOLEAN PropertyValue instance.
        Parameters:
        value - Multi-valued boolean property data.
      • setValue

        void setValue(java.util.Calendar value)
        Populates a single-valued DataType.TYPE_DATE PropertyValue instance.
        Parameters:
        value - Single-valued Calendar property data.
      • setValue

        void setValue(java.util.Calendar[] value)
        Populates a multi-valued DataType.TYPE_DATE PropertyValue instance.
        Parameters:
        value - Multi-valued Calendar property data.
      • setValue

        void setValue(java.util.Date value)
        Populates a single-valued DataType.TYPE_DATE PropertyValue instance. Convenience method that will accept and convert Date to Calendar.
        Parameters:
        value - Single-valued Date property data.
      • setValue

        void setValue(java.util.Date[] value)
        Populates a multi-valued DataType.TYPE_DATE PropertyValue instance. Convenience method that will accept and convert Date[] to Calendar[].
        Parameters:
        value - Multi-valued Date property data.
      • setValue

        void setValue(double value)
        Populates a single-valued DataType.TYPE_DOUBLE PropertyValue instance.
        Parameters:
        value - Single-valued double property data.
      • setValue

        void setValue(double[] value)
        Populates a multi-valued DataType.TYPE_DOUBLE PropertyValue instance.
        Parameters:
        value - Multi-valued double property data.
      • setValue

        void setValue(GUID value)
        Populates a single-valued DataType.TYPE_GUID PropertyValue instance.
        Parameters:
        value - Single-valued GUID property data.
      • setValue

        void setValue(GUID[] value)
        Populates a multi-valued DataType.TYPE_GUID PropertyValue instance.
        Parameters:
        value - Multi-valued GUID property data.
      • setValue

        void setValue(int value)
        Populates a single-valued DataType.TYPE_INTEGER PropertyValue instance.
        Parameters:
        value - Single-valued int property data.
      • setValue

        void setValue(int[] value)
        Populates a multi-valued DataType.TYPE_INTEGER PropertyValue instance.
        Parameters:
        value - Multi-valued int property data.
      • setValue

        void setValue(java.lang.String value)
        Populates a single-valued DataType.TYPE_STRING PropertyValue instance.
        Parameters:
        value - Single-valued String property data.
      • setValue

        void setValue(java.lang.String[] value)
        Populates a multi-valued DataType.TYPE_STRING PropertyValue instance.
        Parameters:
        value - Multi-valued String property data.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.