Package com.opentext.livelink.service.workflowservice

Class ProcessSearchOptions

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class ProcessSearchOptions
extends ServiceDataObject
implements java.io.Serializable
    ProcessSearchOptions controls which process instances are listed
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SearchFilter getFilter()
      Gets how to filter ProcessInstances during a search.
      int getPageSize()
      Gets the number of results per page.
      java.lang.Boolean getRetrieveActivities()
      Gets whether or not to retrieve the ActivityInstances for the Process.
      java.lang.Boolean getRetrieveProcessData()
      Gets whether or not to retrieve the ApplicationData for the Process.
      java.lang.String getWhere()
      Gets the advanced search filtering options.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setFilter​(SearchFilter value)
      Sets how to filter ProcessInstances during a search.
      void setPageSize​(int value)
      Sets the number of results per page.
      void setRetrieveActivities​(java.lang.Boolean value)
      Sets whether or not to retrieve the ActivityInstances for the Process.
      void setRetrieveProcessData​(java.lang.Boolean value)
      Sets whether or not to retrieve the ApplicationData for the Process.
      void setWhere​(java.lang.String value)
      Sets the advanced search filtering options.
      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

      • ProcessSearchOptions

        public ProcessSearchOptions()

    • Method Detail

      • setFilter

        public void setFilter​(SearchFilter value)
        Sets how to filter ProcessInstances during a search.

      • getFilter

        public SearchFilter getFilter()
        Gets how to filter ProcessInstances during a search.

      • setPageSize

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

      • getPageSize

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

      • setRetrieveActivities

        public void setRetrieveActivities​(java.lang.Boolean value)
        Sets whether or not to retrieve the ActivityInstances for the Process.

      • getRetrieveActivities

        public java.lang.Boolean getRetrieveActivities()
        Gets whether or not to retrieve the ActivityInstances for the Process.

      • setRetrieveProcessData

        public void setRetrieveProcessData​(java.lang.Boolean value)
        Sets whether or not to retrieve the ApplicationData for the Process.

      • getRetrieveProcessData

        public java.lang.Boolean getRetrieveProcessData()
        Gets whether or not to retrieve the ApplicationData for the Process.

      • setWhere

        public void setWhere​(java.lang.String value)
        Sets the advanced search filtering options.

      • getWhere

        public java.lang.String getWhere()
        Gets the advanced search filtering options.

      • 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