Package com.opentext.livelink.service.searchservices

Class SingleSearchResponse

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SGraph[] getResultAnalysis()
      Gets any out of band information related to the results.
      SGraph getResultAnalysis​(int index)
      Gets the value at the specified index in the ResultAnalysis array.
      SResultPage getResults()
      Gets the requested page of search results.
      DataBagType[] getType()
      Gets the types used in the fResultAnalysis.
      DataBagType getType​(int index)
      Gets the value at the specified index in the Type array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setResultAnalysis​(int index, SGraph value)
      Sets the value at the specified index in the fResultAnalysis array.
      void setResultAnalysis​(SGraph[] value)
      Sets any out of band information related to the results.
      void setResults​(SResultPage value)
      Sets the requested page of search results.
      void setType​(int index, DataBagType value)
      Sets the value at the specified index in the fType array.
      void setType​(DataBagType[] value)
      Sets the types used in the fResultAnalysis.
      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

      • SingleSearchResponse

        public SingleSearchResponse()

    • Method Detail

      • setResultAnalysis

        public void setResultAnalysis​(SGraph[] value)
        Sets any out of band information related to the results.

      • getResultAnalysis

        public SGraph[] getResultAnalysis()
        Gets any out of band information related to the results.

      • setResultAnalysis

        public void setResultAnalysis​(int index,
                              SGraph value)
        Sets the value at the specified index in the fResultAnalysis array.

      • getResultAnalysis

        public SGraph getResultAnalysis​(int index)
        Gets the value at the specified index in the ResultAnalysis array.

      • setResults

        public void setResults​(SResultPage value)
        Sets the requested page of search results.

      • getResults

        public SResultPage getResults()
        Gets the requested page of search results.

      • setType

        public void setType​(DataBagType[] value)
        Sets the types used in the fResultAnalysis.

      • getType

        public DataBagType[] getType()
        Gets the types used in the fResultAnalysis.

      • setType

        public void setType​(int index,
                    DataBagType value)
        Sets the value at the specified index in the fType array.

      • getType

        public DataBagType getType​(int index)
        Gets the value at the specified index in the Type 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