Package com.opentext.livelink.service.docman

Class NodePageSpecification

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class NodePageSpecification
extends ServiceDataObject
implements java.io.Serializable
    NodePageSpecification is passed to ListNodesByPage(), and describes the page wanted.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getContainersOnly()
      Gets whether only containers should be returned.
      java.lang.String[] getExcludeTypes()
      Gets a list of node types to exclude from the results.
      java.lang.String getExcludeTypes​(int index)
      Gets the value at the specified index in the ExcludeTypes array.
      boolean getIncludeHiddenNodes()
      Gets whether hidden nodes should be returned.
      java.lang.String[] getIncludeTypes()
      Gets a list of node types to filter the results on.
      java.lang.String getIncludeTypes​(int index)
      Gets the value at the specified index in the IncludeTypes array.
      java.lang.String getNameFilter()
      Gets a partial name to filter results against.
      java.lang.String getPageContext()
      Gets the state token from prior call's NodePageResult.
      int getPageNumber()
      Gets the page number requested.
      int getPageSize()
      Gets the number of items per page.
      java.lang.String getTypeFilter()
      Gets the name of a type to use for filtering the results.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setContainersOnly​(boolean value)
      Sets whether only containers should be returned.
      void setExcludeTypes​(int index, java.lang.String value)
      Sets the value at the specified index in the fExcludeTypes array.
      void setExcludeTypes​(java.lang.String[] value)
      Sets a list of node types to exclude from the results.
      void setIncludeHiddenNodes​(boolean value)
      Sets whether hidden nodes should be returned.
      void setIncludeTypes​(int index, java.lang.String value)
      Sets the value at the specified index in the fIncludeTypes array.
      void setIncludeTypes​(java.lang.String[] value)
      Sets a list of node types to filter the results on.
      void setNameFilter​(java.lang.String value)
      Sets a partial name to filter results against.
      void setPageContext​(java.lang.String value)
      Sets the state token from prior call's NodePageResult.
      void setPageNumber​(int value)
      Sets the page number requested.
      void setPageSize​(int value)
      Sets the number of items per page.
      void setTypeFilter​(java.lang.String value)
      Sets the name of a type to use for filtering the results.
      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

      • NodePageSpecification

        public NodePageSpecification()

    • Method Detail

      • setContainersOnly

        public void setContainersOnly​(boolean value)
        Sets whether only containers should be returned.

      • getContainersOnly

        public boolean getContainersOnly()
        Gets whether only containers should be returned.

      • setExcludeTypes

        public void setExcludeTypes​(java.lang.String[] value)
        Sets a list of node types to exclude from the results.

      • getExcludeTypes

        public java.lang.String[] getExcludeTypes()
        Gets a list of node types to exclude from the results.

      • setExcludeTypes

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

      • getExcludeTypes

        public java.lang.String getExcludeTypes​(int index)
        Gets the value at the specified index in the ExcludeTypes array.

      • setIncludeHiddenNodes

        public void setIncludeHiddenNodes​(boolean value)
        Sets whether hidden nodes should be returned.

      • getIncludeHiddenNodes

        public boolean getIncludeHiddenNodes()
        Gets whether hidden nodes should be returned.

      • setIncludeTypes

        public void setIncludeTypes​(java.lang.String[] value)
        Sets a list of node types to filter the results on.

      • getIncludeTypes

        public java.lang.String[] getIncludeTypes()
        Gets a list of node types to filter the results on.

      • setIncludeTypes

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

      • getIncludeTypes

        public java.lang.String getIncludeTypes​(int index)
        Gets the value at the specified index in the IncludeTypes array.

      • setNameFilter

        public void setNameFilter​(java.lang.String value)
        Sets a partial name to filter results against.

      • getNameFilter

        public java.lang.String getNameFilter()
        Gets a partial name to filter results against.

      • setPageContext

        public void setPageContext​(java.lang.String value)
        Sets the state token from prior call's NodePageResult.

      • getPageContext

        public java.lang.String getPageContext()
        Gets the state token from prior call's NodePageResult.

      • setPageNumber

        public void setPageNumber​(int value)
        Sets the page number requested.

      • getPageNumber

        public int getPageNumber()
        Gets the page number requested.

      • setPageSize

        public void setPageSize​(int value)
        Sets the number of items per page.

      • getPageSize

        public int getPageSize()
        Gets the number of items per page.

      • setTypeFilter

        public void setTypeFilter​(java.lang.String value)
        Sets the name of a type to use for filtering the results.

      • getTypeFilter

        public java.lang.String getTypeFilter()
        Gets the name of a type to use for filtering the results.

      • 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