com.sas.hls.client
Class ActionStatus

java.lang.Object
  extended by com.sas.hls.client.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 summary code and summary message as well as a status for each entry acted upon.

See Also:
Serialized Form

Nested Class Summary
static class ActionStatus.SummaryStatusCode
          The possible values of action summary status.
 
Constructor Summary
ActionStatus(ActionStatus.SummaryStatusCode summaryStatusCode, String summaryMessage, List<ActionStatusEntry> entries, Map<String,String> messages)
          Constructor
 
Method Summary
 List<ActionStatusEntry> getEntries()
          Gets status entries for all files acted upon
 String getEntryMessage(String code)
          Looks up the descriptive message based on the code provided
 String getSummaryMessage()
          Gets the summary message describing the outcome of the batch operation.
 ActionStatus.SummaryStatusCode getSummaryStatusCode()
          Gets the summary status code indicating the most severe outcome (ERROR) encountered during the batch operation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionStatus

public ActionStatus(ActionStatus.SummaryStatusCode summaryStatusCode,
                    String summaryMessage,
                    List<ActionStatusEntry> entries,
                    Map<String,String> messages)
Constructor

Parameters:
summaryStatusCode - Code indicating the most severe outcome (ERROR) encountered of all files acted upon
summaryMessage - Summary message describing the summary outcome of all files acted upon.
entries - ActionStatusEntry Status of each file acted upon including code and message
messages - A map containing messages for the action status entries
Method Detail

getEntries

public List<ActionStatusEntry> getEntries()
Gets status entries for all files acted upon

Returns:
List of status entries

getSummaryStatusCode

public ActionStatus.SummaryStatusCode getSummaryStatusCode()
Gets the summary status code indicating the most severe outcome (ERROR) encountered during the batch operation

Returns:
SummaryStatusCode summaryStatusCode

getSummaryMessage

public String getSummaryMessage()
Gets the summary message describing the outcome of the batch operation.

Returns:
String summary message

getEntryMessage

public String getEntryMessage(String code)
Looks up the descriptive message based on the code provided

Parameters:
code - Code to look up message
Returns:
String message based on code


Copyright (c) 2014, SAS Institute Inc., Cary, NC, USA