public class RRDS extends RemotableResource
com.ibm.cics.server.API
for general
restrictions on using the JCICS API.
,
Serialized FormConstructor and Description |
---|
RRDS()
Construct a default RRDS object.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getSysId, setSysId
getDescription, getName, setDescription, setName
public RRDS()
public void delete() throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
FileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQNotAuthorisedException
- NOTAUTHRecordNotFoundException
- NOTFNDNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void delete(long recordNumber) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
recordNumber
- The record number to deleteFileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQNotAuthorisedException
- NOTAUTHRecordNotFoundException
- NOTFNDNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void read(long recordNumber, RecordHolder holder) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
recordNumber
- The record numberholder
- The RecordHolder in which is returned a byte array containing
the record.
If you know in advance the size of the object to be returned
you can initialise the holder with a byte array of the correct
size and CICS will not then allocate one.
If you pass in a byte array shorter than is necessary CICS
will ignore it and allocate an array of the correct size.
The reference to the original array will be lost.FileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQLengthErrorException
- LENGERRNotAuthorisedException
- NOTAUTHRecordNotFoundException
- NOTFNDNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void readForUpdate(long recordNumber, RecordHolder holder) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
recordNumber
- The record numberholder
- The RecordHolder in which is returned a byte array containing
the record.
If you know in advance the size of the object to be returned
you can initialise the holder with a byte array of the correct
size and CICS will not then allocate one.
If you pass in a byte array shorter than is necessary CICS
will ignore it and allocate an array of the correct size.
The reference to the original array will be lost.FileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQLengthErrorException
- LENGERRNotAuthorisedException
- NOTAUTHRecordNotFoundException
- NOTFNDNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void rewrite(byte[] data) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NoSpaceException, NotAuthorisedException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
data
- The data comprising the new value of the record.FileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQLengthErrorException
- LENGERRNoSpaceException
- NOSPACENotAuthorisedException
- NOTAUTHNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic RRDS_Browse startBrowse(long recordNumber) throws FileDisabledException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, RecordNotFoundException, NotOpenException, InvalidSystemIdException, LoadingException
recordNumber
- the record numberFileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQNotAuthorisedException
- NOTAUTHRecordNotFoundException
- NOTFNDNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRLoadingException
- LOADINGpublic void write(long recordNumber, byte[] data) throws FileDisabledException, DuplicateRecordException, FileNotFoundException, LogicException, InvalidRequestException, IOErrorException, ISCInvalidRequestException, LengthErrorException, NoSpaceException, NotAuthorisedException, NotOpenException, InvalidSystemIdException, ChangedException, LockedException, LoadingException, RecordBusyException
recordNumber
- The record numberdata
- the data to writeFileDisabledException
- DISABLEDDuplicateRecordException
- DUPRECFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICInvalidRequestException
- INVREQIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQLengthErrorException
- LENGERRNoSpaceException
- NOSPACENotAuthorisedException
- NOTAUTHNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERRRecordBusyException
- RECORDBUSYLoadingException
- LOADINGLockedException
- LOCKEDChangedException
- CHANGEDpublic void unlock() throws FileDisabledException, FileNotFoundException, LogicException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, NotOpenException, InvalidSystemIdException
FileDisabledException
- DISABLEDFileNotFoundException
- FILENOTFOUNDLogicException
- ILLOGICIOErrorException
- IOERRISCInvalidRequestException
- ISCINVREQNotAuthorisedException
- NOTAUTHNotOpenException
- NOTOPENInvalidSystemIdException
- SYSIDERR