public final class UIHttpManagerComponentReturnCode extends Object
UIHttpManagerComponent
.
The return code is added to the redirection URI
(see method UIHttpManagerComponent.setRedirectionURI(String)
).
When the target application receives the redirection, it can extract the return code
from the incoming request by calling
UIHttpManagerComponentHelper.getReturnCodeFromHttpRequest(HttpServletRequest)
.
Modifier and Type | Field and Description |
---|---|
static UIHttpManagerComponentReturnCode |
MERGE_CANCEL
This code is returned when a merge has been cancelled by the user.
|
static UIHttpManagerComponentReturnCode |
MERGE_DONE
This code is returned when a merge has been processed successfully.
|
static UIHttpManagerComponentReturnCode |
MERGE_ERROR
This code is returned when an error occurs during merge.
|
static UIHttpManagerComponentReturnCode |
NOTHING_TO_MERGE
This code is returned when there are no modifications to merge.
|
Modifier and Type | Method and Description |
---|---|
String |
format() |
String |
getLabel(Locale aLocale)
Returns a localized label for this return code.
|
boolean |
hasMergeError() |
boolean |
hasNothingToMerge() |
boolean |
isMergeCancelled() |
boolean |
isMergeDone() |
static UIHttpManagerComponentReturnCode |
parse(String aCode)
Parses the specified string so as to return a 'return code' object.
|
public static final UIHttpManagerComponentReturnCode MERGE_DONE
public static final UIHttpManagerComponentReturnCode MERGE_CANCEL
public static final UIHttpManagerComponentReturnCode NOTHING_TO_MERGE
public static final UIHttpManagerComponentReturnCode MERGE_ERROR
public boolean isMergeDone()
MERGE_DONE
public boolean isMergeCancelled()
MERGE_CANCEL
public boolean hasNothingToMerge()
NOTHING_TO_MERGE
public boolean hasMergeError()
MERGE_ERROR
public String format()
parse(String)
public static UIHttpManagerComponentReturnCode parse(String aCode)
format()