com.ibm.cics.server
Class RRDS

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

public class RRDS
extends RemotableResource

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

See Also:
Serialized Form
Since CICS TS version:
1.3
Since package version:
1.0

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.

Since CICS TS version:
1.3
Since package version:
1.0
Method Detail

delete

public void delete()
            throws FileDisabledException,
                   FileNotFoundException,
                   LogicException,
                   InvalidRequestException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   RecordNotFoundException,
                   NotOpenException,
                   InvalidSystemIdException,
                   ChangedException,
                   LockedException,
                   LoadingException,
                   RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

delete

public void delete(long recordNumber)
            throws FileDisabledException,
                   FileNotFoundException,
                   LogicException,
                   InvalidRequestException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   RecordNotFoundException,
                   NotOpenException,
                   InvalidSystemIdException,
                   ChangedException,
                   LockedException,
                   LoadingException,
                   RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

read

public void read(long recordNumber,
                 RecordHolder holder)
          throws FileDisabledException,
                 FileNotFoundException,
                 LogicException,
                 InvalidRequestException,
                 IOErrorException,
                 ISCInvalidRequestException,
                 LengthErrorException,
                 NotAuthorisedException,
                 RecordNotFoundException,
                 NotOpenException,
                 InvalidSystemIdException,
                 ChangedException,
                 LockedException,
                 LoadingException,
                 RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

readForUpdate

public void readForUpdate(long recordNumber,
                          RecordHolder holder)
                   throws FileDisabledException,
                          FileNotFoundException,
                          LogicException,
                          InvalidRequestException,
                          IOErrorException,
                          ISCInvalidRequestException,
                          LengthErrorException,
                          NotAuthorisedException,
                          RecordNotFoundException,
                          NotOpenException,
                          InvalidSystemIdException,
                          ChangedException,
                          LockedException,
                          LoadingException,
                          RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

rewrite

public void rewrite(byte[] data)
             throws FileDisabledException,
                    FileNotFoundException,
                    LogicException,
                    InvalidRequestException,
                    IOErrorException,
                    ISCInvalidRequestException,
                    LengthErrorException,
                    NoSpaceException,
                    NotAuthorisedException,
                    NotOpenException,
                    InvalidSystemIdException,
                    ChangedException,
                    LockedException,
                    LoadingException,
                    RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

startBrowse

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

Parameters:
recordNumber - the record number
Returns:
a browse object
Throws:
FileDisabledException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
NotAuthorisedException - a
RecordNotFoundException - a
NotOpenException - a
InvalidSystemIdException - a
LoadingException - LOADING
Since CICS TS version:
1.3
Since package version:
1.0

write

public void write(long recordNumber,
                  byte[] data)
           throws FileDisabledException,
                  DuplicateRecordException,
                  FileNotFoundException,
                  LogicException,
                  InvalidRequestException,
                  IOErrorException,
                  ISCInvalidRequestException,
                  LengthErrorException,
                  NoSpaceException,
                  NotAuthorisedException,
                  NotOpenException,
                  InvalidSystemIdException,
                  ChangedException,
                  LockedException,
                  LoadingException,
                  RecordBusyException
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
RecordBusyException - RECORDBUSY
LoadingException - LOADING
LockedException - LOCKED
ChangedException - CHANGED
Since CICS TS version:
1.3
Since package version:
1.0

unlock

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

Throws:
FileDisabledException - DISABLED
FileNotFoundException - FILENOTFOUND
LogicException - ILLOGIC
IOErrorException - IOERR
ISCInvalidRequestException - ISCINVREQ
NotAuthorisedException - NOTAUTH
NotOpenException - NOTOPEN
InvalidSystemIdException - SYSIDERR
Since CICS TS version:
1.3
Since package version:
1.0