Package com.opentext.livelink.service.searchservices

Class SingleSearchRequest

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class SingleSearchRequest
extends ServiceDataObject
implements java.io.Serializable
    The SingleSearchRequest contains the specification of a single search and the number of results to retrieve.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDataCollectionSpec()
      Gets the specification of the data collections to be used in this search.
      int getFirstResultToRetrieve()
      Gets a 1-based index into the result list of the first result in the result page.
      int getNumResultsToRetrieve()
      Gets the maximum size of the node set page to be returned.
      java.lang.String getQueryLanguage()
      Gets the query language used to interpret the other features in this search.
      java.lang.String getResultOrderSpec()
      Gets the specification of the order of the result items.
      java.lang.String getResultSetSpec()
      Gets the specification of the set of items to be returned.
      java.lang.String[] getResultTransformationSpec()
      Gets the specification of the final returned format of the graphs.
      java.lang.String getResultTransformationSpec​(int index)
      Gets the value at the specified index in the ResultTransformationSpec array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setDataCollectionSpec​(java.lang.String value)
      Sets the specification of the data collections to be used in this search.
      void setFirstResultToRetrieve​(int value)
      Sets a 1-based index into the result list of the first result in the result page.
      void setNumResultsToRetrieve​(int value)
      Sets the maximum size of the node set page to be returned.
      void setQueryLanguage​(java.lang.String value)
      Sets the query language used to interpret the other features in this search.
      void setResultOrderSpec​(java.lang.String value)
      Sets the specification of the order of the result items.
      void setResultSetSpec​(java.lang.String value)
      Sets the specification of the set of items to be returned.
      void setResultTransformationSpec​(int index, java.lang.String value)
      Sets the value at the specified index in the fResultTransformationSpec array.
      void setResultTransformationSpec​(java.lang.String[] value)
      Sets the specification of the final returned format of the graphs.
      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

      • SingleSearchRequest

        public SingleSearchRequest()

    • Method Detail

      • setDataCollectionSpec

        public void setDataCollectionSpec​(java.lang.String value)
        Sets the specification of the data collections to be used in this search.

      • getDataCollectionSpec

        public java.lang.String getDataCollectionSpec()
        Gets the specification of the data collections to be used in this search.

      • setFirstResultToRetrieve

        public void setFirstResultToRetrieve​(int value)
        Sets a 1-based index into the result list of the first result in the result page.

      • getFirstResultToRetrieve

        public int getFirstResultToRetrieve()
        Gets a 1-based index into the result list of the first result in the result page.

      • setNumResultsToRetrieve

        public void setNumResultsToRetrieve​(int value)
        Sets the maximum size of the node set page to be returned.

      • getNumResultsToRetrieve

        public int getNumResultsToRetrieve()
        Gets the maximum size of the node set page to be returned.

      • setQueryLanguage

        public void setQueryLanguage​(java.lang.String value)
        Sets the query language used to interpret the other features in this search.

      • getQueryLanguage

        public java.lang.String getQueryLanguage()
        Gets the query language used to interpret the other features in this search.

      • setResultOrderSpec

        public void setResultOrderSpec​(java.lang.String value)
        Sets the specification of the order of the result items.

      • getResultOrderSpec

        public java.lang.String getResultOrderSpec()
        Gets the specification of the order of the result items.

      • setResultSetSpec

        public void setResultSetSpec​(java.lang.String value)
        Sets the specification of the set of items to be returned.

      • getResultSetSpec

        public java.lang.String getResultSetSpec()
        Gets the specification of the set of items to be returned.

      • setResultTransformationSpec

        public void setResultTransformationSpec​(java.lang.String[] value)
        Sets the specification of the final returned format of the graphs.

      • getResultTransformationSpec

        public java.lang.String[] getResultTransformationSpec()
        Gets the specification of the final returned format of the graphs.

      • setResultTransformationSpec

        public void setResultTransformationSpec​(int index,
                                        java.lang.String value)
        Sets the value at the specified index in the fResultTransformationSpec array.

      • getResultTransformationSpec

        public java.lang.String getResultTransformationSpec​(int index)
        Gets the value at the specified index in the ResultTransformationSpec 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