com.ibm.itim.dataservices.model
Class SearchResultsStatus

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.SearchResultsStatus
All Implemented Interfaces:
java.io.Serializable

public class SearchResultsStatus
extends java.lang.Object
implements java.io.Serializable

Class that represents result information from search.

See Also:
Serialized Form

Field Summary
static int OTHER
          There was an unspecified problem with the search.
static int SIZE_LIMIT_EXCEEDED
          The size limit was exceeded when performing the search.
static java.lang.String SIZE_LIMIT_KEY
          A key to look up size limit exceeded message in resource bundle
static int SUCCESS
          There was no problem with the search.
static java.lang.String UNSPECIFIED_ERROR_KEY
          A key to look up unspecified message relating to search results in resource bundle
 
Constructor Summary
SearchResultsStatus()
          Default constructor.
SearchResultsStatus(int reason, ModelException e)
          Constructs with a problem reason and a causing exception (if any).
 
Method Summary
 ModelException getException()
          Returns the exception (if any) that caused the problem with the search.
 int getStatusCode()
          Gets the completion status of the search request.
 java.lang.String getStatusKey()
          Returns a key used to lookup a description of the result status in a resource bundle.
 void setException(ModelException e)
          Changes the exception (if any) that caused the problem with the search.
 void setStatusCode(int code)
          Changes the completion status of the search request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SUCCESS

public static final int SUCCESS
There was no problem with the search.

OTHER

public static final int OTHER
There was an unspecified problem with the search.

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED
The size limit was exceeded when performing the search.

SIZE_LIMIT_KEY

public static final java.lang.String SIZE_LIMIT_KEY
A key to look up size limit exceeded message in resource bundle

UNSPECIFIED_ERROR_KEY

public static final java.lang.String UNSPECIFIED_ERROR_KEY
A key to look up unspecified message relating to search results in resource bundle
Constructor Detail

SearchResultsStatus

public SearchResultsStatus()
Default constructor. Default reason (status) is SUCCESS.

SearchResultsStatus

public SearchResultsStatus(int reason,
                           ModelException e)
Constructs with a problem reason and a causing exception (if any).
Parameters:
reason - Reason for the problem with the search, NONE, SIZE_LIMIT_EXCEEDED, OTHER.
e - ModelException (if any) that caused the error, null if none was generated.
Method Detail

getStatusCode

public int getStatusCode()
Gets the completion status of the search request.
Returns:
The status code of the search, SUCCESS, SIZE_LIMIT_EXCEEDED, OTHER.

setStatusCode

public void setStatusCode(int code)
Changes the completion status of the search request.
Parameters:
code - The status code of the search, SUCCESS, SIZE_LIMIT_EXCEEDED, OTHER.

getException

public ModelException getException()
Returns the exception (if any) that caused the problem with the search.
Returns:
ModelException that caused the problem, none if no exception was generated.

setException

public void setException(ModelException e)
Changes the exception (if any) that caused the problem with the search.
Parameters:
e - ModelException (if any) that caused the error, null if none was generated.

getStatusKey

public java.lang.String getStatusKey()
Returns a key used to lookup a description of the result status in a resource bundle.
Returns:
The resource bundle key.