public class ESDS_Browse extends KeyedFileBrowse
This class implements the CICS File Control interface for browsing ESDS files via RBA.
com.ibm.cics.server.API
for general restrictions on using the JCICS API.
FileBrowse.LocalVars
Modifier and Type | Method and Description |
---|---|
long |
next(long inputRBA,
RecordHolder record)
Read the next record during a browse, changing the current position.
|
long |
next(RecordHolder record)
Read the next record during a browse.
|
long |
previous(long inputRBA,
RecordHolder record)
Read the previous record during a browse, changing the current position.
|
long |
previous(RecordHolder record)
Read the previous record during a browse.
|
void |
reset(long inputRBA)
Reset the browse.
|
next, next, previous, previous, reset, reset, reset, reset
end, getRequestID
public long next(long inputRBA, RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
inputRBA
- The RBA of the record at which to
(re)start the browse.record
- The record readFileDisabledException
- The file is disabled.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 recordsNotAuthorisedException
- 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
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic long next(RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
record
- The record readFileDisabledException
- The file is disabled.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 recordsNotAuthorisedException
- 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
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic long previous(long inputRBA, RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
inputRBA
- The RBA of the record at which to
(re)start the browse.record
- The record readFileDisabledException
- The file is disabled.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 recordsNotAuthorisedException
- 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
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic long previous(RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
record
- The record readFileDisabledException
- The file is disabled.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 recordsNotAuthorisedException
- 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
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void reset(long inputRBA) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
inputRBA
- The RBA 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
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGED