For use with Java applications generated by SoftwareMining's COBOL-to-Java conversion tools.

Package com.softwaremining.cics.dto

Class SendDO

java.lang.Object

com.softwaremining.cics.dto.CicsDO

com.softwaremining.cics.dto.SendDO

All Implemented Interfaces:

ICicsScreenDO

public class SendDO
extends CicsDO
implements ICicsScreenDO

Field Summary

Fields inherited from class com.softwaremining.cics.dto.CicsDO

handleActive, log, resp, resp2

Constructor Summary

Constructors

Constructor	Description
SendDO()

Method Summary

Modifier and Type	Method	Description
ISMObject	getFrom()	returns the TopLevelField for the specified screenOutputBuffer
ISMObject	getLength()
ISMObject	getMap()
ISMObject	getMapset()
ISMObject	getScreenBufferObject()
ISMObject	getScreenIOObject()
String	getText()	Deprecated. - replace with getTextDataObj()
AbstractDataObject	getTextDataObj()	Used interenally for printToFile
boolean	isAlarm()
boolean	isControl()
boolean	isCursor()
boolean	isDataonly()
boolean	isDli_IgnoreAttribs()
boolean	isErase()
boolean	isEraseaup()
boolean	isFormfeed()
boolean	isFreekb()
boolean	isFrset()
boolean	isMaponly()
boolean	isNleom()
boolean	isPrint()
boolean	isText()
boolean	isWait()
SendDO	setAccum()	to do : unsure what this is meanth to do.
SendDO	setAlarm()
SendDO	setControl()
SendDO	setCursor()
SendDO	setDataonly()	when dataOnly is assigned - the previous version of screen is cleared before re-displaying the new information.
SendDO	setDli_IgnoreAttribs(boolean dli_IgnoreAttribs)
SendDO	setErase()
SendDO	setEraseaup()
SendDO	setFormfeed()
SendDO	setFreekb()
SendDO	setFreeKB()
SendDO	setFrom(CBLBean screenOutputBuffer)	Then the value of fields in screenOutputBuffer will be used to populate the elements of target screen.
SendDO	setFrom(CBLBean screenOutputBuffer, CBLBean dataBuffer)	First the data provided in "dataBuffer" is copied to screenOutputBuffer.
SendDO	setFrom(ISMBean screenOutputBuffer, ISMObject dataBuffer)	First the data provided in "dataBuffer" is copied to screenOutputBuffer.
SendDO	setFrom(ISMObject from)	A field or Group containing fields to be used as data for population of screen elements Note that the the names of fields must match those in screen elements.
SendDO	setFrom(ISMObject screenOutputBuffer, ISMObject dataBuffer)	First the data provided in "dataBuffer" is copied to screenOutputBuffer.
SendDO	setFrset()
SendDO	setHoneom()	specifies that the default printer line length is to be used.
SendDO	setLast()	to do specifies that this is the last SEND command for a transaction
SendDO	setLength(int newValue)	For backward compatibility only - length information is not used
SendDO	setLength(ISMObject length)	For backward compatibility only - length information is not used
SendDO	setMap(ISMObject map)
SendDO	setMap(String map)
SendDO	setMaponly()
SendDO	setMapset(String mapset_FileName)
SendDO	setNleom()
SendDO	setPaging()	specifies that the default printer line length is to be used.
SendDO	setPrint()
SendDO	setResponse(ISMObject responseField)
SendDO	setTerminal()	to do specifies that this is the last SEND command for a transaction
SendDO	setText(AbstractDataObject textObj)
SendDO	setText(String text)
SendDO	setWait()

Methods inherited from class com.softwaremining.cics.dto.CicsDO

getCicsRespondCode, getResp2, getResponseField, isHandleActive, setCicsRespondCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SendDO

public SendDO()

Method Details

setMap

public SendDO setMap(String map)

setMap

public SendDO setMap(ISMObject map)

getMap

public ISMObject getMap()

Specified by:

getMap in interface ICicsScreenDO

setMapset

public SendDO setMapset(String mapset_FileName)

Parameters:

mapset_FileName - - name of the original BMS-FILE, and name of target XML file

Returns:

getMapset

public ISMObject getMapset()

Specified by:

getMapset in interface ICicsScreenDO

Returns:

- name of the original BMS-FILE

setFrom

public SendDO setFrom(ISMObject from)

A field or Group containing fields to be used as data for population of screen elements Note that the the names of fields must match those in screen elements.

Parameters:

from -

Returns:

setFrom

public SendDO setFrom(CBLBean screenOutputBuffer)

Then the value of fields in screenOutputBuffer will be used to populate the elements of target screen. Note that the the names of fields must match those in screen elements.

Parameters:

screenOutputBuffer -

Returns:

setFrom

public SendDO setFrom(CBLBean screenOutputBuffer,
 CBLBean dataBuffer)

First the data provided in "dataBuffer" is copied to screenOutputBuffer. Then the value of fields in screenOutputBuffer will be used to populate the elements of target screen. Note that the the names of fields must match those in screen elements.

Parameters:

screenOutputBuffer -

dataBuffer -

Returns:

setFrom

public SendDO setFrom(ISMBean screenOutputBuffer,
 ISMObject dataBuffer)

First the data provided in "dataBuffer" is copied to screenOutputBuffer. Then the value of fields in screenOutputBuffer will be used to populate the elements of target screen. Note that the the names of fields must match those in screen elements.

Parameters:

screenOutputBuffer -

dataBuffer -

Returns:

setFrom

public SendDO setFrom(ISMObject screenOutputBuffer,
 ISMObject dataBuffer)

First the data provided in "dataBuffer" is copied to screenOutputBuffer. Then the value of fields in screenOutputBuffer will be used to populate the elements of target screen. Note that the the names of fields must match those in screen elements.

Parameters:

screenOutputBuffer -

dataBuffer -

Returns:

getFrom

public ISMObject getFrom()

returns the TopLevelField for the specified screenOutputBuffer

Returns:

setLength

public SendDO setLength(ISMObject length)

For backward compatibility only - length information is not used

Parameters:

length -

Returns:

setLength

public SendDO setLength(int newValue)

For backward compatibility only - length information is not used

Parameters:

newValue -

Returns:

getLength

public ISMObject getLength()

setResponse

public SendDO setResponse(ISMObject responseField)

setDataonly

public SendDO setDataonly()

when dataOnly is assigned - the previous version of screen is cleared before re-displaying the new information.

Returns:

isDataonly

public boolean isDataonly()

setMaponly

public SendDO setMaponly()

isMaponly

public boolean isMaponly()

setCursor

public SendDO setCursor()

isCursor

public boolean isCursor()

setFormfeed

public SendDO setFormfeed()

isFormfeed

public boolean isFormfeed()

setErase

public SendDO setErase()

isErase

public boolean isErase()

setEraseaup

public SendDO setEraseaup()

isEraseaup

public boolean isEraseaup()

setPrint

public SendDO setPrint()

isPrint

public boolean isPrint()

setFreeKB

public SendDO setFreeKB()

setFreekb

public SendDO setFreekb()

isFreekb

public boolean isFreekb()

setAlarm

public SendDO setAlarm()

isAlarm

public boolean isAlarm()

setFrset

public SendDO setFrset()

isFrset

public boolean isFrset()

setWait

public SendDO setWait()

isWait

public boolean isWait()

setText

public SendDO setText(String text)

setText

public SendDO setText(AbstractDataObject textObj)

getText

public String getText()

Deprecated.

- replace with getTextDataObj()

for internal use only

Returns:

getTextDataObj

public AbstractDataObject getTextDataObj()

Used interenally for printToFile

Returns:

isText

public boolean isText()

setNleom

public SendDO setNleom()

isNleom

public boolean isNleom()

setControl

public SendDO setControl()

isControl

public boolean isControl()

setLast

public SendDO setLast()

to do specifies that this is the last SEND command for a transaction

Returns:

setTerminal

public SendDO setTerminal()

to do specifies that this is the last SEND command for a transaction

Returns:

setHoneom

public SendDO setHoneom()

specifies that the default printer line length is to be used. This length should be the same as that specified using the RDO TYPETERM options PAGESIZE or ALTPAGE, and the same as the printer platen width; otherwise the data may not format correctly. When using the HONEOM option, see DFHMDI options, CTRL for a description of the option priority.

Returns:

setPaging

public SendDO setPaging()

specifies that the default printer line length is to be used. This length should be the same as that specified using the RDO TYPETERM options PAGESIZE or ALTPAGE, and the same as the printer platen width; otherwise the data may not format correctly. When using the HONEOM option, see DFHMDI options, CTRL for a description of the option priority.

Returns:

setAccum

public SendDO setAccum()

to do : unsure what this is meanth to do. No documentation on http://publib.boulder.ibm.com/infocenter/txformp/v6r0m0/index.jsp?topic=/com.ibm.cics.te.doc/erziai0024.htm EXEC CICS SEND MAP(..) MAPSET(..) FROM(...) ACCUM

Returns:

getScreenIOObject

public ISMObject getScreenIOObject()

getScreenBufferObject

public ISMObject getScreenBufferObject()

isDli_IgnoreAttribs

public boolean isDli_IgnoreAttribs()

setDli_IgnoreAttribs

public SendDO setDli_IgnoreAttribs(boolean dli_IgnoreAttribs)