com.ibm.cics.server
Class RRDS_Browse

java.lang.Object
  |
  +--com.ibm.cics.server.API
        |
        +--com.ibm.cics.server.FileBrowse
              |
              +--com.ibm.cics.server.RRDS_Browse

public class RRDS_Browse
extends FileBrowse

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

next

public long next(long inputRRN,
                 RecordHolder record)
          throws FileDisabledException,
                 EndOfFileException,
                 FileNotFoundException,
                 LogicException,
                 InvalidRequestException,
                 IOErrorException,
                 ISCInvalidRequestException,
                 NotAuthorisedException,
                 RecordNotFoundException,
                 NotOpenException,
                 InvalidSystemIdException
Read the next record during a browse, changing the current position.
Parameters:
inputRRN - The RRN of the record at which to (re)start the browse.
record - The record read
Returns:
The RRN of the record read
Throws:
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:
  • A browse has not been started on the file
  • A browse through a different interface is already in progress on the file
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:
  • When a resource security check is unsuccessful on the file.
  • When the file is constructed with a SYSID and the current transaction is defined with the RSLCheck attribute set to either internal or external.
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:
  • When the file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file, and the file is no longer in use.
  • When the file is OPEN and in use by other transactions, but a CLOSE request has been received. Current activity is allowed to complete, but no new activity is allowed to start.
InvalidSystemIdException - This exception is thrown if the named connection cannot be found in the Communications Definitions (CD).

next

public long next(RecordHolder record)
          throws FileDisabledException,
                 EndOfFileException,
                 FileNotFoundException,
                 LogicException,
                 InvalidRequestException,
                 IOErrorException,
                 ISCInvalidRequestException,
                 NotAuthorisedException,
                 RecordNotFoundException,
                 NotOpenException,
                 InvalidSystemIdException
Read the next record during a browse.
Parameters:
record - The record read
Returns:
The RRN of the record read
Throws:
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:
  • A browse has not been started on the file
  • A browse through a different interface is already in progress on the file
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:
  • When a resource security check is unsuccessful on the file.
  • When the file is constructed with a SYSID and the current transaction is defined with the RSLCheck attribute set to either internal or external.
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:
  • When the file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file, and the file is no longer in use.
  • When the file is OPEN and in use by other transactions, but a CLOSE request has been received. Current activity is allowed to complete, but no new activity is allowed to start.
InvalidSystemIdException - This exception is thrown if the named connection cannot be found in the Communications Definitions (CD).

previous

public long previous(long inputRRN,
                     RecordHolder record)
              throws FileDisabledException,
                     EndOfFileException,
                     FileNotFoundException,
                     LogicException,
                     InvalidRequestException,
                     IOErrorException,
                     ISCInvalidRequestException,
                     LengthErrorException,
                     NotAuthorisedException,
                     RecordNotFoundException,
                     NotOpenException,
                     InvalidSystemIdException
Read the previous record during a browse, changing the current position.
Parameters:
inputRRN - The RRN of the record at which to (re)start the browse.
record - The record read
Returns:
The RRN of the record read
Throws:
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:
  • A browse has not been started on the file
  • A browse through a different interface is already in progress on the file
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:
  • When a resource security check is unsuccessful on the file.
  • When the file is constructed with a SYSID and the current transaction is defined with the RSLCheck attribute set to either internal or external.
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:
  • When the file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file, and the file is no longer in use.
  • When the file is OPEN and in use by other transactions, but a CLOSE request has been received. Current activity is allowed to complete, but no new activity is allowed to start.
InvalidSystemIdException - This exception is thrown if the named connection cannot be found in the Communications Definitions (CD).

previous

public long previous(RecordHolder record)
              throws FileDisabledException,
                     EndOfFileException,
                     FileNotFoundException,
                     LogicException,
                     InvalidRequestException,
                     IOErrorException,
                     ISCInvalidRequestException,
                     LengthErrorException,
                     NotAuthorisedException,
                     RecordNotFoundException,
                     NotOpenException,
                     InvalidSystemIdException
Read the previous record during a browse.
Parameters:
record - The record read
Returns:
The RRN of the record read
Throws:
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:
  • A browse has not been started on the file
  • A browse through a different interface is already in progress on the file
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:
  • When a resource security check is unsuccessful on the file.
  • When the file is constructed with a SYSID and the current transaction is defined with the RSLCheck attribute set to either internal or external.
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:
  • When the file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file, and the file is no longer in use.
  • When the file is OPEN and in use by other transactions, but a CLOSE request has been received. Current activity is allowed to complete, but no new activity is allowed to start.
InvalidSystemIdException - This exception is thrown if the named connection cannot be found in the Communications Definitions (CD).

reset

public void reset(long inputRRN)
           throws FileDisabledException,
                  FileNotFoundException,
                  LogicException,
                  InvalidRequestException,
                  IOErrorException,
                  ISCInvalidRequestException,
                  NotAuthorisedException,
                  RecordNotFoundException,
                  NotOpenException,
                  InvalidSystemIdException
Reset the browse.
Parameters:
inputRRN - The RRN of the record at which to restart the browse.
Throws:
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:
  • A browse has not been started on the file
  • A browse through a different interface is already in progress on the file
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:
  • When a resource security check is unsuccessful on the file.
  • When the file is constructed with a SYSID and the current transaction is defined with the RSLCheck attribute set to either internal or external.
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:
  • When the file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file, and the file is no longer in use.
  • When the file is OPEN and in use by other transactions, but a CLOSE request has been received. Current activity is allowed to complete, but no new activity is allowed to start.
InvalidSystemIdException - This exception is thrown if the named connection cannot be found in the Communications Definitions (CD).