Package com.opentext.livelink.service.docman

Class Attribute

    • Constructor Summary

      Constructors 
      Constructor Description
      Attribute()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Gets the display name of the attribute.
      long getID()
      Gets the ID of the attribute within its group.
      java.lang.String getKey()
      Gets the key identifying the attribute, corresponding to the key of the DataValue used to represent this attribute's values.
      java.lang.Integer getMaxValues()
      Gets the maximum number of values for the attribute.
      java.lang.Integer getMinValues()
      Gets the minimum number of values for the attribute.
      BooleanObject getReadOnly()
      Gets whether or not the attribute is read-only.
      java.lang.Boolean getRequired()
      Gets the required flag for the attribute, which controls whether a value is required for the attribute.
      java.lang.Boolean getSearchable()
      Gets the searchable flag for the attribute, which controls whether the attribute is searchable.
      java.lang.String getType()
      Gets the primitive type of the attribute, one of "String", "Integer", "Real", "Date" or "Boolean".
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setDisplayName​(java.lang.String value)
      Sets the display name of the attribute.
      void setID​(long value)
      Sets the ID of the attribute within its group.
      void setKey​(java.lang.String value)
      Sets the key identifying the attribute, corresponding to the key of the DataValue used to represent this attribute's values.
      void setMaxValues​(java.lang.Integer value)
      Sets the maximum number of values for the attribute.
      void setMinValues​(java.lang.Integer value)
      Sets the minimum number of values for the attribute.
      void setReadOnly​(BooleanObject value)
      Sets whether or not the attribute is read-only.
      void setRequired​(java.lang.Boolean value)
      Sets the required flag for the attribute, which controls whether a value is required for the attribute.
      void setSearchable​(java.lang.Boolean value)
      Sets the searchable flag for the attribute, which controls whether the attribute is searchable.
      void setType​(java.lang.String value)
      Sets the primitive type of the attribute, one of "String", "Integer", "Real", "Date" or "Boolean".
      com.opentext.api.LLValue toLLValue()
      Serialize an SDO object to an LLValue that can be sent to Livelink.
      java.lang.String toString()
      Returns a string representation of the object consisting of the object name and any features and their values within square brackets.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Attribute

        public Attribute()

    • Method Detail

      • setDisplayName

        public void setDisplayName​(java.lang.String value)
        Sets the display name of the attribute.

      • getDisplayName

        public java.lang.String getDisplayName()
        Gets the display name of the attribute.

      • setID

        public void setID​(long value)
        Sets the ID of the attribute within its group. The ID is assigned automatically during category creation.

      • getID

        public long getID()
        Gets the ID of the attribute within its group. The ID is assigned automatically during category creation.

      • setKey

        public void setKey​(java.lang.String value)
        Sets the key identifying the attribute, corresponding to the key of the DataValue used to represent this attribute's values.

      • getKey

        public java.lang.String getKey()
        Gets the key identifying the attribute, corresponding to the key of the DataValue used to represent this attribute's values.

      • setMaxValues

        public void setMaxValues​(java.lang.Integer value)
        Sets the maximum number of values for the attribute.

      • getMaxValues

        public java.lang.Integer getMaxValues()
        Gets the maximum number of values for the attribute.

      • setMinValues

        public void setMinValues​(java.lang.Integer value)
        Sets the minimum number of values for the attribute.

      • getMinValues

        public java.lang.Integer getMinValues()
        Gets the minimum number of values for the attribute.

      • setReadOnly

        public void setReadOnly​(BooleanObject value)
        Sets whether or not the attribute is read-only.

      • getReadOnly

        public BooleanObject getReadOnly()
        Gets whether or not the attribute is read-only.

      • setRequired

        public void setRequired​(java.lang.Boolean value)
        Sets the required flag for the attribute, which controls whether a value is required for the attribute.

      • getRequired

        public java.lang.Boolean getRequired()
        Gets the required flag for the attribute, which controls whether a value is required for the attribute.

      • setSearchable

        public void setSearchable​(java.lang.Boolean value)
        Sets the searchable flag for the attribute, which controls whether the attribute is searchable.

      • getSearchable

        public java.lang.Boolean getSearchable()
        Gets the searchable flag for the attribute, which controls whether the attribute is searchable.

      • setType

        public void setType​(java.lang.String value)
        Sets the primitive type of the attribute, one of "String", "Integer", "Real", "Date" or "Boolean".

      • getType

        public java.lang.String getType()
        Gets the primitive type of the attribute, one of "String", "Integer", "Real", "Date" or "Boolean".

      • load

        public void load​(com.opentext.api.LLValue value)
        Description copied from interface: IServiceDataObject
        Deserialize an ServiceDataObject from an LLValue that is received from Livelink. The LLValue is an Assoc that contains all of the features of this SDO. These features may refer to other SDOs and contain arrays of primitive values or SDOs. Each referenced SDO, will have its load() method called as well. Note: this is an internal method not meant to be called by clients.
        Specified by:
        load in interface IServiceDataObject
        Overrides:
        load in class ServiceDataObject
        Parameters:
        value - the LLValue containing the data to be loaded

      • toLLValue

        public com.opentext.api.LLValue toLLValue()
        Description copied from interface: IServiceDataObject
        Serialize an SDO object to an LLValue that can be sent to Livelink. Each feature of the SDO is stored in a key of the LLValue Assoc. Any references to other SDOs cause their toLLValue() method to be called. Note: this is an internal method not meant to be called by clients.
        Specified by:
        toLLValue in interface IServiceDataObject
        Overrides:
        toLLValue in class ServiceDataObject
        Returns:
        Returns the LLValue object that represents this SDO

      • toString

        public java.lang.String toString()
        Description copied from class: ServiceDataObject
        Returns a string representation of the object consisting of the object name and any features and their values within square brackets. Intended for simple debugging or logging of an SDO.
        Overrides:
        toString in class ServiceDataObject