com.ibm.cics.server
Class FileBrowse

java.lang.Object
  extended by com.ibm.cics.server.API
      extended by com.ibm.cics.server.FileBrowse
Direct Known Subclasses:
KeyedFileBrowse, RRDS_Browse

public class FileBrowse
extends API

This class is the superclass of all of the browse-related implementation classes.

Version:
1.15.1.3
Author:
John Colgrave

Nested Class Summary
static class FileBrowse.LocalVars
           
 
Method Summary
 void end()
          End the browse.
 short getRequestID()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

end

public void end()
         throws FileDisabledException,
                FileNotFoundException,
                LogicException,
                InvalidRequestException,
                ISCInvalidRequestException,
                NotAuthorisedException,
                NotOpenException,
                InvalidSystemIdException
End 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 - The file does not have a browse active.
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.
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).

getRequestID

public short getRequestID()
Returns:
the request identifier