oracle.dss.util
Class StatusInfo

java.lang.Object
  oracle.dss.util.StatusInfo

public class StatusInfo
extends java.lang.Object

Contains information about the current status of an asynchronous data source

Field Summary

static java.lang.String	DATASOURCE_CANCELED Indicates that the query was canceled
static java.lang.String	DATASOURCE_COMPLETE Indicates that data is available
static java.lang.String	DATASOURCE_ERROR Indicates that an error has occurred
static java.lang.String	DATASOURCE_EXECUTING Indicates that the data source is running
static java.lang.String	DATASOURCE_PENDING_EXECUTION Indicates that the data source is waiting to be executed
protected java.lang.Exception	m_exception
protected java.lang.Object	m_retVal
protected java.lang.String	m_status

Constructor Summary

StatusInfo(java.lang.Exception e)

StatusInfo(java.lang.String status)

StatusInfo(java.lang.String status, java.lang.Object retVal)

Method Summary

java.lang.Exception	getException() Return the exception if an error occurred
java.lang.Object	getReturnValue() Return the API return value, if any and if status is DATASOURCE_COMPLETE
java.lang.String	getStatus() Return the status of the data source
void	setReturnValue(java.lang.Object retVal)

Methods inherited from class java.lang.Object

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

Field Detail

DATASOURCE_COMPLETE

public static final java.lang.String DATASOURCE_COMPLETE

Indicates that data is available

See Also:

Constant Field Values

DATASOURCE_EXECUTING

public static final java.lang.String DATASOURCE_EXECUTING

Indicates that the data source is running

See Also:

Constant Field Values

DATASOURCE_PENDING_EXECUTION

public static final java.lang.String DATASOURCE_PENDING_EXECUTION

Indicates that the data source is waiting to be executed

See Also:

Constant Field Values

DATASOURCE_ERROR

public static final java.lang.String DATASOURCE_ERROR

Indicates that an error has occurred

See Also:

Constant Field Values

DATASOURCE_CANCELED

public static final java.lang.String DATASOURCE_CANCELED

Indicates that the query was canceled

See Also:

Constant Field Values

m_status

protected java.lang.String m_status

For internal use only. Application developers should not use this

m_exception

protected java.lang.Exception m_exception

For internal use only. Application developers should not use this

m_retVal

protected java.lang.Object m_retVal

For internal use only. Application developers should not use this

Constructor Detail

StatusInfo

public StatusInfo(java.lang.String status)

For internal use only. Application developers should not use this

Constructor

StatusInfo

public StatusInfo(java.lang.String status,
                  java.lang.Object retVal)

For internal use only. Application developers should not use this

Constructor

StatusInfo

public StatusInfo(java.lang.Exception e)

For internal use only. Application developers should not use this

Constructor used when an error has occurred

Method Detail

getStatus

public java.lang.String getStatus()

Return the status of the data source

Returns:

status

getException

public java.lang.Exception getException()

Return the exception if an error occurred

Returns:

exception

setReturnValue

public void setReturnValue(java.lang.Object retVal)

Parameters:

retVal - return value to set

For internal use only. Application developers should not use this

Sets the API return value

getReturnValue

public java.lang.Object getReturnValue()

Return the API return value, if any and if status is DATASOURCE_COMPLETE

Returns:

exception