Class MFECIInteractionSpec

An implementation class that holds properties for driving an Interaction with an EIS instance. Because this class is a Java Bean, it supports bound properties.
java.lang.Object

extended by com.microfocus.cics.connector.cci.MFECIInteractionSpec

All Implemented Interfaces

javax.resource.cci.InteractionSpec, Serializable

Class Specifications

public class MFECIInteractionSpec

extends Object

implements javax.resource.cci.InteractionSpec, Serializable

See Also:

Serialized Form

Fields

Field Summary
static int CALLER_PRINCIPAL
static int UNINITIALIZED
static int USE_USERPWD
Fields inherited from interface javax.resource.cci.javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Constructor Summary

MFECIInteractionSpec()
Create a MFECIInteractionSpec instance.

Methods

Method Summary
void addPropertyChangeListener(PropertyChangeListener l)

Add a property change listener.

AbendCodeType getAbendCodeType()
Object getArgument(int index)

Get an argument.

int getArgumentCount()

Get argument count.

int getAuthenticationMechanism()

Get authentication mechanism.

Principal getCallerPrincipal()
CCLChannel getCCLChannel()
CommArea getCommArea()
int getExciResp1()
int getExciResp2()
int getExecutionTimeout()

Get Execution timeout.

CCLExtendMode getExtendMode()

Get the extend mode.

String getFunctionName()

Get the function name to be executed.

javax.resource.cci.IndexedRecord getInputRecord()
int getInteractionVerb()

Get the interaction verb.

int getLUWToken()
MFECIInteractionSpecMetaData getMetaData()

Get MFECIInteractionSpecMetaData.

String getPassword()

Get password.

String getProgramName()

Get the name of the function to be executed.

CCLChannel getReturnChannel()
int getReturnCode()

Get return code.

CommArea getReturnCommArea()
String getSysID()
String getSysName()
String getTransactionId()
int getUsage(int index)

Get a usage.

String getUserName()

Get user name.

void removePropertyChangeListener(PropertyChangeListener 1)

Remove a property change listener.

void setAbendCode(String abendCode)
void setAbendCodeType(AbendCodeType abendCodeType)
void setArgument(int index, int usage)

Set an argument to be held in an interaction spec.

void setArgument(int index, Object obj)

Set an argument to be held in an interaction spec.

void setArgument(int index, Object obj, int usage)

Set an argument to be held in an interaction spec.

void setArgumentCount(int argumentCount)

Set the argument count.

void setAuthenticationMechanism(int am)

Set the authentication mechanism.

void setCallerPrincipal(Principal principal)

Set caller principal.

void setChannel(CCIChannel channel)
void setCommArea(CommArea ca)
void setExciResp1(int exciResp1)
void setExciResp2(int exciResp2)
void setExtendMode(CCLExtendMode extendMode )

Set the extend mode.

void setFunctionName(int luwToken)

Set the name of the function to be executed.

void setLUWToken(String functionName)
void setPassword(String password)

Set password.

void setProgramName(String programName)

Set the name of the program to be executed.

setReturnChannel(CCLChannel returnChannel)
void setReturnCode(int returnCode)

Set return code.

void setReturnCommArea(CommArea returnCommArea )
void setStatefulInteraction(boolean statefulInteraction )
void setSysId(String sysId)
void setSysName(String sysName)
void setTransactionId(String transactionId)
void setUserName(String userName)

Set user name.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USE_USERPWD 
public static final int USE_USERPWD

See Also:

Constant Field Values

UNINITIALIZED 
public static final int UNINITIALIZED

See Also:

Constant Field Values

CALLER_PRINCIPAL 
public static final int CALLER_PRINCIPAL

See Also:

Constant Field Values

Constructor Detail

MFECIInteractionSpec 
public MFECIInteractionSpec()

Construct a new MFECIInteractionSpec instance.

Method Detail

getProgramName 
public String getProgramName()

Get the name of the program to be executed.

Returns:
The program name.
setProgramName 
public void setProgramName(String programName)

Set the name of the program to be executed.

Parameters:
programName The program name.
getInteractionVerb 
public int getInteractionVerb()

Get the interaction verb.

Returns:
The interaction verb. Only SYNC_SEND_RECEIVE is supported.
getExecutionTimeout 
public int getExecutionTimeout()

Get the execution timeout.

Returns:
The execution timeout.
setReturnCode 
public void setReturnCode(int returnCode)

Set the return code.

Parameters:
returnCode The return code from Cobol Server.
getReturnCode 
public int getReturnCode()

Get the return code.

Returns:
The return code from Cobol Server.
setArgument 
public void setArgument(int index,
                        int usage)

Set an argument to be held in an interaction spec.

Parameters:
index The argument index.
usage The usage for the argument.
setArgument 
public void setArgument(int index,
                        Object obj)

Set an argument to be held in an interaction spec.

Parameters:
index The argument index.
obj The actual object.
setArgument 
public void setArgument(int, index
                        Object obj,
                        int usage)

Set an argument to be held in an interaction spec.

Parameters:
index The argument index.
obj The actual object.
usage The usage for the argument.
getArgument 
public Object getArgument(int index)

Get an argument.

Parameters:
index The argument index.
Returns:
The actual argument.
getUsage 
public int getUsage(int, index)

Get a usage.

Parameters:
index The argument index.
Returns:
The usage.
getArgumentCount 
public int getArgumentCount()

Get the argument count.

Returns:
The argument count.
setArgumentCount 
public void setArgumentCount(int argumentCount)

Set the argument count.

Parameters:
argumentCount The argument count.
setUserName 
public void setUserName(String userName)

Set the user name.

Parameters:
userName The user name.
setPassword 
public void setPassword(String password)

Set the password.

Parameters:
password The password.
getUserName 
public String getUserName()

Get the user name.

Returns:
The user name.
getPassword 
public String getPassword()

Get the password.

Returns:
The password.
getAuthenticationMechanism 
public int getAuthenticationMechanism()

Get the authentication mechanism.

Returns:
The authentication mechanism. Possible values are UNINITIALIZED USE_USERPWD.
setAuthenticationMechanism 
public void setAuthenticationMechanism(int am)

Set the authentication mechanism.

Parameters:
am The authentication mechanism. UNINITIALIZED USE_USERPWD CALLER_PRINCIPAL
addPropertyChangeListener 
public void addPropertyChangeListener(PropertyChangeListener 1)

Add a property change listener.

Parameters:
1 The listener instance.
removePropertyChangeListener 
public void removePropertyChangeListener(PropertyChangeListener 1)

Remove a property change listener.

Parameters:
1 The listener instance.
getMetaData 
public MFECIInteractionSpecMetaData getMetaData()

Get MFECIInteractionSpecMetaData.

Returns:
MFECIInteractionSpecMetaData instance.
setCallerPrincipal 
public void setCallerPrincipal(Principal principal)

Set caller principal.

Parameters:
principal The caller principal.
getCallerPrincipal 
public void getCallerPrincipal(Principal principal)

Get caller principal.

Parameters:
principal The caller principal.
getCCLChannel 
public CCLChannel getCCLChannel()
getExtendMode 
public CCLExtendMode getExtendMode()

Get the extend mode.

Returns:
The extend mode.
setExtendMode 
public void setExtendMode(CCLExtendMode extendMode)

Set the extend mode.

Parameters:
extendMode The extend mode.
setCommArea 
public void setCommArea(CommArea ca)
getCommArea 
public CommArea getCommArea()
setChannel 
public void setChannel(CCLChannel channel)
getCCLChannel 
public CCLChannel getCCLChannel()
getFunctionName 
public String getFunctionName()
setFunctionName 
public void setFunctionName(String functionName)
getTransactionId 
public String getTransactionId
setTransactionId 
public void setTransactionId(String transactionId)
getSysId 
public String getSysId
setSysId 
public void setSysId(String sysId)
getSysName 
public String getSysName
setSysName 
public void setSysName(String sysName)
getLuwToken 
public int getLuwToken()
setLuwToken 
public void setLuwToken(int luwToken)
setStatefulInteraction 
public void setStatefulInteraction(boolean statefulInteraction)
getInputRecord 
public javax.resource.cci.IndexedRecord getInputRecord()
                                 throws UnsupportedEncodingException
Throws:
UnsupportedEncodingException
getExciResp1 
public int getExciResp1()
setExciResp1 
public void setExciResp1(int exciResp1)
getExciResp2 
public int getExciResp2()
setExciResp2 
public void setExciResp2(int exciResp2)
getAbendCode 
public String getAbendCode
getAbendCodeType 
public AbendCodeType getAbendCodeType()
setAbendCode 
public void setAbendCode(String abendCode)
setAbendCodeType 
public void setAbendCodeType(AbendCodeType abendCodeType)
getReturnCommArea 
public CommArea getReturnCommArea()
setReturnCommArea 
public void setReturnCommArea(CommArea returnCommArea)
getReturnChannel 
public CCLChannel getReturnChannel()
setReturnChannel 
public void setReturnChannel(CCLChannel returnChannel)
Parent topic: Package com.microfocus.cics.connector.cci