Package com.softwaremining.cics

Interface ICicsBaseService

All Superinterfaces:

IBaseService, IDisplayable

All Known Implementing Classes:

CicsBaseService, DcAppLauncherService, DliBaseService

public interface ICicsBaseService
extends IBaseService

Field Summary

Fields inherited from interface com.softwaremining.ui.IDisplayable

_FKEY_INPUT, _INVALIDATE, FKEY_1, FKEY_10, FKEY_11, FKEY_12, FKEY_2, FKEY_3, FKEY_4, FKEY_5, FKEY_6, FKEY_7, FKEY_8, FKEY_9

Method Summary

Modifier and Type	Method	Description
void	cancelAbendHandler()
void	cicsAddress(AddressDO addressDO)
void	cicsDefineCounter(CounterDO counterDO)
void	cicsDeq(DeqDO deqDO)
void	cicsDocumentCreate(DocumentCreateDO param)
int	cicsDumpTransaction(DumpTransactionDO dumpTransactionDO)
void	cicsEnq(EnqDO enqDO)
void	cicsEnterTracenum(EnterTracenumDO enterTracenumDO)
int	cicsGetcounter(CounterDO counterDO)
void	cicsHandleAbend(HandleAbendDO obj)
void	cicsSpiInquireTask(InquireTaskDO inquireTaskDO)
int	cicsSyncpoint()
void	cicsUnlock(UnlockDO unlockDO)
void	cicsWebExtract(WebExtractDO webextractDo)
void	cicsWebRead(WebReadDO param)
void	cicsWebReceive(WebReceiveDO param)
void	cicsWebSend(WebSendDO param)
void	cicsWebWrite(WebWriteDO param)
void	deactivateHandlers()
void	delay()
void	delay(int seconds)
void	delay(ISMNumeric seconds)
int	executeLink()
int	executeLink(ISMDataType commAreaField)
int	executeLink(ISMDataType[] commAreaDataObjects)
int	executeLink(ISMDataType commAreaDataObject, double commAreaLength)
int	executeTransferControl()
int	executeTransferControl(boolean invokeHandler)
int	executeTransferControl(ISMDataType commAreaDataObject)
int	executeTransferControl(ISMDataType commAreaDataObject, boolean invokeHandler)
int	executeTransferControl(ISMDataType newCommArea, int commAreaLength)
int	executeTransferControl(ISMDataType newCommArea, int commAreaLength, boolean invokeHandler)
int	executeTransferControl(String newCommArea)
int	executeTransferControl(String newCommArea, int commAreaLength)
int	executeTransferControl(String newCommArea, int commAreaLength, boolean invokeHandler)
String	getAbendCode()
AcceptResponse	getAcceptResponse()	for internal use only
String	getApplid()
CicsConditionManager	getCicsConditionManager()
String	getCicsOriginalProgramName()
String	getClassName()
Eibaid	getEibaid()
ISMObject	getFieldTally()
String	getInvokingProgram()
String	getInvokingProgramName()
String	getKeyPressed()
String	getProgramId()
String	getProgramName()
long	getResponseCode()
RouteDO	getRoutedBMS()
String	getStartcode()
String	getSysid()
int	getTally()
String	getTerminalID()
String	getUserId()	used in CICS ASSIGN ...
void	ignoreCondition(int conditionNumber)
void	ignoreCondition(int[] conditionNumber)
boolean	isFirstTimeExecutionAndNoParameters()
boolean	isKeyPressed(String key)
int	lengthOfTransactionWorkArea()
void	processCicsAbendException(Exception e)
void	reactivateHandlers()
SessionManager	retrieveSessionManager()
String	retrieveStartCode()
TaskContext	retrieveTaskContext()
void	returnFromSession(String transId)
void	setAbendHandler(int defaultHandler, String methodName)
void	setAbendHandler(String methodName)
void	setAcceptResponse(AcceptResponse acceptResponse)
void	setAidEventHandler(String keyCode, String methodName)
void	setInvokeHelper(InvokeHelper invokeHelper)	Invoker handler provides handlers to application program Lanchers, shutdown services and Transaction Handlers
void	setKeyPressed(String key)
void	setRoutedBMS(RouteDO routedBMS)
void	setTally(int tally)
void	setUserId(String userId)
void	setWaitingForUser(boolean waitingForUser)

Methods inherited from interface com.softwaremining.logic.IBaseService

_goto, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, execute, execute, execute, execute, execute, execute, execute, getReturnCode, getSessionId, goBack, invoke, invokeRange, populateFromLastSQLMessage, populateFromLastSQLMessage, setReturnCode, setSessionId, stop

Methods inherited from interface com.softwaremining.ui.IDisplayable

assignLastKeyPressed, assignTargetXMLScreen, disableGUIScreens, getField, getLastDisplayColumn, getLastDisplayRow, getScreenClassName, getScreenClient, getXMLScreenDefReader, isGUIScreensEnabled, isTargetXMLScreen, makeUpClassScreenSourceName, retrieveField, retrieveLastKeyPressed, setLastDisplayColumn, setLastDisplayRow

Method Details

setInvokeHelper

void setInvokeHelper(InvokeHelper invokeHelper)

Invoker handler provides handlers to application program Lanchers, shutdown services and Transaction Handlers

getUserId

String getUserId()

used in CICS ASSIGN ... PROGRAM(prog-name)

Returns:

return the upper-cased, package-removed class name E.g. it will return CICSPROGRAM1 for class com.softwaremining.examples.CicsProgram1

getEibaid

Eibaid getEibaid()

returnFromSession

void returnFromSession(String transId)
                throws ControlException

Throws:

ControlException

getAcceptResponse

AcceptResponse getAcceptResponse()

for internal use only

Returns:

retrieveSessionManager

SessionManager retrieveSessionManager()

setTally

void setTally(int tally)

getTally

int getTally()

getFieldTally

ISMObject getFieldTally()

retrieveTaskContext

TaskContext retrieveTaskContext()

isFirstTimeExecutionAndNoParameters

boolean isFirstTimeExecutionAndNoParameters()

isKeyPressed

boolean isKeyPressed(String key)

getCicsConditionManager

CicsConditionManager getCicsConditionManager()

cicsSyncpoint

int cicsSyncpoint()
           throws ControlException

Throws:

ControlException

executeLink

int executeLink()

executeLink

int executeLink(ISMDataType commAreaDataObject,
 double commAreaLength)

executeLink

int executeLink(ISMDataType commAreaField)

executeLink

int executeLink(ISMDataType[] commAreaDataObjects)

executeTransferControl

int executeTransferControl()

executeTransferControl

int executeTransferControl(ISMDataType commAreaDataObject)

executeTransferControl

int executeTransferControl(ISMDataType commAreaDataObject,
 boolean invokeHandler)

executeTransferControl

int executeTransferControl(ISMDataType newCommArea,
 int commAreaLength,
 boolean invokeHandler)

executeTransferControl

int executeTransferControl(ISMDataType newCommArea,
 int commAreaLength)

executeTransferControl

int executeTransferControl(boolean invokeHandler)

executeTransferControl

int executeTransferControl(String newCommArea)

executeTransferControl

int executeTransferControl(String newCommArea,
 int commAreaLength)

executeTransferControl

int executeTransferControl(String newCommArea,
 int commAreaLength,
 boolean invokeHandler)
                    throws AbnormalTerminationException

Throws:

AbnormalTerminationException

lengthOfTransactionWorkArea

int lengthOfTransactionWorkArea()

getResponseCode

long getResponseCode()

getRoutedBMS

RouteDO getRoutedBMS()

getAbendCode

String getAbendCode()

getApplid

String getApplid()

getCicsOriginalProgramName

String getCicsOriginalProgramName()

getClassName

String getClassName()

getInvokingProgram

String getInvokingProgram()

getInvokingProgramName

String getInvokingProgramName()

getKeyPressed

String getKeyPressed()

getProgramId

String getProgramId()

getProgramName

String getProgramName()

getStartcode

String getStartcode()

getSysid

String getSysid()

cancelAbendHandler

void cancelAbendHandler()

deactivateHandlers

void deactivateHandlers()

delay

void delay()

delay

void delay(int seconds)

delay

void delay(ISMNumeric seconds)

ignoreCondition

void ignoreCondition(int conditionNumber)

ignoreCondition

void ignoreCondition(int[] conditionNumber)

reactivateHandlers

void reactivateHandlers()

setAbendHandler

void setAbendHandler(int defaultHandler,
 String methodName)

setAbendHandler

void setAbendHandler(String methodName)

setAcceptResponse

void setAcceptResponse(AcceptResponse acceptResponse)

setAidEventHandler

void setAidEventHandler(String keyCode,
 String methodName)

setKeyPressed

void setKeyPressed(String key)

setRoutedBMS

void setRoutedBMS(RouteDO routedBMS)

setUserId

void setUserId(String userId)

setWaitingForUser

void setWaitingForUser(boolean waitingForUser)

cicsAddress

void cicsAddress(AddressDO addressDO)

cicsDefineCounter

void cicsDefineCounter(CounterDO counterDO)

cicsDocumentCreate

void cicsDocumentCreate(DocumentCreateDO param)

cicsEnq

void cicsEnq(EnqDO enqDO)

cicsDeq

void cicsDeq(DeqDO deqDO)

cicsEnterTracenum

void cicsEnterTracenum(EnterTracenumDO enterTracenumDO)

cicsGetcounter

int cicsGetcounter(CounterDO counterDO)

cicsHandleAbend

void cicsHandleAbend(HandleAbendDO obj)

cicsSpiInquireTask

void cicsSpiInquireTask(InquireTaskDO inquireTaskDO)

cicsDumpTransaction

int cicsDumpTransaction(DumpTransactionDO dumpTransactionDO)

cicsWebExtract

void cicsWebExtract(WebExtractDO webextractDo)

cicsWebRead

void cicsWebRead(WebReadDO param)

cicsWebReceive

void cicsWebReceive(WebReceiveDO param)

cicsWebSend

void cicsWebSend(WebSendDO param)

cicsWebWrite

void cicsWebWrite(WebWriteDO param)

cicsUnlock

void cicsUnlock(UnlockDO unlockDO)

getTerminalID

String getTerminalID()

retrieveStartCode

String retrieveStartCode()

processCicsAbendException

void processCicsAbendException(Exception e)