com.ibm.cics.server
Class KSDS

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.KSDS
All Implemented Interfaces:
java.io.Serializable

public class KSDS
extends KeyedFile

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

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

Constructor Summary
KSDS()
          Construct a default KSDS bean.
 
Method Summary
 void delete()
          Delete a record from a KSDS file.
 void delete(byte[] key)
           
 int deleteGeneric(byte[] key)
           
 void unlock()
          Unlock a file.
 void write(byte[] key, byte[] data)
          Write a new record to a file.
 
Methods inherited from class com.ibm.cics.server.KeyedFile
read, read, readForUpdate, readForUpdate, readGeneric, readGeneric, readGenericForUpdate, readGenericForUpdate, rewrite, 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

KSDS

public KSDS()
Construct a default KSDS bean.

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,
                   NotOpenException,
                   InvalidSystemIdException,
                   ChangedException,
                   LockedException,
                   LoadingException,
                   RecordBusyException
Delete a record from a KSDS file.

Throws:
FileDisabledException - DISABLED
FileNotFoundException - FILENOTFOUND
LogicException - ILLOGIC
InvalidRequestException - INVREQ
IOErrorException - IOERR
ISCInvalidRequestException - ISCINVREQ
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

delete

public void delete(byte[] key)
            throws FileDisabledException,
                   DuplicateKeyException,
                   FileNotFoundException,
                   LogicException,
                   InvalidRequestException,
                   IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   RecordNotFoundException,
                   NotOpenException,
                   InvalidSystemIdException,
                   ChangedException,
                   LockedException,
                   LoadingException,
                   RecordBusyException
Parameters:
key - the key to delete
Throws:
FileDisabledException - DISABLED
DuplicateKeyException - DUPKEY
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

deleteGeneric

public int deleteGeneric(byte[] key)
                  throws FileDisabledException,
                         FileNotFoundException,
                         LogicException,
                         InvalidRequestException,
                         IOErrorException,
                         ISCInvalidRequestException,
                         NotAuthorisedException,
                         RecordNotFoundException,
                         NotOpenException,
                         InvalidSystemIdException,
                         ChangedException,
                         LockedException,
                         LoadingException,
                         RecordBusyException
Parameters:
key - the key to delete
Returns:
the number of deleted records
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 void write(byte[] key,
                  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:
key - the record key
data - the data to write
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