com.ibm.websphere.wim.async

Class Ticket

  • java.lang.Object
    • com.ibm.websphere.wim.async.Ticket


  • public class Ticket
    extends java.lang.Object
    This class defines the fields and methods that a ticket needs. The adapter should use this class to build the ticket.
    • Constructor Summary

      Constructors 
      Constructor and Description
      Ticket(java.lang.String ticketStr)
      Construct the Ticket from string form of the ticket
      Ticket(java.lang.String inputRepoId, java.lang.Object inputTicket)
      Construct the Ticket
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getCountLimit()
      Returns the count limit
      int getPagingSize()
      Returns the paging size
      java.lang.String getPostProcess()
      Return the post process string(if any) set for this ticket
      java.lang.String getRepositoryId()
      Return the id of the repository which generated this ticket
      int getSearchLimit()
      Returns the search limit
      java.lang.Object getTicket()
      Return the opaque ticket object
      void setCountLimit(int limit)
      Sets the count limit of a search operation
      void setPagingSize(int size)
      Sets the paging size
      void setPostProcess(java.lang.String inputPostProcess)
      set the post process string
      void setSearchLimit(int limit)
      Sets the search limit of a search operation
      java.lang.String toString()
      Return the string form of the ticket.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Ticket

        public Ticket(java.lang.String inputRepoId,
              java.lang.Object inputTicket)
        Construct the Ticket
        Parameters:
        inputRepoId - id of the repository creating this ticket
        inputTicket - opaque ticket object
    • Method Detail

      • getRepositoryId

        public java.lang.String getRepositoryId()
        Return the id of the repository which generated this ticket
        Return:
        repository id
      • getPostProcess

        public java.lang.String getPostProcess()
        Return the post process string(if any) set for this ticket
        Return:
        post process string
      • setPostProcess

        public void setPostProcess(java.lang.String inputPostProcess)
        set the post process string
        Parameters:
        inputPostProcess -
      • getTicket

        public java.lang.Object getTicket()
        Return the opaque ticket object
        Return:
        ticket
      • getPagingSize

        public int getPagingSize()
        Returns the paging size
        Return:
        the number of entities will be return in a page
      • setPagingSize

        public void setPagingSize(int size)
        Sets the paging size
        Parameters:
        size - the number of entities you want to return
      • setCountLimit

        public void setCountLimit(int limit)
        Sets the count limit of a search operation
        Parameters:
        limit - the number of entities you want to return from a search operation
      • getCountLimit

        public int getCountLimit()
        Returns the count limit
        Return:
        the number of entities will be return in a search operation
      • setSearchLimit

        public void setSearchLimit(int limit)
        Sets the search limit of a search operation
        Parameters:
        limit - the number of entities you want to limit on a search operation. If the search results are exceeded the number, an exception will be thrown
      • getSearchLimit

        public int getSearchLimit()
        Returns the search limit
        Return:
        the limit of results for a search operation when an exception thrown
      • toString

        public java.lang.String toString()
        Return the string form of the ticket.
        Overrides:
        toString in class java.lang.Object
        Return:
        string form of the ticket