se.entra.phantom.rapp

Class RAPPCallHost

java.lang.Object

se.entra.phantom.rapp.RAPPAction

se.entra.phantom.rapp.RAPPCallHost

public class RAPPCallHost
extends RAPPAction

The callHost action is used to get the current screen with optional screen data and to get one or an enumeration of host fields.

GetScreen

The information for the current screen is:

• screen size,
• lock, error state and status text,
• cursor position in host,
• current screen name,
• current field name and relative cursor position inside the field.

The reply value for the action is stored in a RAPPHostScreen class instance.

GetField

Field information can be retrieved using the getField action. The operation to get information is:

• a single (entire) host field,
• all cells of a host field, i.e. gets all host fields when the host field is of list-type.
• all host fields and cells present on the current screen.

The information for each host cell is:

• the name,
• the contents,
• length as defined in Phantom,
• position on screen,
• length as the underlying host field defines,
• protected and hidden attributes,
• host color,
• index of the cell in the list (if inside a list-type field).

The reply value for the action is stored in a RAPPHostCell or RAPPHostCells class instance, depending of the requested information.

Note: When getting a single host field with the option "*" or when requesting all fields on a screen, continued fields as defined in Phantom are returned as separate host cells. In other words, if you need to retrieve the contents of a continued field as just one string, you have to call the constructor as RAPPCallHost(screenName,fieldName). Then the contents of the field is returned by the method getField().getValue() of this class.

Example

Request the entire screen with the data, all host fields available, all host fields that has a name beginning with "COL", a column of a host field (list-type) and last an entire host field.

   RAPPTransaction trans=new RAPPTransaction();

   RAPPCallHost screen=new RAPPCallHost(true);
   trans.addAction(screen);

   RAPPCallHost all=new RAPPCallHost("CUSTLIST","*");
   trans.addAction(all);

   RAPPCallHost col=new RAPPCallHost("CUSTLIST","COL*");
   trans.addAction(col);

   RAPPCallHost msg=new RAPPCallHost("CUSTLIST","MSG");
   trans.addAction(msg);

   RAPPCallHost col1=new RAPPCallHost("CUSTLIST","COL1",1);
   trans.addAction(col1);
 

See Also:

getField(), getFields(), getScreen(), RAPPHostScreen, RAPPHostCell, RAPPHostCells

Field Summary

Fields

Modifier and Type	Field and Description
static int	GET_FIELD The getField request action.
static int	GET_SCREEN The getScreen request action.

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	RAPPCallHost() Creates an empty request of callHost.
	RAPPCallHost(boolean doGetScreenContents) Creates a request to get the current host screen with or without screen contents depending on the flag doGetScreenContents.
	RAPPCallHost(String screen) Creates a request to get all fields from the current host screen.
	RAPPCallHost(String screen, String field) Creates a request to get a field from the current host screen.
	RAPPCallHost(String screen, String field, int index) Creates a request to get a field index from the current host screen.

Method Summary

Modifier and Type	Method and Description
boolean	doGetScreenContents() For getScreen, gets the flag indicating that the screen contents is required.
int	getAction() Gets the request action.
String	getActionClass() Always returns "callHost".
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.
RAPPHostCell	getField() Use this method to get the reply from a getField request.
String	getFieldName() For getField, gets the name of the field, null if not yet set.
RAPPHostCells	getFields() Use this method to get the reply from a getField request.
int	getIndex() For getField, gets the index number of the requested field.
RAPPNameSpaceItem	getNameSpaceItem() Gets the namespace item for this action.
RAPPHostScreen	getScreen() Use this method to get the reply from a getScreen request.
String	getScreenName() For getField, gets the name of the screen, null if not yet set.
String	getStatus() Gets the status text of the host.
boolean	hasError() Gets the flag indicating that the host was in error state at the time the operation was performed.
boolean	isLocked() Gets the flag indicating that the host was locked at the time the operation was performed.
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	setReply(boolean isLocked, boolean hasError, String status) Sets the reply common for all requests.
void	setReply(RAPPHostCell cell) Sets the reply for a getField.
void	setReply(RAPPHostCells cells) Sets the reply for a getField where the reply contains more than one field.
void	setReply(RAPPHostScreen screen) Sets the reply for a getScreen.

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

GET_SCREEN

public static final int GET_SCREEN

The getScreen request action.

See Also:

Constant Field Values

GET_FIELD

public static final int GET_FIELD

The getField request action.

See Also:

Constant Field Values

Constructor Detail

RAPPCallHost

protected RAPPCallHost()

Creates an empty request of callHost. This constructor is intended to be used when the instance is serialized from an XML document.

RAPPCallHost

public RAPPCallHost(boolean doGetScreenContents)

Creates a request to get the current host screen with or without screen contents depending on the flag doGetScreenContents.

Use the method getScreen to get the reply.

See Also:

getScreen()

RAPPCallHost

public RAPPCallHost(String screen)

Creates a request to get all fields from the current host screen.

Use the method getFields to get the data from the reply.

Parameters:

screen - the name of the current screen. If the screen doesn't match the current host screen, an error will be returned.

See Also:

getScreen()

RAPPCallHost

public RAPPCallHost(String screen,
                    String field)

Creates a request to get a field from the current host screen.

Use the method getFields to get the data from the reply.

Parameters:

screen - the name of the current screen. If the screen doesn't match the current host screen, an error will be returned.

field - the name of the requested field or "*" for all fields.

See Also:

getScreen()

RAPPCallHost

public RAPPCallHost(String screen,
                    String field,
                    int index)

Creates a request to get a field index from the current host screen. The field index is -1 if all the cells in a host fields are requested at once, or the index (or line number) for the host field cell when the host field is of "list-type".

Use the method getField or getFields to get the data from the reply.

Parameters:

screen - the name of the current screen. If the screen doesn't match the current host screen, an error will be returned.

field - the name of the requested field or "*" for all fields.

index - the index of the requested field when field specifies a unique field name. The index can be -2 for all cells in a field of "list-type" or the index of the cell in the list. When the index is -1 the entire host field is requested (only valid when field != "*").

See Also:

getScreen()

Method Detail

getNameSpaceItem

public RAPPNameSpaceItem getNameSpaceItem()

Gets the namespace item for this action.

Specified by:

getNameSpaceItem in class RAPPAction

isLocked

public boolean isLocked()

Gets the flag indicating that the host was locked at the time the operation was performed.

hasError

public boolean hasError()

Gets the flag indicating that the host was in error state at the time the operation was performed.

getStatus

public String getStatus()

Gets the status text of the host. In case of an error/lock, this string can contain an error message for 5250. This text is the same text as being displayed in the terminal emulator status bar.

getAction

public int getAction()

Gets the request action. Returns one of the two values (zero if no request has been performed).

 GET_SCREEN = 1
 GET_FIELD  = 2
 

doGetScreenContents

public boolean doGetScreenContents()

For getScreen, gets the flag indicating that the screen contents is required.

getScreenName

public String getScreenName()

For getField, gets the name of the screen, null if not yet set.

getFieldName

public String getFieldName()

For getField, gets the name of the field, null if not yet set. The getField can be a field name or "*" for all fields.

getIndex

public int getIndex()

For getField, gets the index number of the requested field. The index -2 indicates "*" = all fields cells in a field column.

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_CALL_HOST.

getActionClass

public String getActionClass()

Always returns "callHost".

Specified by:

getActionClass in class RAPPAction

Returns:

String the name of the action class, see above.

setReply

public void setReply(boolean isLocked,
                     boolean hasError,
                     String status)

Sets the reply common for all requests.

setReply

public void setReply(RAPPHostScreen screen)

Sets the reply for a getScreen. This method is used from the server.

setReply

public void setReply(RAPPHostCell cell)

Sets the reply for a getField. This method is used from the server.

setReply

public void setReply(RAPPHostCells cells)

Sets the reply for a getField where the reply contains more than one field. This method is used from the server.

getScreen

public RAPPHostScreen getScreen()

Use this method to get the reply from a getScreen request.

Returns:

RAPPHostScreen the class holding the information for the request, or null if the request is not yet available or the request was a getField.

getField

public RAPPHostCell getField()

Use this method to get the reply from a getField request. This method returns a single instance of a host field when the request specifies a single host field.

Returns:

RAPPHostCell the class holding the information for the request, or null if the request is not yet available or the request was a getScreen. It is also null if the request had "index=*" (-2) or "field=*".

getFields

public RAPPHostCells getFields()

Use this method to get the reply from a getField request. This method returns a list of host fields when the request specifies all host fields of a screen or all host fields in a "list-type" host field.

Returns:

RAPPHostCell the class holding the information for the request, or null if the request is not yet available or the request was a getScreen. It is also null if the request had "index=*" (-2) or "field=*".

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) for getScreen:

  (action actionClass="callHost"/)
    (callHostRequest
      action="getScreen"
      getContents={"true" | "false"} /)
  (/action)
 

or for getField:

  (action actionClass="callHost"/)
    (callHostRequest
      action="getField"
      screen="LOGIN"
      field ={"USERID" | "*"}
    [ index ={"nn" | "*" } ] /)
  (/action)
 

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.

For the XML reply, see the classes RAPPHostCell, RAPPHostCells and RAPPHostScreen.

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