Package com.opentext.livelink.service.searchservices

Class SResultPage

    • Constructor Summary

      Constructors 
      Constructor Description
      SResultPage()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SGraph[] getItem()
      Gets the ordered list of the graphs in this page of search results.
      SGraph getItem​(int index)
      Gets the value at the specified index in the Item array.
      ListDescription getListDescription()
      Gets the description of the place of this page of results in the entire result list.
      DataBagType[] getType()
      Gets the types of the edges and nodes in the graphs of fItem.
      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 setItem​(int index, SGraph value)
      Sets the value at the specified index in the fItem array.
      void setItem​(SGraph[] value)
      Sets the ordered list of the graphs in this page of search results.
      void setListDescription​(ListDescription value)
      Sets the description of the place of this page of results in the entire result list.
      void setType​(int index, DataBagType value)
      Sets the value at the specified index in the fType array.
      void setType​(DataBagType[] value)
      Sets the types of the edges and nodes in the graphs of fItem.
      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

      • SResultPage

        public SResultPage()

    • Method Detail

      • setItem

        public void setItem​(SGraph[] value)
        Sets the ordered list of the graphs in this page of search results.

      • getItem

        public SGraph[] getItem()
        Gets the ordered list of the graphs in this page of search results.

      • setItem

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

      • getItem

        public SGraph getItem​(int index)
        Gets the value at the specified index in the Item array.

      • setListDescription

        public void setListDescription​(ListDescription value)
        Sets the description of the place of this page of results in the entire result list.

      • getListDescription

        public ListDescription getListDescription()
        Gets the description of the place of this page of results in the entire result list.

      • setType

        public void setType​(DataBagType[] value)
        Sets the types of the edges and nodes in the graphs of fItem.

      • getType

        public DataBagType[] getType()
        Gets the types of the edges and nodes in the graphs of fItem.

      • 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