|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.cics.server.API
com.ibm.cics.server.FileBrowse
com.ibm.cics.server.KeyedFileBrowse
public class KeyedFileBrowse
This class implements browsing a keyed file.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ibm.cics.server.FileBrowse |
---|
FileBrowse.LocalVars |
Method Summary | |
---|---|
void |
next(byte[] inputKey,
RecordHolder record,
KeyHolder outputKey)
Read the next record during a browse, changing the current position. |
void |
next(RecordHolder record,
KeyHolder outputKey)
Read the next record during a browse. |
void |
previous(byte[] inputKey,
RecordHolder record,
KeyHolder outputKey)
Read the previous record during a browse, changing the current position. |
void |
previous(RecordHolder record,
KeyHolder outputKey)
Read the previous record during a browse. |
void |
reset(byte[] key)
Reset the browse. |
void |
reset(byte[] key,
boolean generic)
Reset the browse. |
void |
reset(byte[] key,
boolean generic,
SearchType searchType)
Reset the browse. |
void |
reset(byte[] key,
SearchType searchType)
Reset the browse. |
Methods inherited from class com.ibm.cics.server.FileBrowse |
---|
end, getRequestID |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void next(byte[] inputKey, RecordHolder record, KeyHolder outputKey) throws FileDisabledException, DuplicateKeyException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
inputKey
- The (possibly generic) key of the record at which to
(re)start the browse.record
- The record readoutputKey
- The key of the record read
FileDisabledException
- The file is disabled.
DuplicateKeyException
- This exception is thrown
if a record is retrieved by way of an alternate index that supports
non-unique keys, and another alternate index record with the same key
follows.
It does not occur as a result of a next() call that reads the last of
the records having the non-unique key.
EndOfFileException
- This exception is thrown
if an end-of-file condition is detected during the browse.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
LengthErrorException
- This exception is thrown
if an incorrect length is specified for a file with fixed-length records
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void next(RecordHolder record, KeyHolder outputKey) throws FileDisabledException, DuplicateKeyException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
record
- The record readoutputKey
- The key of the record read
FileDisabledException
- The file is disabled.
DuplicateKeyException
- This exception is thrown
if a record is retrieved by way of an alternate index that supports
non-unique keys, and another alternate index record with the same key
follows.
It does not occur as a result of a next() call that reads the last of
the records having the non-unique key.
EndOfFileException
- This exception is thrown
if an end-of-file condition is detected during the browse.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
LengthErrorException
- This exception is thrown
if an incorrect length is specified for a file with fixed-length records
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void previous(byte[] inputKey, RecordHolder record, KeyHolder outputKey) throws FileDisabledException, DuplicateKeyException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
inputKey
- The (possibly generic) key of the record at which to
(re)start the browse.record
- The record readoutputKey
- The key of the record read
FileDisabledException
- The file is disabled.
DuplicateKeyException
- This exception is thrown
if a record is retrieved by way of an alternate index that supports
non-unique keys, and another alternate index record with the same key
follows.
It does not occur as a result of a previous() call that reads the last of
the records having the non-unique key.
EndOfFileException
- This exception is thrown
if an end-of-file condition is detected during the browse.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
LengthErrorException
- This exception is thrown
if an incorrect length is specified for a file with fixed-length records
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void previous(RecordHolder record, KeyHolder outputKey) throws FileDisabledException, DuplicateKeyException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
record
- The record readoutputKey
- The key of the record read
FileDisabledException
- The file is disabled.
DuplicateKeyException
- This exception is thrown
if a record is retrieved by way of an alternate index that supports
non-unique keys, and another alternate index record with the same key
follows.
It does not occur as a result of a previous() call that reads the last of
the records having the non-unique key.
EndOfFileException
- This exception is thrown
if an end-of-file condition is detected during the browse.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
LengthErrorException
- This exception is thrown
if an incorrect length is specified for a file with fixed-length records
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void reset(byte[] key) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
key
- The key of the record at which to restart the browse.
FileDisabledException
- The file is disabled.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void reset(byte[] key, SearchType searchType) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
key
- The key of the record at which to restart the browse.searchType
- A value specifying the type of search to use.
Possible values are:
FileDisabledException
- The file is disabled.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void reset(byte[] key, boolean generic) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
key
- The key of the record at which to restart the browse.generic
- Whether or not the browse should use generic keys.
FileDisabledException
- The file is disabled.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGEDpublic void reset(byte[] key, boolean generic, SearchType searchType) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
key
- The key of the record at which to restart the browse.generic
- Whether or not the browse should use generic keys.searchType
- A value specifying the type of search to use.
Possible values are:
FileDisabledException
- The file is disabled.
FileNotFoundException
- The file is not defined in the File
Definitions (FD).
LogicException
- An error not covered by any other exception
occurred.
InvalidRequestException
- This exception is thrown for the
following reasons:
IOErrorException
- This exception is thrown if there is an
I/O error during the file control operation.
ISCInvalidRequestException
- This exception is thrown
if the remote system indicates a failure that does not correspond to a
known condition.
NotAuthorisedException
- This exception is thrown
for the following reasons:
RecordNotFoundException
- This exception is thrown
if an attempt is made to start the browse positioned on a record which
cannot be found.
NotOpenException
- This exception is thrown
for the following reasons:
InvalidSystemIdException
- This exception is thrown
if the named connection cannot be found in the Communications
Definitions (CD).
RecordBusyException
- RECORDBUSY
LoadingException
- LOADING
LockedException
- LOCKED
ChangedException
- CHANGED
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |