psdi.util

Class MXApplicationYesNoCancelException

java.lang.Object

java.lang.Throwable

java.lang.Exception

psdi.util.MXException

psdi.util.MXApplicationException

psdi.util.MXApplicationYesNoCancelException

All Implemented Interfaces:

java.io.Serializable

public class MXApplicationYesNoCancelException
extends MXApplicationException

Represents a yes/no/cancel exception that can occur during filed setValue() validation or any action. When an exception of this type is thrown, the client programs can take input from the user to either not proceed, or pass yes or no back to the server by calling the same server method again after posting the answer to the bulletin board.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL
static int	NO
static int	NULL
static int	OK
static int	YES

Fields inherited from class psdi.util.MXException

detail, params

Constructor Summary

Constructors

Constructor and Description
MXApplicationYesNoCancelException(java.lang.String id, java.lang.String eg, java.lang.String ek) Construct an exception with the error group and key
MXApplicationYesNoCancelException(java.lang.String id, java.lang.String eg, java.lang.String ek, java.lang.Object[] params) Construct an exception with the error group, key and additonal params
MXApplicationYesNoCancelException(java.lang.String id, java.lang.String eg, java.lang.String ek, java.lang.Object[] p, java.lang.Throwable t) Construct an exception with the error group, key, parameters and the nested exception
MXApplicationYesNoCancelException(java.lang.String id, java.lang.String eg, java.lang.String ek, java.lang.Throwable t) Construct an exception with the error group,key and nested exception

Method Summary

Modifier and Type	Method and Description
int	getContinueEvents()
java.lang.String	getId() Get the identifier of the exception.
int	getUserClickedValue()
static int	getUserInput(java.lang.String id, MXServerRemote server, UserInfo ui) Static method to get the message posted on the bulletin board responding to this type of exception.
void	postUserInput(MXServerRemote server, int answer, UserInfo ui) Post the user input.
void	setContinueEvents(int responses) Set the user responses that when UI recieves will continue with the other queued events.

Methods inherited from class psdi.util.MXException

equals, getDetail, getDisplayMessage, getErrorAttr, getErrorAttrValue, getErrorCorrelationId, getErrorGroup, getErrorKey, getErrorObjectName, getForcedLangCode, getMessage, getMessage, getParameters, hasDetail, hasParameters, isServerSide, log, setErrorAttr, setErrorAttrValue, setErrorCorrelationId, setErrorObjectName, setForcedLangCode, setServerSide

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OK

public static final int OK

See Also:

Constant Field Values

CANCEL

public static final int CANCEL

See Also:

Constant Field Values

YES

public static final int YES

See Also:

Constant Field Values

NO

public static final int NO

See Also:

Constant Field Values

NULL

public static final int NULL

See Also:

Constant Field Values

Constructor Detail

MXApplicationYesNoCancelException

public MXApplicationYesNoCancelException(java.lang.String id,
                                         java.lang.String eg,
                                         java.lang.String ek)

Construct an exception with the error group and key

MXApplicationYesNoCancelException

public MXApplicationYesNoCancelException(java.lang.String id,
                                         java.lang.String eg,
                                         java.lang.String ek,
                                         java.lang.Object[] params)

Construct an exception with the error group, key and additonal params

MXApplicationYesNoCancelException

public MXApplicationYesNoCancelException(java.lang.String id,
                                         java.lang.String eg,
                                         java.lang.String ek,
                                         java.lang.Throwable t)

Construct an exception with the error group,key and nested exception

MXApplicationYesNoCancelException

public MXApplicationYesNoCancelException(java.lang.String id,
                                         java.lang.String eg,
                                         java.lang.String ek,
                                         java.lang.Object[] p,
                                         java.lang.Throwable t)

Construct an exception with the error group, key, parameters and the nested exception

Method Detail

getId

public java.lang.String getId()

Get the identifier of the exception. The identifier is understood by both the creator of the exception and the code which examings the user input. The id is unique though the maximo code base.

Returns:

postUserInput

public void postUserInput(MXServerRemote server,
                          int answer,
                          UserInfo ui)

Post the user input.

Parameters:

server -

answer - user input as integer of YES, NO, OK and CANCEL

ui -

getUserInput

public static int getUserInput(java.lang.String id,
                               MXServerRemote server,
                               UserInfo ui)
                        throws java.rmi.RemoteException

Static method to get the message posted on the bulletin board responding to this type of exception.

Parameters:

id -

server -

ui -

Returns:

the int value defined as YES, NO, CANCEL, OK. -1 means no user input

Throws:

java.rmi.RemoteException

setContinueEvents

public void setContinueEvents(int responses)

Set the user responses that when UI recieves will continue with the other queued events. For example, if you want when user clicks OK, the have the UI continue processing other queued UI events, you should call setContinuedEvents(MXApplicationYesNoCancelException.OK) when you construct the MXApplicatonYesNoCancelException.

Parameters:

responses, - the bit values of the user response ored together.

getContinueEvents

public int getContinueEvents()

getUserClickedValue

public int getUserClickedValue()
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException