ActionResult (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Action Framework)

java.lang.Object
- oracle.fmwplatform.actionframework.api.v2.ActionResult

```
public class ActionResult
extends Object
```
The result returned from Action methods to provide information on the success or failure of the method. If more than one error occurred then they will be contained within the list of results contained within the ActionResult. If the ActionResult has its Status Code set then the list of ActionResults will be ignored. Care should be used to not use both the root of an ActionResult and also its list of ActionResults. It is better to use a list containing only a single ActionResult when it is uncertain whether there will be multiple results or not.

Field Summary

Fields
Modifier and Type Field and Description

static String HOST_VERIFY_checkIPAddresses

Fields
Modifier and Type	Field and Description
`static String`	`HOST_VERIFY_checkIPAddresses`

Constructor Summary

Constructors
Constructor and Description
`ActionResult()` Default constructor for ActionResult.
`ActionResult(ActionStatusCode statusCode, String statusDetail)` Construct ActionResult object.
`ActionResult(ActionStatusCode statusCode, String statusDetail, oracle.fmwplatform.envspec.model.targets.ModelTarget target)` Construct ActionResult object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionResult`	`addActionResult(ActionResult actionResult)` Adds the actionResult to this actionResult.
`List<ActionResult>`	`getActionResultList()` Return a list of ActionResult outlining the outcome of the action on each component of the target.
`String`	`getAdvancedDetail()` Return advanced detail information that may be useful to someone with technical skills.
`String`	`getMessageId()` Returns the message Id used to compose the Status Detail for this ActionResult.
`Map<String,String>`	`getResultMap()` Get a map that can be used to return data back to the caller.
`String`	`getResultMapValue(String key)` Return the value of an entry in the result map.
`ActionStatusCode`	`getStatusCode()` Get status code.
`String`	`getStatusDetail()` Get a status detail string associated with the status code.
`oracle.fmwplatform.envspec.model.targets.ModelTarget`	`getTarget()` Get the EnvironmentModelTarget object this ActionResult object belongs to.
`boolean`	`isSuccessful()` Return true if the statusCode is a successful one.
`ActionResult`	`setAdvancedDetail(String advancedDetail)` Set advanced detail information that may be useful to someone with technical skills.
`ActionResult`	`setMessageId(String messageId)` Sets the message Id used to compose the Status Detail for this ActionResult.
`ActionResult`	`setResultMap(Map<String,String> returnMap)` Set the map that can be user to return data to the caller.
`ActionResult`	`setResultMapValue(String key, String value)` Set the value of an entry on the result map.
`ActionResult`	`setStatusCode(ActionStatusCode statusCode)` Set the status code for this result.
`ActionResult`	`setStatusDetail(String statusDetail)` Set the status detail.
`ActionResult`	`setTarget(oracle.fmwplatform.envspec.model.targets.ModelTarget target)` Set the EnvironmentModelTarget object this ActionResult object belongs to.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HOST_VERIFY_checkIPAddresses
```
public static final String HOST_VERIFY_checkIPAddresses
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ActionResult
```
public ActionResult()
```
    Default constructor for ActionResult.
  - ActionResult
```
public ActionResult(ActionStatusCode statusCode,
                    String statusDetail)
```
    Construct ActionResult object.
    
    Parameters:
    
    statusCode - ActionStatusCode that indicates the outcome of the action
    
    statusDetail - This message provide more details about the outcome
  - ActionResult
```
public ActionResult(ActionStatusCode statusCode,
                    String statusDetail,
                    oracle.fmwplatform.envspec.model.targets.ModelTarget target)
```
    Construct ActionResult object.
    
    Parameters:
    
    statusCode - ActionStatusCode that indicates the outcome of the action
    
    statusDetail - This message provide more details about the outcome
    
    target - EnvironmentModelTarget object on which the action is invoked
- Method Detail
  - getActionResultList
```
public List<ActionResult> getActionResultList()
```
    Return a list of ActionResult outlining the outcome of the action on each component of the target. Example: If a start action is run targeting a domain, an attempt will be made to start all the servers in that domain. getActionResultList() will return a list of ActionResult objects where each object is the result of the action on a server.
    
    Returns:
    
    List of ActionResult objects
  - getResultMap
```
public Map<String,String> getResultMap()
```
    Get a map that can be used to return data back to the caller.
    
    Returns:
    
    - statusDetail to set
  - setResultMap
```
public ActionResult setResultMap(Map<String,String> returnMap)
```
    Set the map that can be user to return data to the caller.
    
    Parameters:
    
    returnMap - the map to be set
    
    Returns:
    
    this for method chaining
  - getResultMapValue
```
public String getResultMapValue(String key)
```
    Return the value of an entry in the result map.
    
    Parameters:
    
    key - the key to the entry to be returned
    
    Returns:
    
    the value of the entry or null if none
  - setResultMapValue
```
public ActionResult setResultMapValue(String key,
                                      String value)
```
    Set the value of an entry on the result map.
    
    Parameters:
    
    key - the key of the entry
    
    value - the value of the entry
    
    Returns:
    
    this for method chaining
  - getStatusCode
```
public ActionStatusCode getStatusCode()
```
    Get status code.
    
    Returns:
    
    status code of action invoked.
  - getStatusDetail
```
public String getStatusDetail()
```
    Get a status detail string associated with the status code. For example, if the status code is INVALID_OPTIONS, the statusDetail should indicate which option is invalid. If this ActionResult contains a list of ActionResults then the detail will be the combination of all of the ActionResults.
    
    Returns:
    
    the Status Detail of this ActionResult or a combination of all of the ActionResults from the list of ActionResults .
  - setStatusCode
```
public ActionResult setStatusCode(ActionStatusCode statusCode)
```
    Set the status code for this result.
    
    Parameters:
    
    statusCode - status code to set
    
    Returns:
    
    this for method chaining
  - setStatusDetail
```
public ActionResult setStatusDetail(String statusDetail)
```
    Set the status detail.
    
    Parameters:
    
    statusDetail - statusDetail to set
    
    Returns:
    
    this for method chaining
  - getTarget
```
public oracle.fmwplatform.envspec.model.targets.ModelTarget getTarget()
```
    Get the EnvironmentModelTarget object this ActionResult object belongs to.
    
    Returns:
    
    target
  - setTarget
```
public ActionResult setTarget(oracle.fmwplatform.envspec.model.targets.ModelTarget target)
```
    Set the EnvironmentModelTarget object this ActionResult object belongs to.
    
    Parameters:
    
    target - target to set
    
    Returns:
    
    this for method chaining
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAdvancedDetail
```
public String getAdvancedDetail()
```
    Return advanced detail information that may be useful to someone with technical skills.
    
    Returns:
    
    advanced details
  - getMessageId
```
public String getMessageId()
```
    Returns the message Id used to compose the Status Detail for this ActionResult.
    
    Returns:
    
    the message Id used to compose the Status Detail for this ActionResult
  - setMessageId
```
public ActionResult setMessageId(String messageId)
```
    Sets the message Id used to compose the Status Detail for this ActionResult.
    
    Parameters:
    
    messageId - the message Id used to compose the Status Detail for this ActionResult
    
    Returns:
    
    this ActionResult object (for method chaining)
  - setAdvancedDetail
```
public ActionResult setAdvancedDetail(String advancedDetail)
```
    Set advanced detail information that may be useful to someone with technical skills.
    
    Parameters:
    
    advancedDetail - advanced detail
    
    Returns:
    
    this for method chaining
  - isSuccessful
```
public boolean isSuccessful()
```
    Return true if the statusCode is a successful one.
    
    Returns:
    
    true if the statusCode is a successful otherwise false
  - addActionResult
```
public ActionResult addActionResult(ActionResult actionResult)
```
    Adds the actionResult to this actionResult. If the provided actionResult contains a list of actionResults then they will be added to the list for this actionResult. Duplicate ActionResults are skipped.
    
    Parameters:
    
    actionResult - the actionResult to be added to this actionResults list.
    
    Returns:
    
    true

Class ActionResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HOST_VERIFY_checkIPAddresses

Constructor Detail

ActionResult

ActionResult

ActionResult

Method Detail

getActionResultList

getResultMap

setResultMap

getResultMapValue

setResultMapValue

getStatusCode

getStatusDetail

setStatusCode

setStatusDetail

getTarget

setTarget

toString

getAdvancedDetail

getMessageId

setMessageId

setAdvancedDetail

isSuccessful

addActionResult