|
||||||||||
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.RRDS_Browse
This class implements the CICS File Control interface for browsing RRDS files via RRN.
Method Summary | |
---|---|
long |
next(long inputRRN,
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 inputRRN,
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 inputRRN)
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 long next(long inputRRN, RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException
inputRRN
- The RRN of the record at which to
(re)start the browse.record
- The record read
FileDisabledException
- 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.
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).public long next(RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException
record
- The record read
FileDisabledException
- 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.
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).public long previous(long inputRRN, RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException
inputRRN
- The RRN of the record at which to
(re)start the browse.record
- The record read
FileDisabledException
- 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 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).public long previous(RecordHolder record) throws FileDisabledException, EndOfFileException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException
record
- The record read
FileDisabledException
- 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 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).public void reset(long inputRRN) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException
inputRRN
- The RRN 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).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |