|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.ocap.hn.NetActionEvent
public class NetActionEvent
This class represents an event generated in response to an action. NetActionEvent instances can only be created by the implementation.
Field Summary | |
---|---|
static int |
ACTION_CANCELED
ACTION_CANCELED is returned by getActionStatus()
when the action has been canceled. |
static int |
ACTION_COMPLETED
Action status for a completed action |
static int |
ACTION_FAILED
ACTION_FAILED is returned by getActionStatus()
when the action has failed. |
static int |
ACTION_NEEDS_MORE_TIME
ACTION_NEEDS_MORE_TIME is returned by
getActionStatus() when the action needs more time to complete. |
static int |
ACTION_STATUS_NOT_AVAILABLE
ACTION_STATUS_NOT_AVAILABLE is returned by
getActionStatus() when the transaction has completed
successfully or failed sometime before this method was called and the
implementation is no longer maintaining a status for it. |
static int |
ERROR_COMMUNICATIONS
Error code returned when a general communications error occurs. |
static int |
ERROR_INVALID_CRITERIA
Error code returned when the criteria for an action is not understood or otherwise supported by the target. |
static int |
ERROR_INVALID_PARAMETER
Error code returned when an action was created with invalid parameters. |
static int |
ERROR_TIMED_OUT
Error code returned when the operation timed out. |
static int |
ERROR_UNAUTHORIZED
Error code returned when the requested action couldn't be executed because of missing permissions. |
Method Summary | |
---|---|
NetActionRequest |
getActionRequest()
Returns the ActionRequest which identifies the action instance. |
int |
getActionStatus()
Returns the status of the requested action. |
int |
getError()
Gets the error value when getActionStatus returns NetActionEvent.ACTION_FAILED . |
Object |
getResponse()
Returns the response of the Action. |
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ERROR_TIMED_OUT
public static final int ERROR_INVALID_PARAMETER
public static final int ERROR_UNAUTHORIZED
public static final int ERROR_COMMUNICATIONS
public static final int ERROR_INVALID_CRITERIA
public static final int ACTION_COMPLETED
getActionStatus()
,
Constant Field Valuespublic static final int ACTION_CANCELED
ACTION_CANCELED
is returned by getActionStatus()
when the action has been canceled.
getActionStatus()
,
Constant Field Valuespublic static final int ACTION_FAILED
ACTION_FAILED
is returned by getActionStatus()
when the action has failed.
getActionStatus()
,
Constant Field Valuespublic static final int ACTION_NEEDS_MORE_TIME
ACTION_NEEDS_MORE_TIME
is returned by
getActionStatus()
when the action needs more time to complete.
This event MAY be sent after an implementation specific number of
seconds to indicate that the action is still executed but might need
more time. It is up to the application to cancel the action or wait.
getActionStatus()
,
Constant Field Valuespublic static final int ACTION_STATUS_NOT_AVAILABLE
ACTION_STATUS_NOT_AVAILABLE
is returned by
getActionStatus()
when the transaction has completed
successfully or failed sometime before this method was called and the
implementation is no longer maintaining a status for it.
Method Detail |
---|
public Object getResponse()
public NetActionRequest getActionRequest()
public int getActionStatus()
public int getError()
NetActionEvent.ACTION_FAILED
. If the action is not in
error this method SHALL return -1.
NetActionEvent
for possible return values.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |