ESDS

java.lang.Object
- com.ibm.cics.server.API
- - com.ibm.cics.server.Resource
  - - com.ibm.cics.server.RemotableResource
    - - com.ibm.cics.server.KeyedFile
      - com.ibm.cics.server.ESDS

All Implemented Interfaces:

java.io.Serializable
```
public class ESDS
extends KeyedFile
```
This class is the implementation class for the ESDS kind of file.

See Also:
com.ibm.cics.server.API for general restrictions on using the JCICS API., Serialized Form
Since CICS TS version:

1.3

Since package version:

1.0

Constructor Summary

Constructors
Constructor and Description

ESDS()
Construct a default ESDS object.

Constructors
Constructor and Description
`ESDS()` Construct a default ESDS object.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
  
  Since CICS TS version:
  
  1.3
  
  Since package version:
  
  1.0

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 - true if set
Since CICS TS version:

3.2

Since package version:

1.100

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

Returns:
XRBA
Since CICS TS version:

3.2

Since package version:

1.100

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 - DISABLED; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; LengthErrorException - LENGERR; NotAuthorisedException - NOTAUTH; RecordNotFoundException - NOTFND; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; RecordBusyException - RECORDBUSY; LoadingException - LOADING; LockedException - LOCKED; ChangedException - CHANGED
Since CICS TS version:: 1.3
Since package version:: 1.0

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 - DISABLED; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; LengthErrorException - LENGERR; NotAuthorisedException - NOTAUTH; RecordNotFoundException - NOTFND; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; 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.

Overrides:: rewrite in class KeyedFile
Parameters:: data - data to write
Throws:: FileDisabledException - DISABLED; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; LengthErrorException - LENGERR; NoSpaceException - NOSPACE; NotAuthorisedException - NOTAUTH; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; RecordBusyException - RECORDBUSY; LoadingException - LOADING; LockedException - LOCKED; ChangedException - CHANGED
Since CICS TS version:: 1.3
Since package version:: 1.0

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 - DISABLED; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; NotAuthorisedException - NOTAUTH; RecordNotFoundException - NOTFND; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; RecordBusyException - RECORDBUSY; LoadingException - LOADING; LockedException - LOCKED; ChangedException - CHANGED
Since CICS TS version:: 1.3
Since package version:: 1.0

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 - data to write
Returns:: RBA value
Throws:: FileDisabledException - DISABLED; DuplicateRecordException - DUPREC; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; LengthErrorException - LENGERR; NoSpaceException - NOSPACE; NotAuthorisedException - NOTAUTH; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; RecordBusyException - RECORDBUSY; LoadingException - LOADING; LockedException - LOCKED; ChangedException - CHANGED
Since CICS TS version:: 1.3
Since package version:: 1.0

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 - DISABLED; DuplicateRecordException - DUPREC; FileNotFoundException - FILENOTFOUND; LogicException - ILLOGIC; InvalidRequestException - INVREQ; IOErrorException - IOERR; ISCInvalidRequestException - ISCINVREQ; LengthErrorException - LENGERR; NoSpaceException - NOSPACE; NotAuthorisedException - NOTAUTH; NotOpenException - NOTOPEN; InvalidSystemIdException - SYSIDERR; 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

Class ESDS

Constructor Summary

Method Summary

Methods inherited from class com.ibm.cics.server.KeyedFile

Methods inherited from class com.ibm.cics.server.RemotableResource

Methods inherited from class com.ibm.cics.server.Resource

Methods inherited from class java.lang.Object

Constructor Detail

ESDS

Method Detail

setXRBA

isXRBA

read

readForUpdate

rewrite

startBrowse

write

write

unlock