com.sas.hls.client
Class ActionStatusEntry

java.lang.Object
  extended by com.sas.hls.client.ActionStatusEntry
All Implemented Interfaces:
Serializable

public class ActionStatusEntry
extends Object
implements Serializable

ActionStatusEntry represents the status of an entry from a batch method. It includes the path of the item as well as a code indicating the outcome. The code is in the format info.ok or error.fileLocked. The first part identifying the general outcome and the latter indicates if and why the action occurred.

See Also:
Serialized Form

Constructor Summary
ActionStatusEntry(String path, String messageCode)
          Constructor
 
Method Summary
 String getMessageCode()
          Gets the code containing status and message information.
 String getPath()
          Gets the path of the entry
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActionStatusEntry

public ActionStatusEntry(String path,
                         String messageCode)
Constructor

Parameters:
path - Path of the entry
messageCode - Code containing status and message info. The code is in the format info.ok or error.fileLocked. The first part identifies the general outcome and the latter indicates if and why the action occurred.
Method Detail

getPath

public String getPath()
Gets the path of the entry

Returns:
String path

getMessageCode

public String getMessageCode()
Gets the code containing status and message information. The code is in the format info.ok or error.fileLocked. The first part identifies the general outcome and the latter indicates if and why the action occurred. Use this code to look up descriptive status messages here ActionStatus.getEntryMessage(String).

Returns:
String message code

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


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