Class CCLParams

Class to set parameters for a request.
java.lang.Object

extended bycom.microfocus.cics.client.CCLParams

Class Specifications

public class CCLParams

extends Object

Constructor Summary

CCLParams()

Construct a CCLParams object.

CCLParams(CCLParams that)

Construct a CCLParams object.

CCLParams(CCLParams that), CCLExtendMode newExtendMode

Construct a CCLParams object.

Methods

Method Summary
CCLCallType getCallType( name)

Get the CallType

CommArea getCommArea()

Get the CommArea

short getCommAreaLength()

Get CommArea length

CCLExtendMode getExtendMode()

get the ExtendMode

String getPassword()

Get the password

String getProgramName()

Get the program name

String getTransactionId()

Get the transaction ID

String getUserId()

Get the user ID

CCLVersion getVersion()

Get the version

void setCallType(CCLCallType callType)

Set the CallType

void setCommArea(CommArea commArea)

Set the commArea

void setExtendMode(CCLExtendMode extendMode)

Set the ExtendMode

void setPassword(String password)

Set the password

void setProgramName(String programName)

Set the program name

void setTransactionId(String transactionId)

Set the transaction ID

void setUserId(String userId)

Set the user ID

void setVersion(CCLVersion version)

Set the version

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

Constructor Detail

CCLParams
public CCLParams()

Construct a CCLParams object. All Strings have a default value of "".

CCLParams
public CCLParams(CCLParams that)

Construct a CCLParams object.

CCLParams
public CCLParams(CCLParams that), 
         CCLExtendMode newExtendMode

Construct a CCLParams object.

Method Detail

getCallType
public CCLCallType getCallType()

Get the CallType

Returns:
callType
See Also:
CCLExtendMode
getCommArea
public CommArea getCommArea()

Get the CommArea

Returns:
commArea
See Also:
CommArea
getCommAreaLength
public short getCommAreaLength()

Get CommArea length

Returns:
The length of the CommArea
See Also:
CommArea
getExtendMode
public CCLExtendMode getExtendMode()

Get the ExtendMode

Returns:
extendMode
See Also:
CCLExtendMode
getPassword
public String getPassword()
Returns:
password
getProgramName
public String getProgramName()

Get the program name

Returns:
programName
getTransactionId
public String getTransactionId()

Get the transaction ID

Returns:
transactionID
getUserId
public String getUserId()

Get the user ID

Returns:
userId
getVersion
public CCLVersion getUserId()

Get the version

Returns:
The version
See Also:
CCLVersion
setCallType
public void setCallType(CCLCallType callType)

Set the CallType

Parameters:
callType
Returns:
callType
See Also:
CCLCallType
setCommArea
public void setCommArea(CommArea commArea)

Set the CommArea

Returns:
callType
See Also:
CommArea
setExtendMode
public void setExtendMode(CCLExtendMode extendMode)

Set the ExtendMode

Returns:
extendMode
See Also:
CCLExtendMode
setPassword
public void setPassword(String password)

Set the password. password cannot be more than eight bytes in length. If it is more than eight bytes in length, it is truncated to the first eight bytes.

Parameters:
password
setProgramName
public void setProgramName(String programName)

Set the ProgramName. ProgramName cannot be more than eight bytes in length. If it is more than eight bytes in length, it is truncated to the first eight bytes.

Parameters:
programName
setTransactionId
public void setTransactionId(String transactionId)

Set the Transaction Id. Transaction Id cannot be more than four bytes in length. If it is more than four bytes in length, it is truncated to the first four bytes.

Parameters:
transactionId
setUserId
public void setTransactionId(String userId)

Set the userId. userId cannot be more than eight bytes in length. If it is more than eight bytes in length, it is truncated to the first eight bytes.

Parameters:
userId
setVersion
public void setVersion(CCLVersion version)

Set the version

Parameters:
version
Returns:
The version
See Also:
CCLVersion