CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.screen
Interface IScreenable


public interface IScreenable

This interface defines the screen interface used by the resource adapter to build screen output, or obtain the fields it needs.


Method Summary
 void beginBuild(IScreenInfo ScrInf, boolean fullRefresh)
          Indicate the start of the field build process, providing Information about the Screen itself.
 void buildField(IFieldData fieldData, IFieldAttrInfo fieldAttrs, ITextAttrInfo textAttrs)
          Adds a field to the screen record.
 void endBuild()
          Indicate the end of the field build process.
 java.util.Iterator getFields()
          Returns an iterator for the fields contained in the screen record.
 java.util.Iterator getModifiedFields()
          Returns an iterator for the modified fields contained in the screen record.
 java.lang.String getScreenId()
          Returns the screen record ID.
 void setScreenId(java.lang.String ScreenId)
          Set the screen ID.
 

Method Detail

beginBuild

void beginBuild(IScreenInfo ScrInf,
                boolean fullRefresh)
Indicate the start of the field build process, providing Information about the Screen itself. fullRefresh indicates if the resource adapter is going to provide the complete screen (true) or just the fields that have changed their contents, but the field definitions have not changed. (false)


buildField

void buildField(IFieldData fieldData,
                IFieldAttrInfo fieldAttrs,
                ITextAttrInfo textAttrs)
                throws ScreenException
Adds a field to the screen record.

Throws:
ScreenException

endBuild

void endBuild()
Indicate the end of the field build process.


getFields

java.util.Iterator getFields()
Returns an iterator for the fields contained in the screen record.


getModifiedFields

java.util.Iterator getModifiedFields()
Returns an iterator for the modified fields contained in the screen record.


getScreenId

java.lang.String getScreenId()
Returns the screen record ID.


setScreenId

void setScreenId(java.lang.String ScreenId)
Set the screen ID.


©Copyright IBM Corp. 1994, 2014
Legal