Package com.opentext.livelink.service.searchservices

Class FieldInfo

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class FieldInfo
extends ServiceDataObject
implements java.io.Serializable
    The Field Information returned from the GetFieldInfo operation.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      FieldInfo()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCollection()
      Gets the data collection in which this field exists.
      java.lang.String getName()
      Gets the name of the field.
      boolean getOnEdge()
      Gets whether the field may occur on edges in the result graphs.
      boolean getOnNode()
      Gets whether the field may occur on nodes in the result graphs.
      boolean getRetrievable()
      Gets whether the field value can be used in the resulttransformation spec.
      boolean getSearchable()
      Gets whether the field can be used in the ResultSetSpec or the ResultOrderSpec.
      java.lang.String getStorageModel()
      Gets where this field is stored (e.g. rdb, memory, or disk).
      java.lang.String getType()
      Gets the type of data associated with this field.
      NV[] getXD()
      Gets the additional data associated with a field.
      NV getXD​(int index)
      Gets the value at the specified index in the XD array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setCollection​(java.lang.String value)
      Sets the data collection in which this field exists.
      void setName​(java.lang.String value)
      Sets the name of the field.
      void setOnEdge​(boolean value)
      Sets whether the field may occur on edges in the result graphs.
      void setOnNode​(boolean value)
      Sets whether the field may occur on nodes in the result graphs.
      void setRetrievable​(boolean value)
      Sets whether the field value can be used in the resulttransformation spec.
      void setSearchable​(boolean value)
      Sets whether the field can be used in the ResultSetSpec or the ResultOrderSpec.
      void setStorageModel​(java.lang.String value)
      Sets where this field is stored (e.g. rdb, memory, or disk).
      void setType​(java.lang.String value)
      Sets the type of data associated with this field.
      void setXD​(int index, NV value)
      Sets the value at the specified index in the fXD array.
      void setXD​(NV[] value)
      Sets the additional data associated with a field.
      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

      • FieldInfo

        public FieldInfo()

    • Method Detail

      • setCollection

        public void setCollection​(java.lang.String value)
        Sets the data collection in which this field exists.

      • getCollection

        public java.lang.String getCollection()
        Gets the data collection in which this field exists.

      • setName

        public void setName​(java.lang.String value)
        Sets the name of the field. To be used in searches restricted to hits in this field.

      • getName

        public java.lang.String getName()
        Gets the name of the field. To be used in searches restricted to hits in this field.

      • setOnEdge

        public void setOnEdge​(boolean value)
        Sets whether the field may occur on edges in the result graphs.

      • getOnEdge

        public boolean getOnEdge()
        Gets whether the field may occur on edges in the result graphs.

      • setOnNode

        public void setOnNode​(boolean value)
        Sets whether the field may occur on nodes in the result graphs.

      • getOnNode

        public boolean getOnNode()
        Gets whether the field may occur on nodes in the result graphs.

      • setRetrievable

        public void setRetrievable​(boolean value)
        Sets whether the field value can be used in the resulttransformation spec.

      • getRetrievable

        public boolean getRetrievable()
        Gets whether the field value can be used in the resulttransformation spec.

      • setSearchable

        public void setSearchable​(boolean value)
        Sets whether the field can be used in the ResultSetSpec or the ResultOrderSpec.

      • getSearchable

        public boolean getSearchable()
        Gets whether the field can be used in the ResultSetSpec or the ResultOrderSpec.

      • setStorageModel

        public void setStorageModel​(java.lang.String value)
        Sets where this field is stored (e.g. rdb, memory, or disk).

      • getStorageModel

        public java.lang.String getStorageModel()
        Gets where this field is stored (e.g. rdb, memory, or disk).

      • setType

        public void setType​(java.lang.String value)
        Sets the type of data associated with this field. (i.e. String, Int, Real, Date).

      • getType

        public java.lang.String getType()
        Gets the type of data associated with this field. (i.e. String, Int, Real, Date).

      • setXD

        public void setXD​(NV[] value)
        Sets the additional data associated with a field. A list of name/value pairs.

      • getXD

        public NV[] getXD()
        Gets the additional data associated with a field. A list of name/value pairs.

      • setXD

        public void setXD​(int index,
                  NV value)
        Sets the value at the specified index in the fXD array.

      • getXD

        public NV getXD​(int index)
        Gets the value at the specified index in the XD 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 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