Package com.opentext.livelink.service.memberservice

Class MemberSearchOptions

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class MemberSearchOptions
extends ServiceDataObject
implements java.io.Serializable
    MemberSearchOptions sets the criteria used to find a members in the system.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SearchColumn getColumn()
      Gets the column to search.
      long getDomainID()
      Gets the ID of the domain to search in.
      SearchFilter getFilter()
      Gets the types to return in the output.
      long getGroupID()
      Gets the ID of the group to search in.
      SearchMatching getMatching()
      Gets the matching method for the search.
      int getPageSize()
      Gets the maximum number of members to return.
      SearchScope getScope()
      Gets the scope of the search.
      java.lang.String getSearch()
      Gets the string to search for.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setColumn​(SearchColumn value)
      Sets the column to search.
      void setDomainID​(long value)
      Sets the ID of the domain to search in.
      void setFilter​(SearchFilter value)
      Sets the types to return in the output.
      void setGroupID​(long value)
      Sets the ID of the group to search in.
      void setMatching​(SearchMatching value)
      Sets the matching method for the search.
      void setPageSize​(int value)
      Sets the maximum number of members to return.
      void setScope​(SearchScope value)
      Sets the scope of the search.
      void setSearch​(java.lang.String value)
      Sets the string to search for.
      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

      • MemberSearchOptions

        public MemberSearchOptions()

    • Method Detail

      • setColumn

        public void setColumn​(SearchColumn value)
        Sets the column to search.

      • getColumn

        public SearchColumn getColumn()
        Gets the column to search.

      • setDomainID

        public void setDomainID​(long value)
        Sets the ID of the domain to search in. This option is only used if Scope is set to SYSTEM and the user has permissions to access other domains.

      • getDomainID

        public long getDomainID()
        Gets the ID of the domain to search in. This option is only used if Scope is set to SYSTEM and the user has permissions to access other domains.

      • setFilter

        public void setFilter​(SearchFilter value)
        Sets the types to return in the output.

      • getFilter

        public SearchFilter getFilter()
        Gets the types to return in the output.

      • setGroupID

        public void setGroupID​(long value)
        Sets the ID of the group to search in. This option is only used if Scope is set to GROUP.

      • getGroupID

        public long getGroupID()
        Gets the ID of the group to search in. This option is only used if Scope is set to GROUP.

      • setMatching

        public void setMatching​(SearchMatching value)
        Sets the matching method for the search.

      • getMatching

        public SearchMatching getMatching()
        Gets the matching method for the search.

      • setPageSize

        public void setPageSize​(int value)
        Sets the maximum number of members to return.

      • getPageSize

        public int getPageSize()
        Gets the maximum number of members to return.

      • setScope

        public void setScope​(SearchScope value)
        Sets the scope of the search.

      • getScope

        public SearchScope getScope()
        Gets the scope of the search.

      • setSearch

        public void setSearch​(java.lang.String value)
        Sets the string to search for. An empty string matches everything.

      • getSearch

        public java.lang.String getSearch()
        Gets the string to search for. An empty string matches everything.

      • 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