Package com.softwaremining.vendors.cics
Class CicsBaseService
java.lang.Object
com.softwaremining.logic.BaseService
com.softwaremining.sql.ESQLBaseService
com.softwaremining.vendors.cics.CicsBaseService
- All Implemented Interfaces:
IBaseService
,Service
,SQLHandlerInterface
,IDisplayable
,EIBFNCodes
,ICicsBaseService
,Keyboard
,Runnable
- Direct Known Subclasses:
DliBaseService
public abstract class CicsBaseService
extends ESQLBaseService
implements ICicsBaseService, EIBFNCodes, Keyboard
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final int
int
Fields inherited from class com.softwaremining.sql.ESQLBaseService
staticLogger, totalRuntime
Fields inherited from class com.softwaremining.logic.BaseService
calledParameters, log, PARA_NAME_POSTFIX, profiled_baseService_runtimes, totalRuntime_processControlException, totalRuntime_reflection
Fields inherited from interface com.softwaremining.vendors.cics.constants.EIBFNCodes
DUPREC, EIBFN_CODE_ABEND, EIBFN_CODE_ABEND_INT, EIBFN_CODE_DELETE, EIBFN_CODE_DELETEQ_TD, EIBFN_CODE_DELETEQ_TS, EIBFN_CODE_ENDBR, EIBFN_CODE_LINK, EIBFN_CODE_LOAD, EIBFN_CODE_READ, EIBFN_CODE_READNEXT, EIBFN_CODE_READPREV, EIBFN_CODE_READQ_TD, EIBFN_CODE_READQ_TS, EIBFN_CODE_RECEIVE_MAP, EIBFN_CODE_RESETBR, EIBFN_CODE_RETURN, EIBFN_CODE_REWRITE, EIBFN_CODE_SEND_MAP, EIBFN_CODE_SEND_TEXT, EIBFN_CODE_STARTBR, EIBFN_CODE_UNLOCK, EIBFN_CODE_WRITE, EIBFN_CODE_WRITEQ_TD, EIBFN_CODE_WRITEQ_TS, EIBFN_CODE_XCTL, FILENOTFOUND, NOTOPEN, OK
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
Fields inherited from interface com.softwaremining.vendors.cics.ui.Keyboard
CLEAR, CLRP, ENTER, MSRE, NULL, OPID, PA1, PA2, PA3, PEN, PF1, PF10, PF11, PF12, PF13, PF14, PF15, PF16, PF17, PF18, PF19, PF2, PF20, PF21, PF22, PF23, PF24, PF3, PF4, PF5, PF6, PF7, PF8, PF9, QUIT, STRF, TRIG
Fields inherited from interface com.softwaremining.sql.SQLHandlerInterface
HANDLER_CONTINUE, HANDLER_GO_TO, HANDLER_METHOD_CALL, HANDLER_NOT_INTIALIZED, HANDLER_PERFORM, HANDLER_STOP, HANDLER_THROW, SQL_SCHEMA_PROP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
assignBmsMapSetName
(String mapName, String mapset_FileName) void
assignChannelName
(String channelName) void
assignNetname
(String netName) void
assignProgram
(ISMString programName) Deprecated.void
assignProgram
(String programName) Deprecated.void
assignSessionManager
(SessionManager sessionManager) for internal use onlyvoid
for internal use onlyvoid
void
cicsAddress
(AddressDO addressDO) Set Address of pointers for TWA and CWAvoid
cicsDefineCounter
(CounterDO counterDO) Translation of CICS DEFINE COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.htmlvoid
Deprecated.- this is a stub methodint
cicsDumpTransaction
(DumpTransactionDO dumpTransactionDO) Dumps data in DAO's as well as COMMAREA and TWA to Config.DATA_DIR /dump/timestamp[/dumpCode]void
Deprecated.void
cicsEnterTracenum
(EnterTracenumDO enterTracenumDO) int
cicsGetcounter
(CounterDO counterDO) Translation of CICS GET COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.htmlvoid
Deprecated.- this is a stub methodvoid
cicsInquireFile
(InquireFileDO inquireFileDO) Deprecated.void
cicsInquiretask
(InquireTaskDO inquireTaskDO) Deprecated.int
cicsPostEvent
(PostEventDO postEventDO) Deprecated.- please use com.softwaremining.vendors.cics.util.EventManager.postEventprotected final int
translation of CICS Sync Point Rollbackvoid
cicsSpiinquireFile
(InquireFileDO inquireFileDO) Deprecated.int
This method currently does not perform anythingvoid
cicsSpiinquiretask
(InquireTaskDO inquireTaskDO) Deprecated.final int
protected final int
cicsSyncpoint
(SyncpointDO param) translation of CICS Sync Pointvoid
cicsUnlock
(UnlockDO unlockDO) Deprecated.- this is a stub methodint
cicsWaitEvent
(WaitEventDO waitEventDO) Deprecated.- please use com.softwaremining.vendors.cics.util.EventManager.waitEventvoid
cicsWebExtract
(WebExtractDO webextractDo) void
cicsWebRead
(WebReadDO param) Deprecated.- this is a stub methodvoid
cicsWebReceive
(WebReceiveDO param) Deprecated.- this is a stub methodvoid
cicsWebSend
(WebSendDO param) Deprecated.- this is a stub methodvoid
cicsWebWrite
(WebWriteDO param) Deprecated.- this is a stub methodvoid
commitAndReleaseConnection
(boolean doCommit) for internal use only
- Commits all open transactions (if not already committed)
- closes any CicsPersistence.resultsets in this program which have not been already closed
- releases any connections associated with CicsPersistence.resultsetscreateOrRetrieveContainerListFromChannel
(String channelName) For internal use onlyvoid
void
delay()
CICS Delayvoid
delay
(int seconds) CICS Delayvoid
delay
(ISMNumeric seconds) protected void
destroy()
Close connection all instances of ESQLProcessor Automatically called after exiting a program (normal exit, Go-Back).protected void
Automatically called after fatal errorvoid
doFinalize
(boolean forceRelease, boolean releaseConnection) Automatically called after CANCELing (ServicesFactory.cancel) running a program - it removes all wrapperListsint
When there is No parameters, then the system should pass all the parameters which it had received through the Linkage-Areaint
executeLink
(ISMDataType commAreaField) Translation of CICS Link statement.int
executeLink
(ISMDataType[] commAreaDataObjects) int
executeLink
(ISMDataType commAreaDataObject, double commAreaLength) Translation of CICS Link statement.int
executeLinkUsingChannel
(String channelName) int
Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(boolean invokeHandler) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(ISMDataType commAreaDataObject) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(ISMDataType commAreaDataObject, boolean invokeHandler) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(ISMDataType newCommArea, int commAreaLength) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(ISMDataType newCommArea, int commAreaLength, boolean invokeHandler) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(String newCommArea) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(String newCommArea, int commAreaLength) Translation of CICS Xctl function: transfers control from one application program to another.int
executeTransferControl
(String newCommArea, int commAreaLength, boolean invokeHandler) Translation of CICS Xctl function: transfers control from one application program to another.for internal use onlyCICS uses a 8 Character identifier for program names ...used in CICS ASSIGN ...Deprecated.please use GetInvokingProgramNameint
Deprecated.- please use lengthOfTransactionWorkArea()long
2byte alpha numeric to show how program was started.getSysid()
int
getTally()
int
Deprecated.- please use lengthOfTransactionWorkArea()used in CICS ASSIGN ...void
ignoreCondition
(int conditionNumber) void
ignoreCondition
(int[] conditionNumber) void
in ESQL projects commits are manually made e.g EXEC SQL COMMIT END-EXEC Hence turn the auto-commit off during initializationvoid
void
invokeConditionHandler
(ISMObject responseField, long responseCode, Throwable throwable) handle the condition - when a CICS operation fails, or throw an AbnormalTerminationException code - then control will be passed to this method to determine whether a.boolean
isAbend()
this method is used in passing abend information between CICS LINK callsboolean
boolean
boolean
Indicates whether this the first time this program is being executed, or whether the system is re-entering this program.boolean
isKeyPressed
(String key) check if a key has been prssedboolean
boolean
Only used in conversion of Conversational to Pseudo-Conv Programsint
Returns the length of Transaction Work Area associated with this Session.method used internally by SoftwareMining frameworkprotected void
For internal use onlyvoid
quit()
Commit changes made by all instances of ESQLProcessorvoid
void
reInitializeAllDAOs
(boolean resetDAOInitialValues) reinitializes CBLBeans to their default char-array representation, and AbstractCOntainer to their default values This allows system to reuse the Wrapper classes in other programs.void
for internal use only used by CICS subsystemvoid
resetCondition
(int conditionNumber) for internal use onlyretrieveCicsPersistenceForDataset
(String tableName) Retrieve the active/opened CicsPersistence DAO registered to the SQL tableNamefor internal use onlyjavax.servlet.http.HttpServletRequest
returns the HttpServletRequest received by the Servlet engine.javax.servlet.http.HttpSession
Returns associated HttpSession manager, set by PseudoCOnversationalServletmethod used internally by SoftwareMining frameworkGet the internal SoftwareMining SessionManagervoid
returnFromSession
(String transId) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, ISMBean commArea) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, ISMBean commArea, int commAreaLength) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, ISMBean commArea, String inputMessage, int commAreaLength) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, String commArea) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, String commArea, int commAreaLength) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, String commArea, String inputMessage) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, String commArea, String inputMessage, int commAreaLength) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).protected void
returnFromSession
(String transId, String commArea, String inputMessage, int commAreaLength, String programCode) Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work).void
setAbend
(boolean abend) this method is used in passing abend information between CICS LINK callsvoid
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 Handlersvoid
setKeyPressed
(String key) void
setNeedScreenUpdate
(boolean needScreenUpdate) protected void
setRespCode
(int code, AbstractCBLField respCode) void
setRoutedBMS
(RouteDO routedBMS) void
setTally
(int tally) void
void
setWaitingForUser
(boolean waitingForUser) Only used in conversion of Conversational to Pseudo-Conv Programsprotected void
transfuse
(List<ISMDataType> in, List<ISMDataType> out, boolean back) for internal use onlyMethods inherited from class com.softwaremining.sql.ESQLBaseService
abort, closeESQLProcessors, commit, doFinalize, getESQLProcessors, populateFromLastSQLMessage, populateFromLastSQLMessage, processSQLException, processSQLException, releaseESQLConnections, resetSQLCA, rollback, setErrorHandler, setErrorHandler, setErrorHandlerForward, setNotFoundHandler, setNotFoundHandler, setNotFoundHandlerForward, setSessionSchemaName, setWarningHandler, setWarningHandler
Methods inherited from class com.softwaremining.logic.BaseService
_goto, accept, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addRuntimeParameter, addRuntimeParameter, assignCallerProgram, assignCyclicBarrier, assignInstanceNumber, assignLastKeyPressed, assignLaunchedInstances, assignTargetXMLScreen, assignUsesAnnotationBasedMethodOrdering, awaitBarrier, callJavaMethod, callJavaMethod, chain, clearCallingParameters, countCallParameters, currentDate, disableGUIScreens, doFinalize, enableReuse, execute, execute, execute, execute, execute, execute, execute, executeWithPointerData, executeWithPointerData, getCallerProgram, getDataWrappers, getField, getLastDisplayColumn, getLastDisplayRow, getMethodNumber, getNextPoint, getParagraph, getReportProcessorList, getReturnCode, getScreenClassName, getScreenClient, getServletRunTimeParameterFrom, getSessionId, getWrapperList, getXMLScreenDefReader, goBack, hasReflectionBasedFlowLogic, invoke, invokeRange, isCallerWaiting, isFirstInstance, isGUIScreensEnabled, isTargetXMLScreen, main, objectsAreOfTheSameClass, optimizeUsingTransfuseByReference, popNextRuntimeParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, registerDataWrapper, registerDataWrappers, registerExecuteParameters, reRegisterExecuteParameters, retrieveCalledParameters, retrieveCyclicBarrier, retrieveField, retrieveInstanceNumber, retrieveLastKeyPressed, retrieveLaunchedInstances, retrieveTotalNumberOfInstancesLaunched, run, setCallerWaiting, setCommandLineParameters, setExceptionalExitReturnCode, setHttpRequestParameterMap, setLastDisplayColumn, setLastDisplayRow, setReturnCode, setReturnCode, setReturnCode, setScreenClient, setSessionId, setUsesAnnotationBasedMethodOrdering, startUp, stop, stop, tearDown, transfuseByReference
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, retrieveField, retrieveLastKeyPressed, setLastDisplayColumn, setLastDisplayRow
-
Field Details
-
_RETURN_FROM_SESSION_DEFAULT_LENGTH
protected static final int _RETURN_FROM_SESSION_DEFAULT_LENGTH- See Also:
-
DEFAULT_HANDLER
public int DEFAULT_HANDLER
-
-
Constructor Details
-
CicsBaseService
-
CicsBaseService
public CicsBaseService()Deprecated.Constructor
-
-
Method Details
-
getEibaid
- Specified by:
getEibaid
in interfaceICicsBaseService
-
getDfhaid
-
setAbend
public void setAbend(boolean abend) this method is used in passing abend information between CICS LINK calls- Specified by:
setAbend
in interfaceICicsBaseService
-
isAbend
public boolean isAbend()this method is used in passing abend information between CICS LINK calls- Specified by:
isAbend
in interfaceICicsBaseService
-
abendEnclave
public void abendEnclave() -
quit
public void quit()Description copied from class:ESQLBaseService
Commit changes made by all instances of ESQLProcessor- Overrides:
quit
in classESQLBaseService
-
isCicsAutoSyncPointEnabled
public boolean isCicsAutoSyncPointEnabled()- Overrides:
isCicsAutoSyncPointEnabled
in classBaseService
-
getCicsConditionManager
- Specified by:
getCicsConditionManager
in interfaceICicsBaseService
-
setRespCode
-
setInvokeHelper
Description copied from interface:ICicsBaseService
Invoker handler provides handlers to application program Lanchers, shutdown services and Transaction Handlers- Specified by:
setInvokeHelper
in interfaceICicsBaseService
-
destroy
protected void destroy()Description copied from class:ESQLBaseService
Close connection all instances of ESQLProcessor Automatically called after exiting a program (normal exit, Go-Back). and prepare for GC- Overrides:
destroy
in classESQLBaseService
-
destroyOnFatalError
protected void destroyOnFatalError()Description copied from class:BaseService
Automatically called after fatal error- Overrides:
destroyOnFatalError
in classESQLBaseService
-
executeTransferControl
Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.
This version does not pass any parameters to the targetProgram, hence targetProgram.isFirstTimeExecutionAndNoParameters() will return true- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Throws:
AbnormalTerminationException
-
executeTransferControl
Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.
This method does not pass any parameters to the targetProgram, hence targetProgram.isFirstTimeExecutionAndNoParameters() will return true- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
invokeHandler
- : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(ISMDataType commAreaDataObject) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
commAreaDataObject
- : this data will be passed to target-program as Communication-Area.- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(ISMDataType commAreaDataObject, boolean invokeHandler) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
commAreaDataObject
- : this data will be passed to target-program as Communication-Area.invokeHandler
- : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .- Throws:
AbnormalTerminationException
-
executeTransferControl
Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
newCommArea
- : this data will be passed to target-program as Communication-Area.- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(String newCommArea, int commAreaLength) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
newCommArea
- : this data will be passed to target-program as Communication-Area.commAreaLength
- : newCommArea will be trimmed to this length prior to passing to targetProgram- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(ISMDataType newCommArea, int commAreaLength) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
newCommArea
- - this data will be passed to target-program as Communication-Area.invokeHandler
- : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(ISMDataType newCommArea, int commAreaLength, boolean invokeHandler) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
newCommArea
- - this data will be passed to target-program as Communication-Area.commAreaLength
- : newCommArea will be trimmed to this length prior to passing to targetPrograminvokeHandler
- : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .- Throws:
AbnormalTerminationException
-
executeTransferControl
public int executeTransferControl(String newCommArea, int commAreaLength, boolean invokeHandler) throws AbnormalTerminationException Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.- Specified by:
executeTransferControl
in interfaceICicsBaseService
- Parameters:
newCommArea
- - this data will be passed to target-program as Communication-Area.commAreaLength
- : newCommArea will be trimmed to this length prior to passing to targetPrograminvokeHandler
- : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .- Throws:
AbnormalTerminationException
-
returnFromSession
Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key.. Usually the transId will be the one associated with the current program.- Specified by:
returnFromSession
in interfaceICicsBaseService
- Parameters:
transId
- - transaction Id (referring to a program) to pass to the caller program.- Throws:
ControlException
-
returnFromSession
Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller program- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, ISMBean commArea, int commAreaLength) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programcommAreaLength
- - commArea will be trimmed (or expanded) to this length- Throws:
ControlException
-
returnFromSession
Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller program- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, String commArea, int commAreaLength) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programcommAreaLength
- - commArea will be trimmed (or expanded) to this length- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, ISMBean commArea, String inputMessage, int commAreaLength) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programinputMessage
- - inputMessage passed to sessionManagercommAreaLength
- - commArea will be trimmed (or expanded) to this length- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, String commArea, String inputMessage) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programinputMessage
- - inputMessage passed to sessionManager- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, String commArea, String inputMessage, int commAreaLength) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programinputMessage
- - inputMessage passed to sessionManagercommAreaLength
- - commArea will be trimmed (or expanded) to this length- Throws:
ControlException
-
returnFromSession
protected void returnFromSession(String transId, String commArea, String inputMessage, int commAreaLength, String programCode) throws ControlException Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.- Parameters:
transId
- - transaction Id to pass to the caller programcommArea
- - communication-Area data to pass to the caller programinputMessage
- - inputMessage passed to sessionManagercommAreaLength
- - commArea will be trimmed (or expanded) to this length- Throws:
ControlException
-
executeLink
Translation of CICS Link statement. Calls another program, and at end of its execution it will return control to this program.- Specified by:
executeLink
in interfaceICicsBaseService
- Parameters:
commAreaField
-
-
executeLink
Translation of CICS Link statement. Calls another program, and at end of its execution it will return control to this program.- Specified by:
executeLink
in interfaceICicsBaseService
- Parameters:
commAreaDataObject
- : : this data will be passed to target-program as Communication-Area.commAreaLength
- : length of data in commAreaDataObject will be trimmed to this length prior to passing to targetProgram
-
executeLink
- Specified by:
executeLink
in interfaceICicsBaseService
- Parameters:
commAreaDataObject
- : : the set of data will be passed to target-program as Communication-Area.
-
executeLink
public int executeLink()When there is No parameters, then the system should pass all the parameters which it had received through the Linkage-Area- Specified by:
executeLink
in interfaceICicsBaseService
-
executeLinkUsingChannel
-
cicsSyncpoint
- Specified by:
cicsSyncpoint
in interfaceICicsBaseService
- Throws:
ControlException
-
cicsSyncpoint
translation of CICS Sync Point -
cicsRollbackSyncpoint
protected final int cicsRollbackSyncpoint()translation of CICS Sync Point Rollback -
commitAndReleaseConnection
public void commitAndReleaseConnection(boolean doCommit) for internal use only
- Commits all open transactions (if not already committed)
- closes any CicsPersistence.resultsets in this program which have not been already closed
- releases any connections associated with CicsPersistence.resultsets- Overrides:
commitAndReleaseConnection
in classBaseService
-
doFinalize
public void doFinalize(boolean forceRelease, boolean releaseConnection) Description copied from class:ESQLBaseService
Automatically called after CANCELing (ServicesFactory.cancel) running a program - it removes all wrapperLists- Overrides:
doFinalize
in classESQLBaseService
- Parameters:
forceRelease
-
-
cicsDocumentCreate
Deprecated.- this is a stub method- Specified by:
cicsDocumentCreate
in interfaceICicsBaseService
-
cicsWebWrite
Deprecated.- this is a stub method- Specified by:
cicsWebWrite
in interfaceICicsBaseService
-
cicsWebRead
Deprecated.- this is a stub method- Specified by:
cicsWebRead
in interfaceICicsBaseService
-
cicsWebReceive
Deprecated.- this is a stub method- Specified by:
cicsWebReceive
in interfaceICicsBaseService
-
cicsWebSend
Deprecated.- this is a stub method- Specified by:
cicsWebSend
in interfaceICicsBaseService
-
cicsHandleAbend
Deprecated.- this is a stub method- Specified by:
cicsHandleAbend
in interfaceICicsBaseService
-
setAbendHandler
- Specified by:
setAbendHandler
in interfaceICicsBaseService
-
setAbendHandler
- Specified by:
setAbendHandler
in interfaceICicsBaseService
-
cancelAbendHandler
public void cancelAbendHandler()- Specified by:
cancelAbendHandler
in interfaceICicsBaseService
-
resetCondition
public void resetCondition(int conditionNumber) -
ignoreCondition
public void ignoreCondition(int conditionNumber) - Specified by:
ignoreCondition
in interfaceICicsBaseService
-
ignoreCondition
public void ignoreCondition(int[] conditionNumber) - Specified by:
ignoreCondition
in interfaceICicsBaseService
-
setAidEventHandler
- Specified by:
setAidEventHandler
in interfaceICicsBaseService
-
isAidEventManagerActive
public boolean isAidEventManagerActive() -
invokeAidEventHandler
public void invokeAidEventHandler() -
invokeConditionHandler
handle the condition - when a CICS operation fails, or throw an AbnormalTerminationException code - then control will be passed to this method to determine whether a. We use default CICS condition handler b. We Ignore condition c. We pass control (via goto) to a named condition handler -
cicsUnlock
Deprecated.- this is a stub methodNot applicable in java- Specified by:
cicsUnlock
in interfaceICicsBaseService
-
getClassName
used in CICS ASSIGN ... PROGRAM(prog-name)- Specified by:
getClassName
in interfaceICicsBaseService
- Returns:
- return the upper-cased, package-removed class name E.g. it will return CICSPROGRAM1 for class com.softwaremining.examples.CicsProgram1
-
getUserId
used in CICS ASSIGN ... PROGRAM(prog-name)- Specified by:
getUserId
in interfaceICicsBaseService
- Returns:
- return the upper-cased, package-removed class name E.g. it will return CICSPROGRAM1 for class com.softwaremining.examples.CicsProgram1
-
setUserId
- Specified by:
setUserId
in interfaceICicsBaseService
-
getInvokingProgramName
- Specified by:
getInvokingProgramName
in interfaceICicsBaseService
-
getInvokingProgram
Deprecated.please use GetInvokingProgramName- Specified by:
getInvokingProgram
in interfaceICicsBaseService
- Returns:
-
getReturnprog
-
assignChannelName
-
getChannel
-
assignNetname
-
getNetname
-
getAbendCode
- Specified by:
getAbendCode
in interfaceICicsBaseService
-
getProgramId
- Specified by:
getProgramId
in interfaceICicsBaseService
-
getProgramName
- Specified by:
getProgramName
in interfaceICicsBaseService
-
getStartcode
2byte alpha numeric to show how program was started. values are:
QD - transient data ATI
S - Interval control start command without data
SD - Interval control start command with data
TD - Terminal Input
U - other task attached by user
- Specified by:
getStartcode
in interfaceICicsBaseService
- Returns:
-
getSysid
- Specified by:
getSysid
in interfaceICicsBaseService
-
getApplid
- Specified by:
getApplid
in interfaceICicsBaseService
-
transfuse
for internal use only- Overrides:
transfuse
in classBaseService
-
setAcceptResponse
- Specified by:
setAcceptResponse
in interfaceICicsBaseService
-
getAcceptResponse
Description copied from interface:ICicsBaseService
for internal use only- Specified by:
getAcceptResponse
in interfaceICicsBaseService
- Returns:
-
setNeedScreenUpdate
public void setNeedScreenUpdate(boolean needScreenUpdate) -
isNeedScreenUpdate
public boolean isNeedScreenUpdate() -
getCicsOriginalProgramName
CICS uses a 8 Character identifier for program names ... Ie programName PROGRAM1 will result in com.mypackage.Program1 . This method will keep the original name assigned (e.g. PROGRAM1);- Specified by:
getCicsOriginalProgramName
in interfaceICicsBaseService
-
retrieveSessionManager
Get the internal SoftwareMining SessionManager- Specified by:
retrieveSessionManager
in interfaceICicsBaseService
-
assignSessionManager
for internal use only -
retrieveHttpSession
public javax.servlet.http.HttpSession retrieveHttpSession()Returns associated HttpSession manager, set by PseudoCOnversationalServlet -
retrieveHttpServletRequest
public javax.servlet.http.HttpServletRequest retrieveHttpServletRequest()returns the HttpServletRequest received by the Servlet engine.
Access to this variable allows the application logic to directly query the request for other INPUT fields assigned in HTML - the ones which do not map to original BMS screens.- Returns:
-
isFirstTimeExecutionAndNoParameters
public boolean isFirstTimeExecutionAndNoParameters()Indicates whether this the first time this program is being executed, or whether the system is re-entering this program.- Specified by:
isFirstTimeExecutionAndNoParameters
in interfaceICicsBaseService
- Returns:
-
IsWaitingForUI
public boolean IsWaitingForUI()Only used in conversion of Conversational to Pseudo-Conv Programs- Returns:
-
setWaitingForUser
public void setWaitingForUser(boolean waitingForUser) Only used in conversion of Conversational to Pseudo-Conv Programs- Specified by:
setWaitingForUser
in interfaceICicsBaseService
- Parameters:
waitingForUser
-
-
isKeyPressed
check if a key has been prssed- Specified by:
isKeyPressed
in interfaceICicsBaseService
- Parameters:
key
- : one of entries in "com.softwaremining.vendors.cics.Keyboard" interface- Returns:
-
setKeyPressed
- Specified by:
setKeyPressed
in interfaceICicsBaseService
-
getKeyPressed
- Specified by:
getKeyPressed
in interfaceICicsBaseService
-
getResponseCode
public long getResponseCode()- Specified by:
getResponseCode
in interfaceICicsBaseService
-
makeUpClassScreenSourceName
method used internally by SoftwareMining framework- Specified by:
makeUpClassScreenSourceName
in interfaceIDisplayable
- Overrides:
makeUpClassScreenSourceName
in classBaseService
- Returns:
- - a string representing the XML screen file for program. For example, for class com.softwaremining.examples.Loan, the following string will be returned: /com/softwaremining/examples/loan/xml/screens/Loan.xml
-
assignBmsMapSetName
-
retrieveBmsMapSet_FileName
for internal use only- Returns:
-
retrieveJSPName
method used internally by SoftwareMining framework- Returns:
-
retrieveDBDecorator
-
reInitializeBaseService
public void reInitializeBaseService()Description copied from class:BaseService
for internal use only used by CICS subsystem- Overrides:
reInitializeBaseService
in classBaseService
-
reInitializeAllDAOs
public void reInitializeAllDAOs(boolean resetDAOInitialValues) Description copied from class:BaseService
reinitializes CBLBeans to their default char-array representation, and AbstractCOntainer to their default values This allows system to reuse the Wrapper classes in other programs. This is only used in Cics applications . NOTES: A goBack() and end of the execution will clear all DAO's passed via AddCallParameters (Linkage-Section).- Overrides:
reInitializeAllDAOs
in classBaseService
-
initializeBaseService
public void initializeBaseService()Description copied from class:ESQLBaseService
in ESQL projects commits are manually made e.g EXEC SQL COMMIT END-EXEC Hence turn the auto-commit off during initialization- Overrides:
initializeBaseService
in classESQLBaseService
-
delay
public void delay()CICS Delay- Specified by:
delay
in interfaceICicsBaseService
- Parameters:
seconds
-
-
delay
public void delay(int seconds) CICS Delay- Specified by:
delay
in interfaceICicsBaseService
- Parameters:
seconds
-
-
delay
- Specified by:
delay
in interfaceICicsBaseService
-
getRoutedBMS
- Specified by:
getRoutedBMS
in interfaceICicsBaseService
-
setRoutedBMS
- Specified by:
setRoutedBMS
in interfaceICicsBaseService
-
cicsEnq
Deprecated.CICS ENQ - cannot reserve any resources in web-application ...- Specified by:
cicsEnq
in interfaceICicsBaseService
- Parameters:
enqDO
-
-
cicsGetcounter
Translation of CICS GET COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html- Specified by:
cicsGetcounter
in interfaceICicsBaseService
- Parameters:
counterDO
-
-
cicsDefineCounter
Translation of CICS DEFINE COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html- Specified by:
cicsDefineCounter
in interfaceICicsBaseService
- Parameters:
counterDO
-
-
cicsSpiinquiretask
Deprecated.- Specified by:
cicsSpiinquiretask
in interfaceICicsBaseService
-
cicsSpiinquireFile
Deprecated.- Specified by:
cicsSpiinquireFile
in interfaceICicsBaseService
-
cicsInquireFile
Deprecated.- Specified by:
cicsInquireFile
in interfaceICicsBaseService
-
cicsInquiretask
Deprecated.- Specified by:
cicsInquiretask
in interfaceICicsBaseService
-
assignProgram
Deprecated. -
assignProgram
Deprecated. -
assignThreadManagerDAO
for internal use only- Parameters:
data
-
-
retrieveDataManagerStr
for internal use only- Returns:
-
retrieveStartCode
-
cicsWebExtract
- Specified by:
cicsWebExtract
in interfaceICicsBaseService
-
retrieveCicsPersistenceForDataset
Retrieve the active/opened CicsPersistence DAO registered to the SQL tableName- Parameters:
tableName
-- Returns:
-
cicsDumpTransaction
Dumps data in DAO's as well as COMMAREA and TWA to Config.DATA_DIR /dump/timestamp[/dumpCode]- Specified by:
cicsDumpTransaction
in interfaceICicsBaseService
- Parameters:
dumpTransactionDO
-- Returns:
-
cicsEnterTracenum
- Specified by:
cicsEnterTracenum
in interfaceICicsBaseService
-
cicsAddress
Set Address of pointers for TWA and CWA- Specified by:
cicsAddress
in interfaceICicsBaseService
- Parameters:
addressDO
-
-
getTwaleng
Deprecated.- please use lengthOfTransactionWorkArea()- Returns:
-
getLengthOfTransactionWorkArea
Deprecated.- please use lengthOfTransactionWorkArea()- Returns:
-
lengthOfTransactionWorkArea
public int lengthOfTransactionWorkArea()Returns the length of Transaction Work Area associated with this Session. if no TWA exists, a zero length is returned.- Specified by:
lengthOfTransactionWorkArea
in interfaceICicsBaseService
- Returns:
-
cicsSpiInquireSystem
This method currently does not perform anything- Specified by:
cicsSpiInquireSystem
in interfaceICicsBaseService
-
cicsPostEvent
Deprecated.- please use com.softwaremining.vendors.cics.util.EventManager.postEvent -
cicsWaitEvent
Deprecated.- please use com.softwaremining.vendors.cics.util.EventManager.waitEvent -
reactivateHandlers
public void reactivateHandlers()- Specified by:
reactivateHandlers
in interfaceICicsBaseService
-
deactivateHandlers
public void deactivateHandlers()- Specified by:
deactivateHandlers
in interfaceICicsBaseService
-
setTally
public void setTally(int tally) - Specified by:
setTally
in interfaceICicsBaseService
-
getTally
public int getTally()- Specified by:
getTally
in interfaceICicsBaseService
-
getFieldTally
- Specified by:
getFieldTally
in interfaceICicsBaseService
-
getChannelList
-
createOrRetrieveContainerListFromChannel
For internal use only- Parameters:
channelName
-- Returns:
-
processCicsAbendException
Description copied from class:BaseService
For internal use only- Overrides:
processCicsAbendException
in classBaseService
- Parameters:
e
-
-