com.ibm.itim.dataservices.model
Class PartialResultsReason

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.PartialResultsReason

All Implemented Interfaces:

java.io.Serializable

Deprecated. Replaced by SearchResultsStatus.

public class PartialResultsReason

extends java.lang.Object

implements java.io.Serializable

Object to represent result information from search.

See Also:

Serialized Form

Field Summary

static int	NONE Deprecated. There was no problem with the search.
static int	OTHER Deprecated. There was an unspecified problem with the search.
static int	SIZE_LIMIT_EXCEEDED Deprecated. The size limit was exceeded when performing the search.
static java.lang.String	SIZE_LIMIT_KEY Deprecated. A key to look up size limit exceeded message in resource bundle
static java.lang.String	UNSPECIFIED_ERROR_KEY Deprecated. A key to look up unspecified message relating to search results in resource bundle

Constructor Summary

PartialResultsReason()
Deprecated. Default constructor.

PartialResultsReason(int reason, javax.naming.NamingException e)
Deprecated. Constructs with a problem reason and a causing exception (if any).

Method Summary

java.lang.Exception	getException() Deprecated. Returns the exception (if any) that caused the problem with the search.
int	getReason() Deprecated. Gets the reason (if any) for a problem with the search.
java.lang.String	getReasonKey() Deprecated. Gets a key used to lookup an explanation for the partial search results in a resource bundle.
void	setException(java.lang.Exception e) Deprecated. Changes the exception (if any) that caused the problem with the search.
void	setReason(int reason) Deprecated. Changes the reason (if any) for the problem with the search.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

Deprecated.

There was no problem with the search.

See Also:

Constant Field Values

OTHER

public static final int OTHER

Deprecated.

There was an unspecified problem with the search.

See Also:

Constant Field Values

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED

Deprecated.

The size limit was exceeded when performing the search.

See Also:

Constant Field Values

SIZE_LIMIT_KEY

public static final java.lang.String SIZE_LIMIT_KEY

Deprecated.

A key to look up size limit exceeded message in resource bundle

See Also:

Constant Field Values

UNSPECIFIED_ERROR_KEY

public static final java.lang.String UNSPECIFIED_ERROR_KEY

Deprecated.

A key to look up unspecified message relating to search results in resource bundle

See Also:

Constant Field Values

Constructor Detail

PartialResultsReason

public PartialResultsReason()

Deprecated.

Default constructor. Default reason (status) is NONE.

PartialResultsReason

public PartialResultsReason(int reason,
                            javax.naming.NamingException e)

Deprecated.

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 - NamingException (if any) that caused the error, null if none was generated.

Method Detail

getReason

public int getReason()

Deprecated.

Gets the reason (if any) for a problem with the search.

Returns:

The reason for the problem, NONE, SIZE_LIMIT_EXCEEDED, OTHER.

setReason

public void setReason(int reason)

Deprecated.

Changes the reason (if any) for the problem with the search.

Parameters:

reason - Reason for the problem with the search, NONE, SIZE_LIMIT_EXCEEDED, OTHER.

getException

public java.lang.Exception getException()

Deprecated.

Returns the exception (if any) that caused the problem with the search.

Returns:

Exception that caused the problem, none if no exception was generated.

setException

public void setException(java.lang.Exception e)

Deprecated.

Changes the exception (if any) that caused the problem with the search.

Parameters:

e - Exception (if any) that caused the error, null if none was generated.

getReasonKey

public java.lang.String getReasonKey()

Deprecated.

Gets a key used to lookup an explanation for the partial search results in a resource bundle.

Returns:

The key or null if there was no reason