com.attachmate.cicsbridge.j2ee.outputs
Class FieldAttributes

java.lang.Object
  com.attachmate.cicsbridge.j2ee.outputs.FieldAttributes

All Implemented Interfaces:

java.io.Serializable

public final class FieldAttributes

extends java.lang.Object

implements java.io.Serializable

Return object that holds return code and field attributes for current screen.

See Also:

BridgeAPI_EJB.getFieldAttributes(int, String), BridgeAPI_EJB.getFieldAttributes(int, int), BridgeAPI_EJB.getFieldAttributes(String, int), BridgeAPI_EJB.getFieldAttributes(String, String), Serialized Form

Constructor Summary

FieldAttributes(int returnCode, int attributes)
Creates a FieldAttributes object and sets member variables.

Method Summary

int	getAttributes() Returns the attributes of the specified field.
int	getReturnCode() Returns zero for success.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldAttributes

public FieldAttributes(int returnCode,
                       int attributes)

Creates a FieldAttributes object and sets member variables.

Parameters:

returnCode - - zero for success. For possible failure values, see the getReturnCodeMessage method.

attributes - - The returned attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):

  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 

Method Detail

getReturnCode

public int getReturnCode()

Returns zero for success. For possible failure values, see the getReturnCodeMessage method.

Returns:

int value

getAttributes

public int getAttributes()

Returns the attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):

  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 

Returns:

int value