com.ibm.cics.server
Class ESDS

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.KeyedFile
                      extended bycom.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.

See Also:
Serialized Form

Constructor Summary
ESDS()
          Construct a default ESDS object.
 
Method Summary
 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.
 ESDS_Browse startBrowse(long byteAddress)
          Create a browse against the 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, unlock
 
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

read

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

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

readForUpdate

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

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

rewrite

public void rewrite(byte[] data)
             throws FileDisabledException,
                    FileNotFoundException,
                    LogicException,
                    InvalidRequestException,
                    IOErrorException,
                    ISCInvalidRequestException,
                    LengthErrorException,
                    NoSpaceException,
                    NotAuthorisedException,
                    NotOpenException,
                    InvalidSystemIdException
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

startBrowse

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

Parameters:
byteAddress - The RBA of the record at which to start the browse.
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException

write

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

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

write

public long write(byte[] alternateKey,
                  byte[] data)
           throws FileDisabledException,
                  DuplicateRecordException,
                  FileNotFoundException,
                  LogicException,
                  InvalidRequestException,
                  IOErrorException,
                  ISCInvalidRequestException,
                  LengthErrorException,
                  NoSpaceException,
                  NotAuthorisedException,
                  NotOpenException,
                  InvalidSystemIdException
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
Throws:
FileDisabledException
DuplicateRecordException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
LengthErrorException
NoSpaceException
NotAuthorisedException
NotOpenException
InvalidSystemIdException