|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wrq.apptrieve.appconn.AppConnSession
com.wrq.apptrieve.appconn.AppConnRejuvenationSession
public final class AppConnRejuvenationSession
AppConnRejuvenationSession is an extension to the AppConnSession object with some added methods to support rejuvenation.
Field Summary | |
---|---|
static int |
ErrorLineColor
Color index value for AS/400 error line. |
static int |
HostBlueColor
Host Blue -- Color set by an extended host attribute. |
static int |
HostGreenColor
Host Green -- Color set by an extended host attribute. |
static int |
HostPinkColor
Host Pink -- Color set by an extended host attribute. |
static int |
HostRedColor
Host Red -- Color set by an extended host attribute. |
static int |
HostTurquoiseColor
Host Turquoise -- Color set by an extended host attribute. |
static int |
HostWhiteColor
Host White -- Color set by an extended host attribute. |
static int |
HostYellowColor
Host Yellow -- Color set by an extended host attribute. |
static int |
MessageLineColor
Color index value for AS/400 message line. |
static int |
OIA_LINES
Number of OIA / Status lines on screen. |
static int |
ProtectedHighlightAlphaColor
Protected Highlighted Alpha field color. |
static int |
ProtectedHighlightNumericColor
Protected Highlighted Numeric field color. |
static int |
ProtectedNormalAlphaColor
Protected Normal Alpha field color. |
static int |
ProtectedNormalNumericColor
Protected Normal Numeric field color. |
static int |
StatusLineColor
Host Status Line -- Color of host status line or OIA. |
static int |
SysRequestColor
Color index value for AS/400 sys request text. |
static int |
UnprotectedHighlightAlphaColor
Unprotected Highlighted Alpha field color. |
static int |
UnprotectedHighlightNumericColor
Unprotected Highlighted Numeric field color. |
static int |
UnprotectedNormalAlphaColor
Unprotected Normal Alpha field color. |
static int |
UnprotectedNormalNumericColor
Unprotected Normal Numeric field color. |
Fields inherited from class com.wrq.apptrieve.appconn.AppConnSession |
---|
doEngBundle, doLocBundle, remoteChannel, serverAgent, sessionLocale |
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnChannel |
---|
LOG_ALL_MESSAGES, LOG_ERRORS, LOG_WARNINGS_AND_ERRORS, SessionType3270, SessionType5250, SessionTypeHP, SessionTypeUnknown, SessionTypeVT |
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnModel |
---|
ScrollEnd, ScrollHome, ScrollLineDown, ScrollLineUp, ScrollPageDown, ScrollPageUp, SyncToHost |
Constructor Summary | |
---|---|
AppConnRejuvenationSession()
Constructor of the AppConnRejuvenationSession class. |
Method Summary | |
---|---|
AppConnRecordSet |
fetchRecords(int maxRows,
java.util.List fieldNames,
java.lang.String filterExpression)
Fetches up to max rows of data from the Host Integrator Server for the current recordset of the current entity. |
AppConnModelRecord |
getCurrentRecord()
Fetches the current record in the current recordset. |
int |
getCurrentRecordIndex()
Gets the index number of the current record in the current recordset. |
int |
getScreenCRC()
Get a CRC for the current screen, based on input field locations, sizes, and character content. |
TerminalScreen |
getTerminalScreen()
Fetch a TerminalScreen object that represents the current host screen. |
AppConnModelRecord |
nextRecord(java.lang.String filterExpression)
Finds and return a record in the current recordset using a filter expression. |
void |
setCurrentEntity(java.lang.String entityName)
Sets the current entity. |
boolean |
setCurrentRecordIndex(int index)
Changes the index number of the current record in the current recordset. |
void |
setCurrentRecordSetByName(java.lang.String recordSetName)
Sets the current recordset by name. |
void |
setHiddenAttributes(java.util.List attributes)
|
void |
setLegacyRejuvenation(boolean f)
Set or clear flag to support legacy rejuvenation. |
boolean |
terminalUpdatesPresent()
Determine if there are terminal screen updates pending. |
void |
waitForStableDisplay()
Wait for a stable terminal display. |
void |
waitForStableDisplay(int durationMilliSeconds,
int timeLimitSeconds)
Wait for a stable terminal display. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int HostRedColor
public static final int HostBlueColor
public static final int HostPinkColor
public static final int HostGreenColor
public static final int HostTurquoiseColor
public static final int HostYellowColor
public static final int HostWhiteColor
public static final int StatusLineColor
public static final int ProtectedNormalAlphaColor
public static final int ProtectedNormalNumericColor
public static final int ProtectedHighlightAlphaColor
public static final int ProtectedHighlightNumericColor
public static final int UnprotectedNormalAlphaColor
public static final int UnprotectedNormalNumericColor
public static final int UnprotectedHighlightAlphaColor
public static final int UnprotectedHighlightNumericColor
public static final int MessageLineColor
public static final int ErrorLineColor
public static final int SysRequestColor
public static final int OIA_LINES
Constructor Detail |
---|
public AppConnRejuvenationSession()
Method Detail |
---|
public void setLegacyRejuvenation(boolean f)
f
- Flag value for legacy rejuvenation.public void waitForStableDisplay() throws ChannelException, ServerException
This method has the same effect as calling waitForStableDisplay(400 2)
ChannelException
- if the connection is meta-data only
ServerException
- if a Host Integrator server error occurspublic void waitForStableDisplay(int durationMilliSeconds, int timeLimitSeconds) throws ChannelException, ServerException
durationMilliSeconds
- Duration of host communication silencetimeLimitSeconds
- Maximum time to wait for the duration of silence to occur.
ChannelException
- if the connection is meta-data only
ServerException
- if a Host Integrator server error occurspublic boolean terminalUpdatesPresent() throws ChannelException, ServerException
ChannelException
- if the connection is meta-data only
ServerException
- if a Host Integrator server error occurspublic TerminalScreen getTerminalScreen() throws ChannelException, ServerException
TerminalScreen
object
ChannelException
- if the connection is meta-data only
ServerException
- if a Host Integrator server error occurspublic int getScreenCRC() throws ChannelException, ServerException
ChannelException
- if the connection is meta-data only
ServerException
- if a Host Integrator server error occurspublic void setCurrentEntity(java.lang.String entityName) throws AppConnException, ApptrieveException
AppConnModel
Sets the current entity.
The legacy application will traverse to the screen that corresponds to that entity.
Reasons for failure include:
setCurrentEntity
in interface AppConnModel
setCurrentEntity
in class AppConnSession
entityName
- java.lang.String - Name of the entity in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursAppConnModel.getCurrentEntity()
public void setCurrentRecordSetByName(java.lang.String recordSetName) throws AppConnException, ApptrieveException
AppConnModel
Sets the current recordset by name. This is only needed if there is more than one recordset for the current entity.
setCurrentRecordSetByName
in interface AppConnModel
setCurrentRecordSetByName
in class AppConnSession
recordSetName
- java.lang.String - The name of the recordset to make current
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursAppConnModel.getCurrentRecordSetName()
public AppConnRecordSet fetchRecords(int maxRows, java.util.List fieldNames, java.lang.String filterExpression) throws ApptrieveException
AppConnModel
For fetchRecords, the current record is the last record included in returned set of records.
If attributeNames is null, fetchRecords will return all fields for each record.
fetchRecords
in interface AppConnModel
fetchRecords
in class AppConnSession
maxRows
- int - The maximum number of rows that will be fetchfieldNames
- java.util.List - List of the field names to fetch from the entityfilterExpression
- java.lang.String - An expression that qualifies the records to fetch
ApptrieveException
- - if a Host Integrator server error occurspublic AppConnModelRecord nextRecord(java.lang.String filterExpression) throws ApptrieveException
AppConnModel
AppConnModel
for filter expression syntax.
Searching starts with the record following the current record. If the current record is before the first record in the recordset, searching starts with the first record.
nextRecord
in interface AppConnModel
nextRecord
in class AppConnSession
filterExpression
- java.lang.String - An expression that qualifies the record
to find. (null matches any record)
ApptrieveException
- - if a Host Integrator server error occurspublic AppConnModelRecord getCurrentRecord() throws ApptrieveException
AppConnModel
Fetches the current record in the current recordset.
getCurrentRecord
in interface AppConnModel
getCurrentRecord
in class AppConnSession
ApptrieveException
- - if a Host Integrator server error occursAppConnModel.nextRecord(java.lang.String)
,
AppConnModel.setCurrentRecordIndex(int)
,
AppConnModel.getCurrentRecordIndex()
public int getCurrentRecordIndex() throws ApptrieveException
AppConnModel
getCurrentRecordIndex
in interface AppConnModel
getCurrentRecordIndex
in class AppConnSession
ApptrieveException
- - if a Host Integrator server error occursAppConnModel.setCurrentRecordIndex(int)
,
AppConnModel.getCurrentRecord()
public boolean setCurrentRecordIndex(int index) throws ApptrieveException
AppConnModel
Changes the index number of the current record in the current recordset.
To force the current record to be the current host record, use
the AppConnModel field AppConnModel.SyncToHost
, which has a value of -1, as the index parameter.
setCurrentRecordIndex
in interface AppConnModel
setCurrentRecordIndex
in class AppConnSession
index
- int - The index of the record to make current
ApptrieveException
- - if a Host Integrator server error occursAppConnModel.getCurrentRecordIndex()
,
AppConnModel.getCurrentRecord()
public void setHiddenAttributes(java.util.List attributes)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |