Skip navigation links

oracle.idm.util.progress.info
Class StatusInfo

java.lang.Object
oracle.idm.util.progress.info.StatusInfo

All Implemented Interfaces:

java.lang.Cloneable, XmlPrintable

public class StatusInfo

extends java.lang.Object

implements java.lang.Cloneable, XmlPrintable

StatusInfo represents status information about the operation whose progress is being reported.

Field Summary

static java.lang.String	ERROR
static java.lang.String	OK
static java.lang.String	PING
static java.lang.String	TIMEOUT
static java.lang.String	TRANSITION_FAILURE
static java.lang.String	TRANSITION_REQUEST_FAILURE
static java.lang.String	TRANSITION_REQUEST_SUCCESS
static java.lang.String	TRANSITION_SUCCESS
static int	UNKNOWN UNKNOWN has a value of -1 and indicates unknown error or warning totals.
static java.lang.String	WARNING

Constructor Summary

StatusInfo(java.lang.String current)
Creates StatusInfo.

Method Summary

java.lang.Object	clone() Clones StatusInfo.
java.lang.String	getCurrent() Getter for the current property.
int	getErrorTotal() Getter for the error total property.
int	getWarningTotal() Getter for the warning total property.
void	setCurrent(java.lang.String current) Setter for the current property.
void	setErrorTotal(int errorTotal) Setter for the error total property.
void	setWarningTotal(int warningTotal) Setter for the warning total property.
java.lang.String	toString() Returns a string representation of StatusInfo.
void	xprint(XmlPrintWriter out) Prints statusInfo properties to the PrintWriter as an XML element.

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final java.lang.String OK

See Also:

Constant Field Values

PING

public static final java.lang.String PING

See Also:

Constant Field Values

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

WARNING

public static final java.lang.String WARNING

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

TRANSITION_SUCCESS

public static final java.lang.String TRANSITION_SUCCESS

See Also:

Constant Field Values

TRANSITION_FAILURE

public static final java.lang.String TRANSITION_FAILURE

See Also:

Constant Field Values

TRANSITION_REQUEST_SUCCESS

public static final java.lang.String TRANSITION_REQUEST_SUCCESS

See Also:

Constant Field Values

TRANSITION_REQUEST_FAILURE

public static final java.lang.String TRANSITION_REQUEST_FAILURE

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

UNKNOWN has a value of -1 and indicates unknown error or warning totals. If error or warning total is set to UNKNOWN (which is the default), ProgressReporter will total errors and warnings automatically.

See Also:

Constant Field Values

Constructor Detail

StatusInfo

public StatusInfo(java.lang.String current)

Creates StatusInfo.

Parameters:

current - String representation of the current status.

Method Detail

clone

public java.lang.Object clone()

Clones StatusInfo.

Overrides:

clone in class java.lang.Object

getCurrent

public java.lang.String getCurrent()

Getter for the current property. Value of null indicates unknown current status.

Returns:

String representation of the current status.

setCurrent

public void setCurrent(java.lang.String current)

Setter for the current property. Use value of null to indicate unknown current status.

Parameters:

current - String representation of the current status.

getErrorTotal

public int getErrorTotal()

Getter for the error total property. Value of UNKNOWN indicates unknown error total.

Returns:

int representation of the error total.

setErrorTotal

public void setErrorTotal(int errorTotal)

Setter for the error total property. Use value of UNKNOWN to indicate unknown error total.

Parameters:

errorTotal - int representation of the error total.

getWarningTotal

public int getWarningTotal()

Getter for the warning total property. Value of UNKNOWN indicates unknown warning total.

Returns:

int representation of the warning total.

setWarningTotal

public void setWarningTotal(int warningTotal)

Setter for the warning total property. Use value of UNKNOWN to indicate unknown warning total.

Parameters:

warningTotal - int representation of the warning total.

xprint

public void xprint(XmlPrintWriter out)

Prints statusInfo properties to the PrintWriter as an XML element.

Specified by:

xprint in interface XmlPrintable

Parameters:

out - PrintWriter for printing statusInfo propeties.

toString

public java.lang.String toString()

Returns a string representation of StatusInfo.

Overrides:

toString in class java.lang.Object

Skip navigation links