RAPPAction (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.rapp.RAPPAction

Direct Known Subclasses:

RAPPCallClass, RAPPCallHost, RAPPCallObject, RAPPCallPanel, RAPPGlobVar
```
public abstract class RAPPAction
extends Object
```
This abstract class is extended by all RAPP action classes.
It contains basic functionality to serialize a class instance to and from an XML document.
There is standard error mechanism built-in in order to provide useful information when an action hit a non-critical error in the server.

See Also:

RAPPTransaction

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTION_CALL_CLASS` The value for a RAPPCallClass action.
`static int`	`ACTION_CALL_HOST` The value for a RAPPCallHost action.
`static int`	`ACTION_CALL_OBJECT` The value for a RAPPCallObject action.
`static int`	`ACTION_CALL_PANEL` The value for a RAPPCallPanel action.
`static int`	`ACTION_GLOB_VAR` The value for a RAPPGlobVar action.
`static int`	`ERROR_CALL_CLASS_RUN_ACTION`
`static int`	`ERROR_CONTROL_ID_NOT_FOUND`
`static int`	`ERROR_GLOB_VAR_NOT_FOUND`
`static int`	`ERROR_HOST_FIELD_NOT_FOUND`
`static int`	`ERROR_HOST_SESSION_NOT_CONNECTED`
`static int`	`ERROR_INSTANCIATING_CALLED_CLASS`
`static int`	`ERROR_INTERFACE_NOT_FOUND`
`static int`	`ERROR_NOT_CURRENT_HOST_SCREEN`
`static int`	`ERROR_OBJECT_NOT_FOUND`
`static int`	`ERROR_UNEXPECTED_RETURN_STRING`
`protected int`	`errorCode` The error code or zero for no error.
`protected String`	`errorDescription` The error description or null for no error.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RAPPAction()
This constructor creates an empty action.

Constructors
Modifier	Constructor and Description
`protected`	`RAPPAction()` This constructor creates an empty action.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendReplyElement()` Creates the Element for a reply from server to client when a Document has been serialized to this class (in the server when processing the reply).
`void`	`appendReplyElement(RAPPElement owner)` Creates the Element for a reply from server to client.
`void`	`appendRequestElement(RAPPElement owner)` Creates the Element for a request from client to server.
`abstract String`	`getActionClass()` Gets the action class name associated with the extending action class (of this class).
`abstract int`	`getActionType()` Gets the type of action for this class.
`static Class<? extends RAPPAction>`	`getClass(String actionclass)` Gets the corresponding Class from an action class name.
`abstract String`	`getComment()` Comment for action class tag when serialized from a request the first time.
`int`	`getErrorCode()` Gets the error code that occurred in the server.
`String`	`getErrorDescription()` Gets the error description that occurred in the server.
`abstract RAPPNameSpaceItem`	`getNameSpaceItem()` Get the action depending namespace item or null if none.
`void`	`initialize(Element actionElement, String actionclass)` Reads the actionclassRequest and actionclassReply elements for available data.
`String`	`paramString()` Gets the parameter string for this class for testing purposes.
`void`	`removeAllElements(boolean isReply)` Removes all Elements for an action class request or reply.
`abstract void`	`serializeFromReply(RAPPElement reply)` Initializes the action class instance from a reply element.
`abstract void`	`serializeFromRequest(RAPPElement request)` Initializes the action class instance from a request element.
`abstract void`	`serializeToReply(RAPPElement reply)` Initializes the reply element with all attributes and perhaps also child nodes/elements.
`abstract void`	`serializeToRequest(RAPPElement request)` Initializes the request element with all attributes and perhaps also child nodes/elements.
`void`	`setError(int errorCode, String errorDescription)` Sets the error code and message that occurred in the server.
`String`	`toString()` Converts this class into a string for testing purposes.
`void`	`updateReplyFromDocument(Element actionElement)` Updates this transaction instance with the reply from the document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERROR_OBJECT_NOT_FOUND
```
public static final int ERROR_OBJECT_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_UNEXPECTED_RETURN_STRING
```
public static final int ERROR_UNEXPECTED_RETURN_STRING
```
    See Also:
    
    Constant Field Values
  - ERROR_CONTROL_ID_NOT_FOUND
```
public static final int ERROR_CONTROL_ID_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_GLOB_VAR_NOT_FOUND
```
public static final int ERROR_GLOB_VAR_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_HOST_SESSION_NOT_CONNECTED
```
public static final int ERROR_HOST_SESSION_NOT_CONNECTED
```
    See Also:
    
    Constant Field Values
  - ERROR_NOT_CURRENT_HOST_SCREEN
```
public static final int ERROR_NOT_CURRENT_HOST_SCREEN
```
    See Also:
    
    Constant Field Values
  - ERROR_HOST_FIELD_NOT_FOUND
```
public static final int ERROR_HOST_FIELD_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_INSTANCIATING_CALLED_CLASS
```
public static final int ERROR_INSTANCIATING_CALLED_CLASS
```
    See Also:
    
    Constant Field Values
  - ERROR_INTERFACE_NOT_FOUND
```
public static final int ERROR_INTERFACE_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_CALL_CLASS_RUN_ACTION
```
public static final int ERROR_CALL_CLASS_RUN_ACTION
```
    See Also:
    
    Constant Field Values
  - ACTION_CALL_OBJECT
```
public static final int ACTION_CALL_OBJECT
```
    The value for a RAPPCallObject action.
    
    See Also:
    
    Constant Field Values
  - ACTION_CALL_HOST
```
public static final int ACTION_CALL_HOST
```
    The value for a RAPPCallHost action.
    
    See Also:
    
    Constant Field Values
  - ACTION_CALL_PANEL
```
public static final int ACTION_CALL_PANEL
```
    The value for a RAPPCallPanel action.
    
    See Also:
    
    Constant Field Values
  - ACTION_CALL_CLASS
```
public static final int ACTION_CALL_CLASS
```
    The value for a RAPPCallClass action.
    
    See Also:
    
    Constant Field Values
  - ACTION_GLOB_VAR
```
public static final int ACTION_GLOB_VAR
```
    The value for a RAPPGlobVar action.
    
    See Also:
    
    Constant Field Values
  - errorCode
```
protected int errorCode
```
    The error code or zero for no error.
  - errorDescription
```
protected String errorDescription
```
    The error description or null for no error.
- Constructor Detail
  - RAPPAction
```
protected RAPPAction()
```
    This constructor creates an empty action. This constructor is used when serializing XML to create the class structure.
- Method Detail
  - getClass
```
public static final Class<? extends RAPPAction> getClass(String actionclass)
```
    Gets the corresponding Class from an action class name.
    
    Returns:
    
    null if not found, otherwise the Class.
  - getActionType
```
public abstract int getActionType()
```
    Gets the type of action for this class. It is used to quickly determine an integer value from a class extending from RAPPAction.
    Current values are:
```
 ACTION_CALL_OBJECT  = 1
 ACTION_CALL_HOST    = 2
 ACTION_CALL_PANEL   = 3
 ACTION_CALL_CLASS   = 4
 ACTION_GLOB_VAR     = 5
 
```
    Returns:
    
    int, one of the values above.
  - getActionClass
```
public abstract String getActionClass()
```
    Gets the action class name associated with the extending action class (of this class).
    Current values are:
```
 callObject
 callHost
 callPanel
 callClass
 globVar
 
```
    Returns:
    
    String the name of the action class, see above.
  - appendRequestElement
```
public final void appendRequestElement(RAPPElement owner)
```
    Creates the Element for a request from client to server.
    The XML for the node looks like (replace parenthesis with less-more-than signs):
```
 (action actionclass="callObject")
   (callObjectRequest [ action="something" attr="abc" ... ])
     (optional/)
   (/callObjectRequest)
 (/action)
 
```
    See Also:
    
    getActionClass()
  - appendReplyElement
```
public final void appendReplyElement(RAPPElement owner)
```
    Creates the Element for a reply from server to client.
    The XML for the node looks like (replace parenthesis with less-more-than signs):
```
 (action actionclass="callObject")
   (callObjectReply [ action="something" attr="abc" ... ])
     (optional/)
   (/callObjectReply)
 (/action)
 
```
    See Also:
    
    getActionClass()
  - appendReplyElement
```
public final void appendReplyElement()
```
    Creates the Element for a reply from server to client when a Document has been serialized to this class (in the server when processing the reply).
  - removeAllElements
```
public final void removeAllElements(boolean isReply)
```
    Removes all Elements for an action class request or reply.
  - initialize
```
public final void initialize(Element actionElement,
                             String actionclass)
                      throws SAXException
```
    Reads the actionclassRequest and actionclassReply elements for available data.
    
    Throws:
    
    SAXException - for errors in the document.
  - updateReplyFromDocument
```
public final void updateReplyFromDocument(Element actionElement)
                                   throws SAXException
```
    Updates this transaction instance with the reply from the document. This is only possible if the original instance of the transaction matches the request in the document.
    
    Throws:
    
    SAXException - for errors in the document.
  - getErrorCode
```
public final int getErrorCode()
```
    Gets the error code that occurred in the server.
    
    Returns:
    
    0 (zero) if no error is present, otherwise a positive error number.
  - getErrorDescription
```
public final String getErrorDescription()
```
    Gets the error description that occurred in the server.
    
    Returns:
    
    null if no error is present.
  - setError
```
public final void setError(int errorCode,
                           String errorDescription)
```
    Sets the error code and message that occurred in the server. The error code must be larger than zero and the error description non-null.
  - getComment
```
public abstract String getComment()
```
    Comment for action class tag when serialized from a request the first time.
  - serializeToRequest
```
public abstract void serializeToRequest(RAPPElement request)
```
    Initializes the request element with all attributes and perhaps also child nodes/elements.
  - serializeToReply
```
public abstract void serializeToReply(RAPPElement reply)
```
    Initializes the reply element with all attributes and perhaps also child nodes/elements.
  - serializeFromRequest
```
public abstract void serializeFromRequest(RAPPElement request)
                                   throws SAXException
```
    Initializes the action class instance from a request element.
    
    Throws:
    
    SAXException - for errors in the document.
  - serializeFromReply
```
public abstract void serializeFromReply(RAPPElement reply)
                                 throws SAXException
```
    Initializes the action class instance from a reply element.
    
    Throws:
    
    SAXException - for errors in the document.
  - paramString
```
public String paramString()
```
    Gets the parameter string for this class for testing purposes.
  - toString
```
public String toString()
```
    Converts this class into a string for testing purposes.
    
    Overrides:
    
    toString in class Object
  - getNameSpaceItem
```
public abstract RAPPNameSpaceItem getNameSpaceItem()
```
    Get the action depending namespace item or null if none.

Class RAPPAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_OBJECT_NOT_FOUND

ERROR_UNEXPECTED_RETURN_STRING

ERROR_CONTROL_ID_NOT_FOUND

ERROR_GLOB_VAR_NOT_FOUND

ERROR_HOST_SESSION_NOT_CONNECTED

ERROR_NOT_CURRENT_HOST_SCREEN

ERROR_HOST_FIELD_NOT_FOUND

ERROR_INSTANCIATING_CALLED_CLASS

ERROR_INTERFACE_NOT_FOUND

ERROR_CALL_CLASS_RUN_ACTION

ACTION_CALL_OBJECT

ACTION_CALL_HOST

ACTION_CALL_PANEL

ACTION_CALL_CLASS

ACTION_GLOB_VAR

errorCode

errorDescription

Constructor Detail

RAPPAction

Method Detail

getClass

getActionType

getActionClass

appendRequestElement

appendReplyElement

appendReplyElement

removeAllElements

initialize

updateReplyFromDocument

getErrorCode

getErrorDescription

setError

getComment

serializeToRequest

serializeToReply

serializeFromRequest

serializeFromReply

paramString

toString

getNameSpaceItem