|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.connector2.hod.screenable.J2HODScreenableRecord
This class represents a record of a screen. It implements Screenable interface which is the main difference from J2HODScreenRecord. This class is to be used with new CAB tooling which supports Screenable interface. This class should not be mixed with J2HODScreenRecord when passing as parameters in execute() method.
User must call beginBuild() to starting building a screen record then call buildField() methods to build fields for this screen record. To end the building process of this screen record, endBuild() method must be called.
This class is also used to compare a current screen record information against another screen record for their match.
The following table shows properties of this class:
Name | Type | Default Value | Description |
---|---|---|---|
recordName | String | J2HODScreenableRecord | Record name of this screen |
description | String | "Screenable Record for HOD J2C" | Description of this screen record |
screenId | String | "" | ID of this screen |
depth | int | 24 | Depth of screen (number of rows) |
width | int | 80 | Width of screen (number of columns) |
screenSize | int | 24*80 (depth*width) | Size of this screen |
fieldCount | int | 0 | Total current number of fields in this screen record |
fullRefresh | boolean | false | Determines whether to build a screen with full-refresh or just update existing fields |
fields | Vector | A vector containing fields of this screen record | |
screenInfo | J2HODScreenInfo | see J2HODScreenInfo for its associated default attribute values | Contains screen information attributes |
Constructor Summary | |
---|---|
J2HODScreenableRecord()
Constructs an instance of J2HODScreenableRecord with default attribute values |
Method Summary | |
---|---|
void |
beginBuild(com.ibm.connector2.screen.IScreenInfo scrInfo,
boolean fullRefresh)
Indicate a start of a field build process, by providing information about a screen. |
void |
buildField(com.ibm.connector2.screen.IFieldData fieldData,
com.ibm.connector2.screen.IFieldAttrInfo fieldAttrs,
com.ibm.connector2.screen.ITextAttrInfo textAttrs)
Adds a field to screen record. |
java.lang.Object |
clone()
Clones current screen record. |
void |
endBuild()
Indicate an end of the field build process. |
boolean |
equals(java.lang.Object obj)
Compares two objects for equality. |
J2HODFieldRecord |
getField(int index)
Returns a field record at specified index number |
J2HODFieldRecord |
getField(java.lang.String name)
Returns a field record with specified name |
int |
getFieldCount()
Returns a number of total field count |
java.util.Iterator |
getFields()
Returns an iterator for fields contained in screen record. |
java.util.Iterator |
getModifiedFields()
Returns an iterator for modified fields in screen record. |
java.lang.String |
getRecordName()
Gets a screen record name. |
java.lang.String |
getRecordShortDescription()
Gets a short screen record description. |
int |
getScreenDepth()
Returns screen depth number |
java.lang.String |
getScreenId()
Returns screen record ID. |
J2HODScreenInfo |
getScreenInfo()
Returns a ScreenInfo instance that is passed in when beginBuild was called |
int |
getScreenWidth()
Returns screen width number |
int |
hashCode()
Generates a hash code for receiver. |
void |
setRecordName(java.lang.String name)
Sets a screen record name. |
void |
setRecordShortDescription(java.lang.String desc)
Sets a short description of a screen record. |
void |
setScreenId(java.lang.String val)
Set screen ID. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public J2HODScreenableRecord()
Method Detail |
public void beginBuild(com.ibm.connector2.screen.IScreenInfo scrInfo, boolean fullRefresh)
beginBuild
in interface com.ibm.connector2.screen.IScreenable
scrInfo
- com.ibm.connector2.screen.IScreenInfo - screen informationfullRefresh
- boolean - do a full refresh or just update existing fieldsendBuild()
public void buildField(com.ibm.connector2.screen.IFieldData fieldData, com.ibm.connector2.screen.IFieldAttrInfo fieldAttrs, com.ibm.connector2.screen.ITextAttrInfo textAttrs) throws com.ibm.connector2.screen.ScreenException
buildField
in interface com.ibm.connector2.screen.IScreenable
iFieldData
- com.ibm.connector2.screen.IFieldData - field dataiFieldAttrInfo
- com.ibm.connector2.screen.IFieldAttrInfo - field attributesiTextAttrInfo
- com.ibm.connector2.screen.ITextAttrInfo - field text attributescom.ibm.connector2.screen.ScreenException
- - generic screenable record exceptionpublic void endBuild()
endBuild
in interface com.ibm.connector2.screen.IScreenable
beginBuild(com.ibm.connector2.screen.IScreenInfo, boolean)
public java.lang.String getScreenId()
getScreenId
in interface com.ibm.connector2.screen.IScreenable
setScreenId(java.lang.String)
public void setScreenId(java.lang.String val)
setScreenId
in interface com.ibm.connector2.screen.IScreenable
val
- String - screen IDgetScreenId()
public java.util.Iterator getFields()
getFields
in interface com.ibm.connector2.screen.IScreenable
public java.util.Iterator getModifiedFields()
getModifiedFields
in interface com.ibm.connector2.screen.IScreenable
public java.lang.Object clone()
clone
in interface javax.resource.cci.Record
public boolean equals(java.lang.Object obj)
equals
in interface javax.resource.cci.Record
equals
in class java.lang.Object
obj
- Object - an Object to compare withpublic java.lang.String getRecordName()
getRecordName
in interface javax.resource.cci.Record
setRecordName(java.lang.String)
public java.lang.String getRecordShortDescription()
getRecordShortDescription
in interface javax.resource.cci.Record
setRecordShortDescription(java.lang.String)
public int hashCode()
hashCode
in interface javax.resource.cci.Record
hashCode
in class java.lang.Object
public void setRecordName(java.lang.String name)
setRecordName
in interface javax.resource.cci.Record
name
- String - recordNamegetRecordName()
public void setRecordShortDescription(java.lang.String desc)
setRecordShortDescription
in interface javax.resource.cci.Record
desc
- String - descriptiongetRecordShortDescription()
public J2HODFieldRecord getField(int index) throws com.ibm.connector2.screen.ScreenException
index
- int - field record vector index (must be greater than 1)com.ibm.connector2.screen.ScreenException
- public J2HODFieldRecord getField(java.lang.String name) throws com.ibm.connector2.screen.ScreenException
name
- java.lang.Stringcom.ibm.connector2.screen.ScreenException
- public int getFieldCount()
public int getScreenDepth()
public int getScreenWidth()
public J2HODScreenInfo getScreenInfo()
J2HODScreenInfo
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |