Package com.opentext.livelink.service.docman

Class AttributeGroupDefinition

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class AttributeGroupDefinition
extends ServiceDataObject
implements java.io.Serializable
    An AttributeGroupDefinition represents an ordered list of Attributes. For example, AttributeGroupDefinitions are used to define Category attributes.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Attribute[] getAttributes()
      Gets the array of Attribute definition objects for the group definition.
      Attribute getAttributes​(int index)
      Gets the value at the specified index in the Attributes array.
      java.lang.String getDisplayName()
      Gets the display name of the group definition.
      long getID()
      Gets the ID of the group definition (e.g. for Category types, this is the Category node's ID).
      java.lang.String getKey()
      Gets the key identifying the group definition, corresponding to the key in the value instance AttributeGroup.
      java.lang.String getType()
      Gets the type of the group definition (e.g.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setAttributes​(int index, Attribute value)
      Sets the value at the specified index in the fAttributes array.
      void setAttributes​(Attribute[] value)
      Sets the array of Attribute definition objects for the group definition.
      void setDisplayName​(java.lang.String value)
      Sets the display name of the group definition.
      void setID​(long value)
      Sets the ID of the group definition (e.g. for Category types, this is the Category node's ID).
      void setKey​(java.lang.String value)
      Sets the key identifying the group definition, corresponding to the key in the value instance AttributeGroup.
      void setType​(java.lang.String value)
      Sets the type of the group definition (e.g.
      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

      • AttributeGroupDefinition

        public AttributeGroupDefinition()

    • Method Detail

      • setAttributes

        public void setAttributes​(Attribute[] value)
        Sets the array of Attribute definition objects for the group definition.

      • getAttributes

        public Attribute[] getAttributes()
        Gets the array of Attribute definition objects for the group definition.

      • setAttributes

        public void setAttributes​(int index,
                          Attribute value)
        Sets the value at the specified index in the fAttributes array.

      • getAttributes

        public Attribute getAttributes​(int index)
        Gets the value at the specified index in the Attributes array.

      • setDisplayName

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

      • getDisplayName

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

      • setID

        public void setID​(long value)
        Sets the ID of the group definition (e.g. for Category types, this is the Category node's ID).

      • getID

        public long getID()
        Gets the ID of the group definition (e.g. for Category types, this is the Category node's ID).

      • setKey

        public void setKey​(java.lang.String value)
        Sets the key identifying the group definition, corresponding to the key in the value instance AttributeGroup.

      • getKey

        public java.lang.String getKey()
        Gets the key identifying the group definition, corresponding to the key in the value instance AttributeGroup.

      • setType

        public void setType​(java.lang.String value)
        Sets the type of the group definition (e.g. Category).

      • getType

        public java.lang.String getType()
        Gets the type of the group definition (e.g. Category).

      • 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