RAPPCallObject (NetPhantom® 7.7 Java API Specification)

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

```
public class RAPPCallObject
extends RAPPAction
```
This class handles calling a Phantom Object in the server. The object type is "REXX Application". When this action is run in the server it runs until it has completed (much like a REXX Macro), but still has all the possibilities available such as waiting for a host screen, host lock, etc.
The action also supports checking for an expected return code from the object. If the value does not correspond, an error is stored in the object. In case of an error, there is a choice to abort or to continue processing further actions.
Example: call the TEST object with CMD action, and do not abort when the return code is not "123" (the expected return code:
```
  RAPPTransaction trans=new RAPPTransaction();

  RAPPCallObject co=new RAPPCallObject("TEST","test1",RAPPCallObject.CMD,"argStrin");
  co.setExpectedReturn("123",false);
  trans.addAction(co);

  ... Send transaction to server and get reply ...

  if ( co.getErrorCode()==0 )
    System.out.println("TEST returned: "+co.getReturnString());
  else
    System.out.println("TEST error code "+co.getErrorCode()+" '"
                      +co.getErrorDescription()+"': returned: "
                      +co.getReturnString());
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`actionTable` Table of strings for object calling.
`static int`	`CHAR` Character accept/convert object message.
`static int`	`CHECK` Check field object message.
`static int`	`CLK` Single-click object message.
`static int`	`CLOSE` Close request of panels object message.
`static int`	`CMD` Command object message.
`static int`	`CRT` Create object message.
`static int`	`DBLCLK` Double-click object message.
`static int`	`DEFOC` Lose focus object message.
`static int`	`FOC` Get focus object message.
`static int`	`HCHG` Host-change object message.
`static int`	`HIDDEN` Hidden panel object message.
`static int`	`QMSG` Query message type object message.
`static int`	`RECRT` Recreate panel object message.
`static int`	`REM` Remove object message.
`static int`	`SEL` Selection in list object message.
`static int`	`SHOW` Show panel object message.
`static int`	`START` Start local application object message.
`static int`	`UCHG` User-change object message.
`static int`	`XLATE` Translate string object message.

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`	`RAPPCallObject()` Creates an uninitialized CallObject instance.
	`RAPPCallObject(String subject, String callerID, int action, String value)` Creates a new object to call in the server.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAbort()` Gets the flag indicating if the actions should abort running subsequent actions if the expected return string is not matching.
`int`	`getAction()` Gets the action value (zero if not defined).
`String`	`getActionClass()` Returns the action class "callObject".
`int`	`getActionType()` Gets the type of action for this class.
`String`	`getCallerID()` Gets the caller ID.
`String`	`getComment()` Comment for action class tag when serialized from a request the first time.
`String`	`getExpectedReturn()` Gets the expected return string from the object, null for no checking.
`RAPPNameSpaceItem`	`getNameSpaceItem()` Gets the namespace item for this action.
`static int`	`getObjectAction(String action)` Converts an object action string into a numeric value (case insensitive).
`String`	`getReturnString()` Gets the return code after the object has returned a value.
`String`	`getSubject()` Gets The Phantom Object ID in upper case (null if not defined).
`String`	`getValue()` Gets the value to pass to the object (the third parameter) often referred to as the "string parameter - argStr".
`String`	`paramString()` Gets the parameter string for this class for testing purposes.
`void`	`serializeFromReply(RAPPElement reply)` Initializes the action class instance from a reply element.
`void`	`serializeFromRequest(RAPPElement request)` Initializes the action class instance from a request element.
`void`	`serializeToReply(RAPPElement reply)` Initializes the reply Element with all attributes.
`void`	`serializeToRequest(RAPPElement request)` Initializes the request Element with all attributes.
`void`	`setExpectedReturn(String expectedReturn, boolean abort)` Sets the expected return string and abort flag option.
`void`	`setReturnString(String returnString)` Sets the return code after the object has returned a value.

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

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

- Field Detail
  - CRT
```
public static final int CRT
```
    Create object message.
    
    See Also:
    
    Constant Field Values
  - REM
```
public static final int REM
```
    Remove object message.
    
    See Also:
    
    Constant Field Values
  - UCHG
```
public static final int UCHG
```
    User-change object message.
    
    See Also:
    
    Constant Field Values
  - HCHG
```
public static final int HCHG
```
    Host-change object message.
    
    See Also:
    
    Constant Field Values
  - FOC
```
public static final int FOC
```
    Get focus object message.
    
    See Also:
    
    Constant Field Values
  - DEFOC
```
public static final int DEFOC
```
    Lose focus object message.
    
    See Also:
    
    Constant Field Values
  - CLK
```
public static final int CLK
```
    Single-click object message.
    
    See Also:
    
    Constant Field Values
  - DBLCLK
```
public static final int DBLCLK
```
    Double-click object message.
    
    See Also:
    
    Constant Field Values
  - CMD
```
public static final int CMD
```
    Command object message.
    
    See Also:
    
    Constant Field Values
  - SEL
```
public static final int SEL
```
    Selection in list object message.
    
    See Also:
    
    Constant Field Values
  - CLOSE
```
public static final int CLOSE
```
    Close request of panels object message.
    
    See Also:
    
    Constant Field Values
  - CHAR
```
public static final int CHAR
```
    Character accept/convert object message.
    
    See Also:
    
    Constant Field Values
  - CHECK
```
public static final int CHECK
```
    Check field object message.
    
    See Also:
    
    Constant Field Values
  - HIDDEN
```
public static final int HIDDEN
```
    Hidden panel object message.
    
    See Also:
    
    Constant Field Values
  - RECRT
```
public static final int RECRT
```
    Recreate panel object message.
    
    See Also:
    
    Constant Field Values
  - XLATE
```
public static final int XLATE
```
    Translate string object message.
    
    See Also:
    
    Constant Field Values
  - START
```
public static final int START
```
    Start local application object message.
    
    See Also:
    
    Constant Field Values
  - SHOW
```
public static final int SHOW
```
    Show panel object message.
    
    See Also:
    
    Constant Field Values
  - QMSG
```
public static final int QMSG
```
    Query message type object message.
    
    See Also:
    
    Constant Field Values
  - actionTable
```
public static final String[] actionTable
```
    Table of strings for object calling. Note that indexes in the table must be added with 1 (one) in order to get the respective numeric value.
    The table contains the strings: CRT, REM, UCHG HCHG, FOC, DEFOC, CLK, DBLCLK, CMD, SEL, CLOSE, CHAR CHECK, HIDDEN, RECRT, XLATE, START, SHOW, QMSG.
- Constructor Detail
  - RAPPCallObject
```
protected RAPPCallObject()
```
    Creates an uninitialized CallObject instance. This constructor is intended to be used when the instance is serialized from an XML document.
  - RAPPCallObject
```
public RAPPCallObject(String subject,
                      String callerID,
                      int action,
                      String value)
```
    Creates a new object to call in the server. Specify the subject or objectID (1-8 characters in upper case), the callerID string to feed the object with, the object action (CMD, CRT, UCHG, etc).
    Call the method setExpectedReturn to specify such an operation.
    
    Parameters:
    
    subject - The Phantom Object ID.
    
    callerID - The caller ID. This is the ID parameter (the first parameter) being passed to the object. The parameter is often referred to as the "id - argId".
    
    action - The action value. The parameter is often referred to as the "command - argCmd".
    
    value - The value to pass to the object (the third parameter) often referred to as the "string parameter - argStr".
    
    See Also:
    
    setExpectedReturn(java.lang.String, boolean)
- Method Detail
  - getObjectAction
```
public static int getObjectAction(String action)
```
    Converts an object action string into a numeric value (case insensitive). If null is passed in, zero is returned.
    Valid strings (no matter character case) are: CRT, REM, UCHG HCHG, FOC, DEFOC, CLK, DBLCLK, CMD, SEL, CLOSE, CHAR CHECK, HIDDEN, RECRT, XLATE, START, SHOW, QMSG.
    
    Returns:
    
    zero if the action is not found, otherwise a value between 1 and 19.
  - getNameSpaceItem
```
public RAPPNameSpaceItem getNameSpaceItem()
```
    Gets the namespace item for this action.
    
    Specified by:
    
    getNameSpaceItem in class RAPPAction
  - getActionClass
```
public String getActionClass()
```
    Returns the action class "callObject".
    
    Specified by:
    
    getActionClass in class RAPPAction
    
    Returns:
    
    String the name of the action class, see above.
  - getSubject
```
public String getSubject()
```
    Gets The Phantom Object ID in upper case (null if not defined).
  - getCallerID
```
public String getCallerID()
```
    Gets the caller ID. This is the ID parameter (the first parameter) being passed to the object. This variable is null if not defined. The parameter is often referred to as the "id - argId".
  - getAction
```
public int getAction()
```
    Gets the action value (zero if not defined). The parameter is often referred to as the "command - argCmd".
  - getValue
```
public String getValue()
```
    Gets the value to pass to the object (the third parameter) often referred to as the "string parameter - argStr".
  - getExpectedReturn
```
public String getExpectedReturn()
```
    Gets the expected return string from the object, null for no checking.
  - getAbort
```
public boolean getAbort()
```
    Gets the flag indicating if the actions should abort running subsequent actions if the expected return string is not matching. If the expected return code is null, the value of this flag should be ignored.
  - getReturnString
```
public String getReturnString()
```
    Gets the return code after the object has returned a value. When this is done, this value is non-null (i.e. if it null, the value is not yet set).
  - getActionType
```
public int getActionType()
```
    Gets the type of action for this class. It is used to quickly determin an integer value from a class extending from RAPPAction.
    
    Specified by:
    
    getActionType in class RAPPAction
    
    Returns:
    
    int, ACTION_CALL_OBJECT.
  - setExpectedReturn
```
public void setExpectedReturn(String expectedReturn,
                              boolean abort)
```
    Sets the expected return string and abort flag option.
    
    Parameters:
    
    expectedReturn - The expected return string from the object, null for no checking.
    
    abort - Flag indicating if the actions should abort running subsequent actions if the expected return string is not matching. If the expected return code is null, the value of this flag is ignored.
  - setReturnString
```
public void setReturnString(String returnString)
```
    Sets the return code after the object has returned a value. This value must be non-null.
  - 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):
```
  (callObjectRequest
    subject       ="MYOBJECT"
    callerID      ="MYID"
    action        ="CMD"
    value         ="string"
  [ expectedReturn="whatWeExpect"
    abort         ="boolean" ] /)
 
```
    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):
```
  (callObjectReply
  [ returnString    ="WhatTheObjectReturned" ]
  [ errorCode       ="123"
    errorDescription="Object ID not found"   ] /)
 
```
    Specified by:
    
    serializeToReply in class RAPPAction
  - serializeFromReply
```
public void serializeFromReply(RAPPElement reply)
                        throws SAXException
```
    Initializes the action class instance from a reply element.
    
    Specified by:
    
    serializeFromReply in class RAPPAction
    
    Throws:
    
    SAXException - for errors in the document.
  - paramString
```
public String paramString()
```
    Gets the parameter string for this class for testing purposes.
    
    Overrides:
    
    paramString in class RAPPAction

Class RAPPCallObject

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

CRT

REM

UCHG

HCHG

FOC

DEFOC

CLK

DBLCLK

CMD

SEL

CLOSE

CHAR

CHECK

HIDDEN

RECRT

XLATE

START

SHOW

QMSG

actionTable

Constructor Detail

RAPPCallObject

RAPPCallObject

Method Detail

getObjectAction

getNameSpaceItem

getActionClass

getSubject

getCallerID

getAction

getValue

getExpectedReturn

getAbort

getReturnString

getActionType

setExpectedReturn

setReturnString

getComment

serializeToRequest

serializeFromRequest

serializeToReply

serializeFromReply

paramString