com.ibm.ims.db.cci

Class DLIInteractionSpec

java.lang.Object

com.ibm.ims.db.cci.InteractionSpecImpl

com.ibm.ims.db.cci.DLIInteractionSpec

All Implemented Interfaces:

java.io.Serializable, javax.resource.cci.InteractionSpec

public class DLIInteractionSpec
extends com.ibm.ims.db.cci.InteractionSpecImpl

Use this class to access data from an IMS database with the IMS Universal Database Resource Adapter using DL/I-like queries. The DLInteractionSpec is used by an Interaction to execute the specified function on an IMS database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREATE
static java.lang.String	DELETE
static java.lang.String	RETRIEVE
static java.lang.String	UPDATE

Fields inherited from interface javax.resource.cci.InteractionSpec

SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Constructor Summary

Constructors

Constructor and Description
DLIInteractionSpec() The default constructor.

Method Summary

Modifier and Type	Method and Description
int	getFetchSize() Retrieves the number of result set rows that is the default fetch size for DLIResultSet objects generated from this interaction.
java.lang.String	getFunctionName() Retrieves the function to be performed in this interaction by name.
int	getFunctionType() Retrieves the function to be performed in this interaction by type.
java.lang.String	getPCBName() Returns the PCB name the interaction will use when executed.
java.lang.String	getSSAList() Returns the segment search argument list the interaction will use when executed.
void	setFetchSize(int rows) Gives the DLI driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
void	setFunctionName(java.lang.String functionName) Sets the function to be performed in this interaction by function name.
void	setPCBName(java.lang.String pcbName) Sets the name of the PCB the interaction will use when executed.
void	setSSAList(java.lang.String ssaList) Sets the segment search argument list to be used with the DL/I query when the interaction is executed.

Methods inherited from class com.ibm.ims.db.cci.InteractionSpecImpl

getExecutionTimeout, getFetchDirection, getInteractionVerb, getMaxFieldSize, getResultSetConcurrency, getResultSetType, setExecutionTimeout, setFetchDirection, setInteractionVerb, setMaxFieldSize, setResultSetConcurrency, setResultSetType

Methods inherited from class java.lang.Object

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

Field Detail

CREATE

public static final java.lang.String CREATE

See Also:

Constant Field Values

RETRIEVE

public static final java.lang.String RETRIEVE

See Also:

Constant Field Values

UPDATE

public static final java.lang.String UPDATE

See Also:

Constant Field Values

DELETE

public static final java.lang.String DELETE

See Also:

Constant Field Values

Constructor Detail

DLIInteractionSpec

public DLIInteractionSpec()

The default constructor.

Method Detail

setSSAList

public void setSSAList(java.lang.String ssaList)

Sets the segment search argument list to be used with the DL/I query when the interaction is executed.

The following code example shows how to set the SSA qualification statement string to return the last patient admitted to all wards with more than five doctors and less than three nurses in hospital "ALEXANDRIA". The command *L means "last occurance".

 String query = "Hospital(HospName=ALEXANDRIA) Ward(Doccount>5 | Nurcount<3) Patient *L";
 iSpec.setSSAList(query);
 

Parameters:

ssaList - a String set with the SSA qualification statement

setPCBName

public void setPCBName(java.lang.String pcbName)

Sets the name of the PCB the interaction will use when executed.

Parameters:

pcbName - the PCB name

getSSAList

public java.lang.String getSSAList()

Returns the segment search argument list the interaction will use when executed.

Returns:

the segment search argument list represented in a String format.

getPCBName

public java.lang.String getPCBName()

Returns the PCB name the interaction will use when executed.

Returns:

the PCB name

getFunctionName

public java.lang.String getFunctionName()

Retrieves the function to be performed in this interaction by name.

Returns:

the function name ("CREATE", "RETREIVE", "UPDATE", or "DELETE") as a String value

setFunctionName

public void setFunctionName(java.lang.String functionName)
                     throws javax.resource.ResourceException

Sets the function to be performed in this interaction by function name.

Parameters:

functionName - Valid values are "CREATE", "RETREIVE", "UPDATE", or "DELETE".

Throws:

javax.resource.ResourceException

getFunctionType

public int getFunctionType()

Retrieves the function to be performed in this interaction by type.

Returns:

the int constant value for the function (FUNC_CREATE, FUNC_RETRIEVE, FUNC_UPDATE, or FUNC_DELETE)

setFetchSize

public void setFetchSize(int rows)

Gives the DLI driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this interaction. If the value specified is zero, then the hint is ignored. The default value is zero.

Overrides:

setFetchSize in class com.ibm.ims.db.cci.InteractionSpecImpl

Parameters:

rows - the number of rows to fetch

getFetchSize

public int getFetchSize()

Retrieves the number of result set rows that is the default fetch size for DLIResultSet objects generated from this interaction.

Overrides:

getFetchSize in class com.ibm.ims.db.cci.InteractionSpecImpl

Returns:

the default fetch size for result sets generated from this interaction.