Package com.ibm.cics.server

Class KSDS

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.KSDS

All Implemented Interfaces:

Serializable

public class KSDS
extends KeyedFile

This class is the implementation class for the KSDS 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

Constructor Summary

Constructors

Constructor	Description
KSDS()	Construct a default KSDS bean.
KSDS(String name)	Construct a KSDS resource with a specific name

Method Summary

Modifier and Type	Method	Description
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, 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 com.ibm.cics.server.API

getCICSServerApiVersion

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KSDS

public KSDS()

Construct a default KSDS bean.

Since CICS TS version:

1.3

KSDS

public KSDS(String name)

Construct a KSDS resource with a specific name

Parameters:

name - The name of the resource to create

Since CICS TS version:

6.1

Method Details

delete

public void delete()
            throws FileDisabledException,
FileNotFoundException,
LogicException,
InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
NotAuthorisedException,
NotOpenException,
InvalidSystemIdException,
ChangedException,
LockedException,
LoadingException

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

LoadingException - LOADING

LockedException - LOCKED

ChangedException - CHANGED

Since CICS TS version:

1.3

delete

public void delete(byte[] key)
            throws FileDisabledException,
DuplicateKeyException,
FileNotFoundException,
LogicException,
InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
NotAuthorisedException,
RecordNotFoundException,
NotOpenException,
InvalidSystemIdException,
ChangedException,
LockedException,
LoadingException

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

LoadingException - LOADING

LockedException - LOCKED

ChangedException - CHANGED

Since CICS TS version:

1.3

deleteGeneric

public int deleteGeneric(byte[] key)
                  throws FileDisabledException,
FileNotFoundException,
LogicException,
InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
NotAuthorisedException,
RecordNotFoundException,
NotOpenException,
InvalidSystemIdException,
ChangedException,
LockedException,
LoadingException

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

LoadingException - LOADING

LockedException - LOCKED

ChangedException - CHANGED

Since CICS TS version:

1.3

write

public void write(byte[] key,
 byte[] data)
           throws FileDisabledException,
DuplicateRecordException,
FileNotFoundException,
LogicException,
InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
LengthErrorException,
NoSpaceException,
NotAuthorisedException,
NotOpenException,
InvalidSystemIdException,
ChangedException,
LockedException,
LoadingException

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

LoadingException - LOADING

LockedException - LOCKED

ChangedException - CHANGED

Since CICS TS version:

1.3

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