com.orchestranetworks.ui
Class UIHttpManagerComponentReturnCode

java.lang.Object
  com.orchestranetworks.ui.UIHttpManagerComponentReturnCode

public class UIHttpManagerComponentReturnCode

extends Object

Represents the return code of a user interaction initiated by 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).

See Also:

UIHttpManagerComponent.setRedirectionURI(String)

Field Summary

static UIHttpManagerComponentReturnCode	MERGE_CANCEL This code is returned when merge has been cancelled by user.
static UIHttpManagerComponentReturnCode	MERGE_DONE This code is returned when merge has been processed successfully.

Method Summary

String	format()
String	getLabel(Locale aLocale) Returns a localized label for this return code.
boolean	isMergeCancelled()
boolean	isMergeDone()
static UIHttpManagerComponentReturnCode	parse(String aCode) Parses the string specified so as to return a return code object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MERGE_DONE

public static final UIHttpManagerComponentReturnCode MERGE_DONE

This code is returned when merge has been processed successfully.

MERGE_CANCEL

public static final UIHttpManagerComponentReturnCode MERGE_CANCEL

This code is returned when merge has been cancelled by user.

Method Detail

isMergeDone

public boolean isMergeDone()

See Also:

MERGE_DONE

isMergeCancelled

public boolean isMergeCancelled()

See Also:

MERGE_CANCEL

format

public String format()

See Also:

parse(String)

parse

public static UIHttpManagerComponentReturnCode parse(String aCode)

Parses the string specified so as to return a return code object.

See Also:

format()

getLabel

public String getLabel(Locale aLocale)

Returns a localized label for this return code.