public class ActionResult extends Object
Constructor and Description |
---|
ActionResult()
Construct an ActionResult object.
|
ActionResult(ActionResultInfoProvider infoProvider)
Construct an ActionResult object with an ActionResultInfoProvider that will provide additional information to be included in the ActionResult message.
|
ActionResult(ActionStatusCode statusCode, String statusDetail)
Construct an ActionResult object
|
ActionResult(ActionStatusCode statusCode, String statusDetail, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
Construct ActionResult object
|
Modifier and Type | Method and Description |
---|---|
ActionResult |
addActionResult(ActionResult actionResult)
Adds the actionResult to this actionResult.
|
ActionResult |
addActionResult(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResult(ActionStatusCode statusCode, String message)
Add a result to the global action result list.
|
ActionResult |
addActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
Add a result to the global action result list.
|
ActionResult |
addActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResult(ActionStatusCode statusCode, String message, Throwable throwable)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId, Object... parameters)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, String messageId)
Add a result to the global action result list.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, String messageId, Object... parameters)
Add a result to the global action result list.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
addActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId, Object... parameters)
Add a result to the global action result list that resulted from Throwable.
|
ActionResult |
createActionResult(ActionStatusCode statusCode, String message)
Create an ActionResult and log it.
|
ActionResult |
createActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
Create an ActionResult and log it.
|
ActionResult |
createActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable)
Create an ActionResult and log it.
|
ActionResult |
createActionResult(ActionStatusCode statusCode, String message, Throwable throwable)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId, Object... parameters)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, String messageId)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, String messageId, Object... parameters)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId)
Create an ActionResult and log it.
|
ActionResult |
createActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId, Object... parameters)
Create an ActionResult and log it.
|
List<ActionResult> |
getActionResultList()
Return a list of ActionResult outlining the outcome of the action on each component of the target.
|
String |
getAdvancedDetail()
Returns 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()
Returns the most appropriate ActionStatusCode based on the status codes contained in the collection of ActionResults.
|
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()
Returns true if the statusCode is a successful one.
|
ActionResult |
setAdvancedDetail(String advancedDetail)
Sets 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 status code.
|
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() |
public ActionResult()
public ActionResult(ActionStatusCode statusCode, String statusDetail)
statusCode
- ActionStatusCode that indicates the outcome of the actionstatusDetail
- This message provide more details about the outcomepublic ActionResult(ActionResultInfoProvider infoProvider)
infoProvider
-public ActionResult(ActionStatusCode statusCode, String statusDetail, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
statusCode
- ActionStatusCode that indicates the outcome of the actionstatusDetail
- This message provide more details about the outcometarget
- EnvironmentModelTarget object on which the action is invokedpublic List<ActionResult> getActionResultList()
ActionResult
objectspublic Map<String,String> getResultMap()
public ActionResult setResultMap(Map<String,String> returnMap)
returnMap
- the map to be setpublic String getResultMapValue(String key)
key
- the key to the entry to be returnedpublic ActionResult setResultMapValue(String key, String value)
key
- the key of the entryvalue
- the value of the entrypublic ActionStatusCode getStatusCode()
public String getStatusDetail()
public ActionResult setStatusCode(ActionStatusCode statusCode)
statusCode
- status code to setpublic ActionResult setStatusDetail(String statusDetail)
statusDetail
- statusDetail to setpublic oracle.fmwplatform.envspec.model.targets.ModelTarget getTarget()
public ActionResult setTarget(oracle.fmwplatform.envspec.model.targets.ModelTarget target)
target
- target to setpublic String getAdvancedDetail()
public String getMessageId()
public ActionResult setMessageId(String messageId)
messageId
- the message Id used to compose the Status Detail for this ActionResultpublic ActionResult setAdvancedDetail(String advancedDetail)
advancedDetail
- advanced detailpublic boolean isSuccessful()
public ActionResult addActionResult(ActionResult actionResult)
actionResult
- the actionResult to be added to this actionResults list.public ActionResult addActionResult(ActionStatusCode statusCode, String message)
statusCode
- the status code for the ActionResulmessage
- the message for the ActionResultpublic ActionResult addActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
statusCode
- the status code for the ActionResulmessage
- the message for the ActionResulttarget
- the ModelTarget that is being processedpublic ActionResult addActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagepublic ActionResult addActionResult(ActionStatusCode statusCode, String message, Throwable throwable)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagepublic ActionResult addActionResult(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, String messageId, Object... parameters)
statusCode
- the status code for the ActionResultmessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId, Object... parameters)
statusCode
- the status code for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId, Object... parameters)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedmessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, String messageId)
statusCode
- the status code for the ActionResulmessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId)
statusCode
- the status code for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult addActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedmessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult createActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagepublic ActionResult createActionResult(ActionStatusCode statusCode, String message)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResultpublic ActionResult createActionResult(ActionStatusCode statusCode, String message, oracle.fmwplatform.envspec.model.targets.ModelTarget target)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResulttarget
- the ModelTarget that is being processedpublic ActionResult createActionResult(ActionStatusCode statusCode, String message, Throwable throwable)
statusCode
- the status code for the ActionResultmessage
- the message for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagepublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, String messageId)
statusCode
- the status code for the ActionResultmessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedmessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId)
statusCode
- the status code for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, String messageId, Object... parameters)
statusCode
- the status code for the ActionResultmessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, String messageId, Object... parameters)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedmessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, Throwable throwable, String messageId, Object... parameters)
statusCode
- the status code for the ActionResultthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageIdpublic ActionResult createActionResultForMessageId(ActionStatusCode statusCode, oracle.fmwplatform.envspec.model.targets.ModelTarget target, Throwable throwable, String messageId, Object... parameters)
statusCode
- the status code for the ActionResulttarget
- the ModelTarget that is being processedthrowable
- a throwable that is to be added to the ActionResult messagemessageId
- the messageId that is to be resolved for the ActionResultparameters
- parameters for substitution into message identified by the messageId