Package com.opentext.livelink.service.docman

Class UserAttribute

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class UserAttribute
extends PrimitiveAttribute
implements java.io.Serializable
    A UserAttribute represents Users or Groups in Content Server, stored as UserID integer values.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      UserAttribute()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getAllowGroups()
      Gets a flag indicating whether Content Server group IDs are valid values.
      long[] getValidValues()
      Gets the list of valid values for this attribute.
      long getValidValues​(int index)
      Gets the value at the specified index in the ValidValues array.
      java.lang.Long[] getValues()
      Gets the array of default values for the attribute.
      java.lang.Long getValues​(int index)
      Gets the value at the specified index in the Values array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setAllowGroups​(java.lang.Boolean value)
      Sets a flag indicating whether Content Server group IDs are valid values.
      void setValidValues​(int index, long value)
      Sets the value at the specified index in the fValidValues array.
      void setValidValues​(long[] value)
      Sets the list of valid values for this attribute.
      void setValues​(int index, java.lang.Long value)
      Sets the value at the specified index in the fValues array.
      void setValues​(java.lang.Long[] value)
      Sets the array of default values for the attribute.
      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

      • UserAttribute

        public UserAttribute()

    • Method Detail

      • setAllowGroups

        public void setAllowGroups​(java.lang.Boolean value)
        Sets a flag indicating whether Content Server group IDs are valid values.

      • getAllowGroups

        public java.lang.Boolean getAllowGroups()
        Gets a flag indicating whether Content Server group IDs are valid values.

      • setValidValues

        public void setValidValues​(long[] value)
        Sets the list of valid values for this attribute.

      • getValidValues

        public long[] getValidValues()
        Gets the list of valid values for this attribute.

      • setValidValues

        public void setValidValues​(int index,
                           long value)
        Sets the value at the specified index in the fValidValues array.

      • getValidValues

        public long getValidValues​(int index)
        Gets the value at the specified index in the ValidValues array.

      • setValues

        public void setValues​(java.lang.Long[] value)
        Sets the array of default values for the attribute.

      • getValues

        public java.lang.Long[] getValues()
        Gets the array of default values for the attribute.

      • setValues

        public void setValues​(int index,
                      java.lang.Long value)
        Sets the value at the specified index in the fValues array.

      • getValues

        public java.lang.Long getValues​(int index)
        Gets the value at the specified index in the Values array.

      • 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 PrimitiveAttribute
        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 PrimitiveAttribute
        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 PrimitiveAttribute