Package com.sas.lsaf.core.action

Class ActionStatusDetail

java.lang.Object
com.sas.lsaf.core.action.ActionStatusDetail
All Implemented Interfaces:
Serializable
public class ActionStatusDetail extends Object implements Serializable
Represents the status of an individual step of an action completed in the system. The completion status will indicate if this particular step completed successfully or not.
Since:
2.1
See Also:

  • Constructor Details

    • ActionStatusDetail

      public ActionStatusDetail(String id, String itemIdentifier, String itemLocation, String itemName, String messageCode, String message, ActionStatus.CompletionStatus completionStatus)
      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 the ActionStatus returned from batch service calls.
      Parameters:
      id - the id of this action detail.
      itemIdentifier - the identifier of the item. This could be the item's UUID, full path or some other uniquely identifying attribute.
      itemLocation - the location of the item. It will be the parent path of the item's full path IF a path is being used is the item identifier.
      itemName - the name or display name for this item.
      messageCode - the completion message code of the item.
      message - the completion summary message of the item.
      completionStatus - the completion status enum value indicating the most severe outcome (ERROR) encountered during the action.

  • Method Details

    • getId

      public String getId()
      Get the id of this action detail.
      Returns:
      the id of this action detail.

    • getItemIdentifier

      public String getItemIdentifier()
      Get the identifier of the item. This could be the item's UUID, full path or some other uniquely identifying attribute.
      Returns:
      the identifier of the item acted on

    • getItemLocation

      public String getItemLocation()
      Get the location of the item. It will be the parent path of the item's full path IF a path is being used is the item identifier. This field can be null.
      Returns:
      the parent location of the item acted on.

    • getItemName

      public String getItemName()
      Get the name or display name for this item. This will never be null.
      Returns:
      the name of the item acted on.

    • getMessageCode

      public String getMessageCode()
      Get the message code of the item.
      Returns:
      the message code of the item.

    • getMessage

      public String getMessage()
      Get the message of the of the item.
      Returns:
      the message of the of the item.

    • getCompletionStatus

      public ActionStatus.CompletionStatus getCompletionStatus()
      Get the completion status enum value indicating the most severe outcome (ERROR) encountered during the action.
      Returns:
      the completion status enum value indicating the most severe outcome (ERROR) encountered during the action.

    • toString

      public String toString()
      Overrides:
      toString in class Object