Package com.softwaremining.wrappers

Interface ISMBean

All Known Subinterfaces:

ISQLWrapper

All Known Implementing Classes:

AbstractBasePersistence, AbstractCommunicationSection, AbstractContainerBean, AbstractCSVFile, AbstractFile, AbstractIndexedFile, AbstractORContainer, AbstractSequentialFile, AbstractSequentialMappedFile, AbstractSortBean, AbstractSSABean, BMSScreenBean, BMSScreenInputBean, BMSScreenOutputBean, CachedIndexedFile, CachedSQLWrapper, CAIdealWrapper, CBLBean, CicsIndexedFile, CicsPersistence, CicsSequential, CommonWorkArea, Db400, Db400Container, Db400Sequential, DBMSWrapper, Dfhaid, DfhMessageTable, Eibaid, IDS2Wrapper, ILEReport, ILEScreen, ImsDbSegment, IndexedFile, IndexedFileSingleProcess, LinkedSQLWrapper, PCB_Io, PCBDatabase, PCBModifiable, PCBScreen, QSAMFile, QueueRecord, RelativeFile, ScratchPadArea, SequentialFile, SequentialNIOFile, SequentialVariableMappedFile, SQLWrapper, SSABean, TerminalUserArea, TransactionWorkArea, TSQueueStorageImpl

public interface ISMBean

For internal use only representation of DAO beans - CBLBean, CBLBean, AbstractContainerBean ...

Method Summary

Modifier and Type	Method	Description
void	assignExemptFromMemRelease(boolean exempt)
void	assignSessionId(Long sessionId)	For internal use only
void	assignValue(String newValue)	Assign a value to this DA (CBL type implementations will take care of REDEFINITIONS, OCCURS DEPENDING, Packed=Decimal fields, ...)
void	initialize()	Equivalent of COBOL's INITIALIZE statement
boolean	isExemptFromMemRelease()
boolean	isResourceAlreadyReleased()
void	releaseResources(boolean forceRelease)	For internal use only - memory management stuff
void	resetStructure(boolean restoreInitialValues)	For internal use only.
int	retrieveActualLength()	returns the size of the Stringified representation of the DAO, ie concatenation of DAO fields sizes The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.
String	retrieveAsString()	returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.
ISMObject	retrieveField(int fieldNum)	For internal use only
ISMObject	retrieveField(String fieldName)	For internal use only
Long	retrieveSessionId()	For internal use only
ISMObject	retrieveTopLevelField()	DAO classes need to have one (and only one) field / group.
String	retrieveValue()	Same as retrieveAsString - returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.
String	stringValue()	returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes.

Method Details

retrieveField

ISMObject retrieveField(int fieldNum)

For internal use only

Parameters:

fieldNum -

Returns:

retrieveField

ISMObject retrieveField(String fieldName)

For internal use only

Parameters:

fieldName -

Returns:

releaseResources

void releaseResources(boolean forceRelease)

For internal use only - memory management stuff

Parameters:

forceRelease -

assignValue

void assignValue(String newValue)

Assign a value to this DA (CBL type implementations will take care of REDEFINITIONS, OCCURS DEPENDING, Packed=Decimal fields, ...)

retrieveActualLength

int retrieveActualLength()

returns the size of the Stringified representation of the DAO, ie concatenation of DAO fields sizes The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Returns:

retrieveAsString

String retrieveAsString()

returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Returns:

stringValue

String stringValue()

returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Returns:

retrieveValue

String retrieveValue()

Same as retrieveAsString - returns the Stringified representation of the DAO - concatenation of DAO fields according to the declared fields sizes. The result is COBOL compliant - ie Packed-Decimal Fields will be contain the same binay information as COBOL.

Returns:

retrieveTopLevelField

ISMObject retrieveTopLevelField()

DAO classes need to have one (and only one) field / group.
this methods retrieves the top level field / group

Returns:

initialize

void initialize()

Equivalent of COBOL's INITIALIZE statement

resetStructure

void resetStructure(boolean restoreInitialValues)

For internal use only. fills the underlying char array (if any present) to '0' - (this is the status at the time of instantiation). Then it calls InitDefaultValues.

Parameters:

restoreInitialValues - Used under certain circumstances in CICS (STORAGE 00), It clears the data, restoring INITIAL-VALUES as defined in original-COBOL

assignSessionId

void assignSessionId(Long sessionId)

For internal use only

retrieveSessionId

Long retrieveSessionId()

For internal use only

assignExemptFromMemRelease

void assignExemptFromMemRelease(boolean exempt)

isExemptFromMemRelease

boolean isExemptFromMemRelease()

isResourceAlreadyReleased

boolean isResourceAlreadyReleased()