Package com.opentext.livelink.service.docman

Class NodePageResult

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class NodePageResult
extends ServiceDataObject
implements java.io.Serializable
    NodePageResult is returned by ListNodesByPage(), and contains the requested nodes, and other information about the list.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      NodePageResult()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Node[] getNodes()
      Gets the list of nodes on the specified page.
      Node getNodes​(int index)
      Gets the value at the specified index in the Nodes array.
      int getNumberOfPages()
      Gets the maximum number of pages (actual number will be based on permissions and hidden state).
      java.lang.String getPageContext()
      Gets the page context is a state token which should be used when getting next page.
      int getPageNumber()
      Gets the page number returned, or 0 if the page does not exist.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setNodes​(int index, Node value)
      Sets the value at the specified index in the fNodes array.
      void setNodes​(Node[] value)
      Sets the list of nodes on the specified page.
      void setNumberOfPages​(int value)
      Sets the maximum number of pages (actual number will be based on permissions and hidden state).
      void setPageContext​(java.lang.String value)
      Sets the page context is a state token which should be used when getting next page.
      void setPageNumber​(int value)
      Sets the page number returned, or 0 if the page does not exist.
      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

      • NodePageResult

        public NodePageResult()

    • Method Detail

      • setNodes

        public void setNodes​(Node[] value)
        Sets the list of nodes on the specified page.

      • getNodes

        public Node[] getNodes()
        Gets the list of nodes on the specified page.

      • setNodes

        public void setNodes​(int index,
                     Node value)
        Sets the value at the specified index in the fNodes array.

      • getNodes

        public Node getNodes​(int index)
        Gets the value at the specified index in the Nodes array.

      • setNumberOfPages

        public void setNumberOfPages​(int value)
        Sets the maximum number of pages (actual number will be based on permissions and hidden state).

      • getNumberOfPages

        public int getNumberOfPages()
        Gets the maximum number of pages (actual number will be based on permissions and hidden state).

      • setPageContext

        public void setPageContext​(java.lang.String value)
        Sets the page context is a state token which should be used when getting next page.

      • getPageContext

        public java.lang.String getPageContext()
        Gets the page context is a state token which should be used when getting next page.

      • setPageNumber

        public void setPageNumber​(int value)
        Sets the page number returned, or 0 if the page does not exist.

      • getPageNumber

        public int getPageNumber()
        Gets the page number returned, or 0 if the page does not exist.

      • 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