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
implements java.io.Serializable

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

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

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.

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 - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
NotAuthorisedException - a
NotOpenException - a
InvalidSystemIdException - a
RecordBusyException
LoadingException
LockedException
ChangedException

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
DuplicateKeyException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

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:
.
Throws:
FileDisabledException
FileNotFoundException
LogicException
InvalidRequestException
IOErrorException
ISCInvalidRequestException
NotAuthorisedException
RecordNotFoundException
NotOpenException
InvalidSystemIdException
RecordBusyException
LoadingException
LockedException
ChangedException

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 - a
data - a
Throws:
FileDisabledException - a
DuplicateRecordException - a
FileNotFoundException - a
LogicException - a
InvalidRequestException - a
IOErrorException - a
ISCInvalidRequestException - a
LengthErrorException - a
NoSpaceException - a
NotAuthorisedException - a
NotOpenException - a
InvalidSystemIdException - a
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