RAPPGlobVar (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:: RAPPEnumerationItem

public class RAPPGlobVar
extends RAPPAction
implements RAPPEnumerationItem

This class handles actions for Global Variables in the Server application. The for a "set" operation, a unique name for the variable and its value is required.

For "get" and "delete" operations, wildcards (like under the Windows operating system) are allowed. This will make it possible to retrieve multiple variables or to delete many in one single operation.

Wildcards

Wildcards are allowed like under Windows, with:

'?' being any character,
'*' being any characters and
'^' the escape character (the meaning of '?' and '*' becomes the acctual character, and two escape characters for a single).

Example

Set the single variables "CODE", "CUSTID" and "CUSTNAME" then retrieve all variables with the name starting with "LIST_", and at last delete all variables* ending with "_STATUS".

 RAPPTransaction trans=new RAPPTransaction();
 
 // Set variables.
 trans.addAction(new RAPPGlobVar("CODE"    ,"12"            ));
 trans.addAction(new RAPPGlobVar("CUSTID"  ,"540179"        ));
 trans.addAction(new RAPPGlobVar("CUSTNAME","Charles Darwin"));
 
 // Get all variables starting with "LIST_".
 RAPPGlobVar get=new RAPPGlobVar("LIST_*",RAPPGlobVar.GLOB_VAR_GET);
 trans.addAction(get);
 
 // Delete all variables ending with "_STATUS".
 trans.addAction(new RAPPGlobVar("*_STATUS",RAPPGlobVar.GLOB_VAR_DELETE));
 
 ... Send the transaction to server and get the reply ...
 
 // Print out all variables from the "get".
 RAPPGlobVars vars=get.getVariables();
 for ( int ii=0, cc=vars.getCount(); ii<cc; ++ii )
   {
   RAPPGlobVar v=vars.getVariable(ii);
   System.out.println("Index "+ii+", variable "+v.getName()
                     +": "+v.getValue());
   }

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GLOB_VAR_DELETE` Deletes the global variable(s).
`static int`	`GLOB_VAR_GET` Gets the global variable as a single value or as an enumeration, depending on the name of the variable.
`static int`	`GLOB_VAR_SET` Sets the global variable as a single value.

Fields inherited from class se.entra.phantom.rapp.RAPPAction
ACTION_CALL_CLASS, ACTION_CALL_HOST, ACTION_CALL_OBJECT, ACTION_CALL_PANEL, ACTION_GLOB_VAR, ERROR_CALL_CLASS_RUN_ACTION, ERROR_CONTROL_ID_NOT_FOUND, ERROR_GLOB_VAR_NOT_FOUND, ERROR_HOST_FIELD_NOT_FOUND, ERROR_HOST_SESSION_NOT_CONNECTED, ERROR_INSTANCIATING_CALLED_CLASS, ERROR_INTERFACE_NOT_FOUND, ERROR_NOT_CURRENT_HOST_SCREEN, ERROR_OBJECT_NOT_FOUND, ERROR_UNEXPECTED_RETURN_STRING, errorCode, errorDescription

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RAPPGlobVar()` Creates an empty request of globVar.
	`RAPPGlobVar(RAPPGlobVars enumeration)` Creates an instance initialized for an enumeration of variables.
	`RAPPGlobVar(String name, int action)` Creates a request to set the variable to a string.
	`RAPPGlobVar(String name, String value)` Creates a request to set the variable to a string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAction()` Gets the action to perform (GLOB_VAR_SET, GLOB_VAR_GET, or GLOB_VAR_DELETE).
`String`	`getActionClass()` Always returns "globVar".
`int`	`getActionType()` Gets the type of action for this class.
`String`	`getComment()` Comment for action class tag when serialized from a request the first time.
`String`	`getName()` Gets the name of the global variable.
`RAPPNameSpaceItem`	`getNameSpaceItem()` Gets the namespace item for this action.
`String`	`getValue()` Gets the single value of the variable (request and reply), null when not defined or a the name contains wildcards.
`RAPPGlobVars`	`getVariables()` Gets the global variables (null for none).
`void`	`serializeFromDocument(RAPPElement element, int index)` Initializes the item class instance from an Element in the enumeration.
`void`	`serializeFromReply(RAPPElement reply)` Initializes the global variable class instance from a reply element.
`void`	`serializeFromRequest(RAPPElement request)` Initializes the action class instance from a request element.
`void`	`serializeToDocument(RAPPElement element, int index)` Initializes Element for the item in the enumeration.
`void`	`serializeToReply(RAPPElement reply)` Initializes the reply Element with all attributes.
`void`	`serializeToRequest(RAPPElement request)` Initializes the request Element with all attributes.
`void`	`setValue(String value)` Sets the single value of the variable.
`void`	`setVariables(RAPPGlobVars variables)` Sets the global variables from the server that matched the "get" operation.
`String`	`toString()` Converts this class into a string for testing purposes.

Methods inherited from class se.entra.phantom.rapp.RAPPAction
appendReplyElement, appendReplyElement, appendRequestElement, getClass, getErrorCode, getErrorDescription, initialize, paramString, removeAllElements, setError, updateReplyFromDocument

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

- Field Detail
  - GLOB_VAR_SET
```
public static final int GLOB_VAR_SET
```
    Sets the global variable as a single value.
    
    See Also:
    
    Constant Field Values
  - GLOB_VAR_GET
```
public static final int GLOB_VAR_GET
```
    Gets the global variable as a single value or as an enumeration, depending on the name of the variable.
    
    See Also:
    
    Constant Field Values
  - GLOB_VAR_DELETE
```
public static final int GLOB_VAR_DELETE
```
    Deletes the global variable(s).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RAPPGlobVar
```
protected RAPPGlobVar()
```
    Creates an empty request of globVar. This constructor is intended to be used when the instance is serialized from an XML document.
  - RAPPGlobVar
```
public RAPPGlobVar(String name,
                   String value)
```
    Creates a request to set the variable to a string.
  - RAPPGlobVar
```
public RAPPGlobVar(String name,
                   int action)
```
    Creates a request to set the variable to a string. The action can be GLOB_VAR_GET or GLOB_VAR_DELETE.
  - RAPPGlobVar
```
public RAPPGlobVar(RAPPGlobVars enumeration)
```
    Creates an instance initialized for an enumeration of variables. This method is used on the server for a GET operation when the name of the variable contains wildcards.
- Method Detail
  - getNameSpaceItem
```
public RAPPNameSpaceItem getNameSpaceItem()
```
    Gets the namespace item for this action.
    
    Specified by:
    
    getNameSpaceItem in class RAPPAction
  - getAction
```
public int getAction()
```
    Gets the action to perform (GLOB_VAR_SET, GLOB_VAR_GET, or GLOB_VAR_DELETE).
  - getName
```
public String getName()
```
    Gets the name of the global variable. Wildcards are allowed like under Windows, with '?' being any character, '*' being any characters and '^' the escape character (the meaning of '?' and '*' becomes the acctual character, and two escape characters for a single).
  - setValue
```
public void setValue(String value)
```
    Sets the single value of the variable. This method is used by the server.
  - getValue
```
public String getValue()
```
    Gets the single value of the variable (request and reply), null when not defined or a the name contains wildcards.
  - getVariables
```
public RAPPGlobVars getVariables()
```
    Gets the global variables (null for none). This method should be used to retrieve the data for a request that contains wildcards in the name.
  - setVariables
```
public void setVariables(RAPPGlobVars variables)
```
    Sets the global variables from the server that matched the "get" operation.
  - getActionType
```
public 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.
    
    Specified by:
    
    getActionType in class RAPPAction
    
    Returns:
    
    int, ACTION_GLOB_VAR.
  - getComment
```
public String getComment()
```
    Comment for action class tag when serialized from a request the first time.
    
    Specified by:
    
    getComment in class RAPPAction
  - serializeToRequest
```
public void serializeToRequest(RAPPElement request)
```
    Initializes the request Element with all attributes.
    The XML for the node looks like (replace parenthesis with less-more-than signs):
```
  (globVarRequest
    action = {"get" | "set" | "delete"}
    name   = "VARNAME"
  [ value  = "StringValueForSet" ] /)
 
```
    Specified by:
    
    serializeToRequest in class RAPPAction
  - serializeFromRequest
```
public void serializeFromRequest(RAPPElement request)
                          throws SAXException
```
    Initializes the action class instance from a request element.
    
    Specified by:
    
    serializeFromRequest in class RAPPAction
    
    Throws:
    
    SAXException - for errors in the document.
  - serializeToReply
```
public void serializeToReply(RAPPElement reply)
```
    Initializes the reply Element with all attributes.
    The XML for the node looks like (replace parenthesis with less-more-than signs) for a single variable:
```
  (globVarReply
    action = "get"
    name   = "VARNAME"
    value  = "StringValueForGet"/)
 
```
    or for an enumeration:
```
  (globVarReply action = "globVarEnumeration")
    (globVarItem action = "get" name="VARNAME_1"   value="Value1"  /)
    (globVarItem action = "get" name="VARNAME_2"   value="Value1"  /)
    ... etc ...
    (globVarItem action = "get" name="VARNAME_XXX" value="ValueXXX"/)
  (/globVarReply)
 
```
    Specified by:
    
    serializeToReply in class RAPPAction
  - serializeToDocument
```
public void serializeToDocument(RAPPElement element,
                                int index)
```
    Initializes Element for the item in the enumeration. The index parameter indicates the index in the enumeration of the element.
    
    Specified by:
    
    serializeToDocument in interface RAPPEnumerationItem
  - serializeFromReply
```
public void serializeFromReply(RAPPElement reply)
                        throws SAXException
```
    Initializes the global variable class instance from a reply element.
    
    Specified by:
    
    serializeFromReply in class RAPPAction
    
    Throws:
    
    SAXException - for errors in the document.
  - serializeFromDocument
```
public void serializeFromDocument(RAPPElement element,
                                  int index)
                           throws SAXException
```
    Initializes the item class instance from an Element in the enumeration.
    
    Specified by:
    
    serializeFromDocument in interface RAPPEnumerationItem
    
    Throws:
    
    SAXException - for errors in the document.
  - toString
```
public String toString()
```
    Converts this class into a string for testing purposes.
    
    Overrides:
    
    toString in class RAPPAction
  - getActionClass
```
public String getActionClass()
```
    Always returns "globVar".
    
    Specified by:
    
    getActionClass in class RAPPAction
    
    Returns:
    
    String the name of the action class, see above.

Class RAPPGlobVar

Wildcards

Example

Field Summary

Fields inherited from class se.entra.phantom.rapp.RAPPAction

Constructor Summary

Method Summary

Methods inherited from class se.entra.phantom.rapp.RAPPAction

Methods inherited from class java.lang.Object

Field Detail

GLOB_VAR_SET

GLOB_VAR_GET

GLOB_VAR_DELETE

Constructor Detail

RAPPGlobVar

RAPPGlobVar

RAPPGlobVar

RAPPGlobVar

Method Detail

getNameSpaceItem

getAction

getName

setValue

getValue

getVariables

setVariables

getActionType

getComment

serializeToRequest

serializeFromRequest

serializeToReply

serializeToDocument

serializeFromReply

serializeFromDocument

toString

getActionClass