com.ibm.cics.server
Class RRDS

java.lang.Object
  extended bycom.ibm.cics.server.API
      extended bycom.ibm.cics.server.Resource
          extended bycom.ibm.cics.server.RemotableResource
              extended bycom.ibm.cics.server.File
                  extended bycom.ibm.cics.server.RRDS
All Implemented Interfaces:
java.io.Serializable

public class RRDS
extends com.ibm.cics.server.File
implements java.io.Serializable

This class is the implementation class for the RRDS kind of file.

Version:
1.2
Author:
John Colgrave
See Also:
Serialized Form

Constructor Summary
RRDS()
          Construct a default RRDS object.
 
Method Summary
 void delete()
          Delete a record from an RRDS file.
 void delete(long recordNumber)
          Delete a record from an RRDS file.
 void read(long recordNumber, RecordHolder holder)
          Read a specific record from an RRDS file.
 void readForUpdate(long recordNumber, RecordHolder holder)
          Read a specific record from an RRDS file and lock it for update.
 void rewrite(byte[] data)
          Update a record in a file.
 RRDS_Browse startBrowse(long recordNumber)
          Start a browse on a file
 void unlock()
          Unlock a file.
 void write(long recordNumber, byte[] data)
          Write a new record to a file.
 
Methods inherited from class com.ibm.cics.server.RemotableResource
getSysId, setSysId
 
Methods inherited from class com.ibm.cics.server.Resource
getDescription, getName, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RRDS

public RRDS()
Construct a default RRDS object.

Method Detail

delete

public void delete()
            throws FileDisabledException,
                   FileNotFoundException,
                   LogicException,
                   InvalidRequestException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   RecordNotFoundException,
                   NotOpenException,
                   InvalidSystemIdException
Delete a record from an RRDS file.

Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a

delete

public void delete(long recordNumber)
            throws FileDisabledException,
                   FileNotFoundException,
                   LogicException,
                   InvalidRequestException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   RecordNotFoundException,
                   NotOpenException,
                   InvalidSystemIdException
Delete a record from an RRDS file.

Parameters:
recordNumber - a
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a

read

public void read(long recordNumber,
                 RecordHolder holder)
          throws FileDisabledException,
                 FileNotFoundException,
                 LogicException,
                 InvalidRequestException,
                 IOErrorException,
                 ISCInvalidRequestException,
                 LengthErrorException,
                 NotAuthorisedException,
                 RecordNotFoundException,
                 NotOpenException,
                 InvalidSystemIdException
Read a specific record from an RRDS file.

Parameters:
recordNumber - a
holder - a
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
LengthErrorException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a

readForUpdate

public void readForUpdate(long recordNumber,
                          RecordHolder holder)
                   throws FileDisabledException,
                          FileNotFoundException,
                          LogicException,
                          InvalidRequestException,
                          IOErrorException,
                          ISCInvalidRequestException,
                          LengthErrorException,
                          NotAuthorisedException,
                          RecordNotFoundException,
                          NotOpenException,
                          InvalidSystemIdException
Read a specific record from an RRDS file and lock it for update.

Parameters:
recordNumber - a
holder - a
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
LengthErrorException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a

rewrite

public void rewrite(byte[] data)
             throws FileDisabledException,
                    FileNotFoundException,
                    LogicException,
                    InvalidRequestException,
                    IOErrorException,
                    ISCInvalidRequestException,
                    LengthErrorException,
                    NoSpaceException,
                    NotAuthorisedException,
                    NotOpenException,
                    InvalidSystemIdException
Update a record in a file.

Parameters:
data - a
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
LengthErrorException - a
NoSpaceException - a
NotAuthorisedException - a
NotOpenException - a
InvalidSystemIdException - a

startBrowse

public RRDS_Browse startBrowse(long recordNumber)
                        throws FileDisabledException,
                               FileNotFoundException,
                               LogicException,
                               InvalidRequestException,
                               IOErrorException,
                               ISCInvalidRequestException,
                               NotAuthorisedException,
                               RecordNotFoundException,
                               NotOpenException,
                               InvalidSystemIdException
Start a browse on a file

Parameters:
recordNumber - a
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a

write

public void write(long recordNumber,
                  byte[] data)
           throws FileDisabledException,
                  DuplicateRecordException,
                  FileNotFoundException,
                  LogicException,
                  InvalidRequestException,
                  IOErrorException,
                  ISCInvalidRequestException,
                  LengthErrorException,
                  NoSpaceException,
                  NotAuthorisedException,
                  NotOpenException,
                  InvalidSystemIdException
Write a new record to a file.

Parameters:
recordNumber - a
data - a
Throws:
FileDisabledException - a
DuplicateRecordException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
LengthErrorException - a
NoSpaceException - a
NotAuthorisedException - a
NotOpenException - a
InvalidSystemIdException - a

unlock

public void unlock()
            throws FileDisabledException,
                   FileNotFoundException,
                   LogicException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   NotOpenException,
                   InvalidSystemIdException
Unlock a file.

Throws:
FileDisabledException
FileNotFoundException
LogicException
IOErrorException
ISCInvalidRequestException
NotAuthorisedException
NotOpenException
InvalidSystemIdException