com.ibm.cics.server
Class ESDS

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.KeyedFile
                  extended by com.ibm.cics.server.ESDS
All Implemented Interfaces:
java.io.Serializable

public class ESDS
extends KeyedFile
implements java.io.Serializable

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

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

Constructor Summary
ESDS()
          Construct a default ESDS object.
 
Method Summary
 boolean isXRBA()
          isXRBA.
 void read(long byteAddress, RecordHolder holder)
          Read a specific record from an ESDS file.
 void readForUpdate(long byteAddress, RecordHolder holder)
          Read a specific record from an ESDS file and lock it for update.
 void rewrite(byte[] data)
          Update a record in a file.
 void setXRBA(boolean XRBA)
          SetXRBA.
 ESDS_Browse startBrowse(long byteAddress)
          Create a browse against the file.
 void unlock()
          Unlock a file.
 long write(byte[] data)
          Write a new record to a file.
 long write(byte[] alternateKey, byte[] data)
          Write a new record to a file via an alternate key.
 
Methods inherited from class com.ibm.cics.server.KeyedFile
read, read, readForUpdate, readForUpdate, readGeneric, readGeneric, readGenericForUpdate, readGenericForUpdate, startBrowse, startBrowse, startGenericBrowse, startGenericBrowse
 
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

ESDS

public ESDS()
Construct a default ESDS object.

Method Detail

setXRBA

public void setXRBA(boolean XRBA)
SetXRBA. The RBA will by default be assumed to be an ordinary RBA. Use this method to use an Extended RBA (XRBA).

Parameters:
XRBA -

isXRBA

public boolean isXRBA()
isXRBA. Return the value of the XRBA setting

Returns:
XRBA

read

public void read(long byteAddress,
                 RecordHolder holder)
          throws FileDisabledException,
                 FileNotFoundException,
                 LogicException,
                 InvalidRequestException,
                 IOErrorException,
                 ISCInvalidRequestException,
                 LengthErrorException,
                 NotAuthorisedException,
                 RecordNotFoundException,
                 NotOpenException,
                 InvalidSystemIdException,
                 ChangedException,
                 LockedException,
                 LoadingException,
                 RecordBusyException
Read a specific record from an ESDS file.

Parameters:
byteAddress - the record to read
holder - a holder for the record to read
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

readForUpdate

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

Parameters:
byteAddress - the record to read
holder - a holder for the record to read
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

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.

Overrides:
rewrite in class KeyedFile
Parameters:
data -
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NoSpaceException
NotAuthorisedException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

startBrowse

public ESDS_Browse startBrowse(long byteAddress)
                        throws FileDisabledException,
                               FileNotFoundException,
                               LogicException,
                               InvalidRequestException,
                               IOErrorException,
                               ISCInvalidRequestException,
                               NotAuthorisedException,
                               RecordNotFoundException,
                               NotOpenException,
                               InvalidSystemIdException,
                               ChangedException,
                               LockedException,
                               LoadingException,
                               RecordBusyException
Create a browse against the file.

Parameters:
byteAddress - The RBA of the record at which to start the browse.
Returns:
a browse object
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

write

public long write(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:
data -
Returns:
.
Throws:
FileDisabledException
DuplicateRecordException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NoSpaceException
NotAuthorisedException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

write

public long write(byte[] alternateKey,
                  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 via an alternate key.

Parameters:
alternateKey - The alternate key for the new record
data - The data for the new record
Returns:
.
Throws:
FileDisabledException
DuplicateRecordException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NoSpaceException
NotAuthorisedException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

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