com.tangosol.coherence.commonj
Class WorkManager.WorkStatus

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.coherence.commonj.WorkManager.WorkStatus

All Implemented Interfaces:

ExternalizableLite, PortableObject, java.io.Serializable

Enclosing class:

WorkManager

protected static class WorkManager.WorkStatus
extends Base
implements ExternalizableLite, PortableObject

A WorkStatus object is used to communicate a work execution status back to the caller.

Field Summary

static int	WORK_ACCEPTED Work has been accepted.
static int	WORK_COMPLETED Work has been completed.
static int	WORK_REJECTED Work has been rejected or aborted.
static int	WORK_STARTED Work has been started.
protected static int	WORK_UNKNOWN Initial value (work has neither been accepted nor rejected); should not be visible from outside.

Constructor Summary

WorkManager.WorkStatus()
Default constructor (necessary for a lite serialization).

WorkManager.WorkStatus(long lWorkId, int nStatus, java.lang.Object oFeedback)
Construct the WorkStatus object for the specified work id.

Method Summary

static java.lang.String	formatStatus(int nStatus) Return a string representation of the specified status value.
java.lang.Object	getData() Return the work feedback data.
int	getStatus() Return the work execution status.
long	getWorkId() Return the work id.
void	readExternal(java.io.DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object.
void	readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object.
java.lang.String	toString() Return a human-readable description.
void	writeExternal(java.io.DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object.
void	writeExternal(PofWriter out) Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Field Detail

WORK_UNKNOWN

protected static final int WORK_UNKNOWN

Initial value (work has neither been accepted nor rejected); should not be visible from outside.

See Also:

Constant Field Values

WORK_ACCEPTED

public static final int WORK_ACCEPTED

Work has been accepted.

See Also:

Constant Field Values

WORK_REJECTED

public static final int WORK_REJECTED

Work has been rejected or aborted.

See Also:

Constant Field Values

WORK_STARTED

public static final int WORK_STARTED

Work has been started.

See Also:

Constant Field Values

WORK_COMPLETED

public static final int WORK_COMPLETED

Work has been completed. This is an overloaded status: it may indicate that a task got successfully completed, abnormally terminated by throwing an exception or was released upon a client request. The feedback data should be analyized to figure out which of these cases indeed apply.

See Also:

Constant Field Values

Constructor Detail

WorkManager.WorkStatus

public WorkManager.WorkStatus()

Default constructor (necessary for a lite serialization).

WorkManager.WorkStatus

public WorkManager.WorkStatus(long lWorkId,
                              int nStatus,
                              java.lang.Object oFeedback)

Construct the WorkStatus object for the specified work id.

Parameters:

lWorkId - the Work id

nStatus - one of the WORK_* constants

oFeedback - the feedback object

Method Detail

getWorkId

public long getWorkId()

Return the work id.

Returns:

the work id

getStatus

public int getStatus()

Return the work execution status.

Returns:

one of the WORK_* constants

getData

public java.lang.Object getData()

Return the work feedback data.

Returns:

the associated feedback object

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

java.io.IOException - if an I/O exception occurs

java.io.NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

java.io.IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws java.io.IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

java.io.IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws java.io.IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()

Return a human-readable description.

formatStatus

public static java.lang.String formatStatus(int nStatus)

Return a string representation of the specified status value.

Parameters:

nStatus - one of the WORK_* constants

Returns:

the corresponding string representation