Package com.sas.lsaf.core.action

Class ActionStatus

java.lang.Object

com.sas.lsaf.core.action.ActionStatus

All Implemented Interfaces:

Serializable

public class ActionStatus
extends Object
implements Serializable

ActionStatus contains information about the results of a batch operation. It has a completion status and summary message as well as a status for each entry acted upon.

Since:

2.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActionStatus.CompletionStatus	Describes the completion status of either the overall action or an individual action status detail.

Constructor Summary

Constructors

Constructor	Description
ActionStatus(ActionStatus.CompletionStatus completionStatus, String completionMessage)	Initializing constructor which sets the values of all variables.

Method Summary

Modifier and Type	Method	Description
String	getCompletionMessage()	Get the completion summary message describing the outcome of the batch operation.
ActionStatus.CompletionStatus	getCompletionStatus()	Get the completion status enum value indicating the most severe outcome (ERROR) encountered during the batch operation
List<ActionStatusDetail>	getDetails()	Get the detail status entries for all items acted on
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ActionStatus

public ActionStatus(ActionStatus.CompletionStatus completionStatus,
 String completionMessage)

Initializing constructor which sets the values of all variables. It is not intended for consumers of the API to construct these objects directly, rather retrieve them from batch service calls.

Parameters:

completionStatus - the completion status enum value indicating the most severe outcome (ERROR) encountered during the batch operation

completionMessage - the completion summary message describing the outcome of the batch operation.

Method Details

getCompletionStatus

public ActionStatus.CompletionStatus getCompletionStatus()

Get the completion status enum value indicating the most severe outcome (ERROR) encountered during the batch operation

Returns:

CompletionStatus completionStatus

getCompletionMessage

public String getCompletionMessage()

Get the completion summary message describing the outcome of the batch operation.

Returns:

String completionMessage The completion summary message describing the outcome of the batch operation.

getDetails

public List<ActionStatusDetail> getDetails()

Get the detail status entries for all items acted on

Returns:

List of detail status entries

toString

public String toString()

Overrides:

toString in class Object