Public methods

actionOnCondition

ActionOnCondition actionOnCondition(IccCondition::Codes condition)
condition
The name of the condition as an enumeration. See IccCondition structure for a list of the possible values.

Returns an enumeration that indicates what action the class will take in response to the specified condition being raised by CICS®. The possible values are described in this class.

actionOnConditionAsChar

char actionOnConditionAsChar(IccCondition::Codes condition)

This method is the same as actionOnCondition but returns a character, rather than an enumeration, as follows:

0 (zero)
No action is taken for this CICS condition.
H
The virtual method handleEvent is called for this CICS condition.
X
An exception is generated for this CICS condition.
A
This program is abended for this CICS condition.

actionsOnConditionsText

const char* actionsOnConditionsText()

Returns a string of characters, one character for each possible condition. Each character indicates the actions to be performed for that corresponding condition. The characters used in the string are described above in actionOnConditionAsChar. For example, the string: 0X00H0A ... shows the actions for the first seven conditions are as follows:

condition 0 (NORMAL)
action=0 (noAction)
condition 1 (ERROR)
action=X (throwException)
condition 2 (RDATT)
action=0 (noAction)
condition 3 (WRBRK)
action=0 (noAction)
condition 4 (ICCEOF)
action=H (callHandleEvent)
condition 5 (EODS)
action=0 (noAction)
condition 6 (EOC)
action=A (abendTask)

clear

virtual void clear()

Clears the contents of the object. This method is virtual and is implemented, wherever appropriate, in the derived classes. See Polymorphic Behavior for a description of polymorphism. The default implementation in this class throws an exception to indicate that it has not been overridden in a subclass.

condition

unsigned long condition(ConditionType type = majorCode) const

type
An enumeration, defined in this class, that indicates the type of condition requested. Possible values are majorCode (the default) and minorCode.

Returns a number that indicates the condition code for the most recent CICS call made by this object.

conditionText

const char* conditionText() const

Returns the symbolic name of the last CICS condition for this object.

get

virtual const IccBuf& get()

Gets data from the IccResource object and returns it as an IccBuf reference. This method is virtual and is implemented, wherever appropriate, in the derived classes. See Polymorphic Behavior for a description of polymorphism. The default implementation in this class throws an exception to indicate that it has not been overridden in a subclass.

handleEvent

virtual HandleEventReturnOpt handleEvent(IccEvent& event)

event
A reference to an IccEvent object that describes the reason why this method is being called.

This virtual function may be re-implemented in a subclass (by the application programmer) to handle CICS events (see IccEvent class on page IccEvent class).

id

const IccResourceId* id() const

Returns a pointer to the IccResourceId object associated with this IccResource object.

isEDFOn

Icc::Bool isEDFOn() const

Returns a boolean value that indicates whether EDF trace is active. Possible values are yes or no.

isRouteOptionOn

Icc::Bool isRouteOptionOn() const

Returns a boolean value that indicates whether the route option is active. Possible values are yes or no.

name

const char* name() const

Returns a character string that gives the name of the resource that is being used. For an IccTempStore object, the 8-character name of the temporary storage queue is returned. For an IccTerminal object, the 4-character terminal name is returned. This is equivalent to calling id()->name.

put

virtual void put(const IccBuf& buffer)

buffer
A reference to an IccBuf object that contains data that is to be put into the object.

Puts information from the buffer into the IccResource object. This method is virtual and is implemented, wherever appropriate, in the derived classes. See Polymorphic Behavior for more information on polymorphism. The default implementation in this class throws an exception to indicate that it has not been overridden in a subclass.

routeOption

const IccSysId& routeOption() const

Returns a reference to an IccSysId object that represents the system to which all CICS requests are routed--explicit function shipping.

setActionOnAnyCondition

void setActionOnAnyCondition(ActionOnCondition action)

action
The name of the action as an enumeration. The possible values are listed under the description of this class.

Specifies the default action to be taken by the CICS foundation classes when a CICS condition occurs.

setActionOnCondition

void setActionOnCondition (ActionOnCondition action,
                           IccCondition::Codes condition)

action
The name of the action as an enumeration. The possible values are listed under the description of this class.
condition
See IccCondition structure.

Specifies what action is automatically taken by the CICS foundation classes when a given CICS condition occurs.

setActionsOnConditions

void setActionsOnConditions(const char* actions = 0)

actions
A string that indicates what action is to be taken for each condition. The default is not to indicate any actions, in which case each condition is given a default ActionOnCondition of noAction. The string should have the same format as the one returned by the actionsOnConditionsText method.

setEDF

void setEDF(Icc::Bool onOff)
onOff
A boolean value that selects whether EDF trace is switched on or off.

Switches EDF on or off for this resource object. See Execution Diagnostic Facility.

These methods force the object to route CICS requests to the named remote system. This is called explicit function shipping.

setRouteOption (1)

void setRouteOption(const IccSysId& sysId)

The parameters are:

sysId
The IccSysId object that represents the remote system to which commands are routed.

setRouteOption (2)

void setRouteOption(const char* sysName = 0)
sysName
The 4-character name of the system to which commands are routed.

This option is only valid for the following classes:

Attempting to use this method on other subclasses of IccResource causes an exception to be thrown.

To turn off the route option specify no parameter, for example:

obj.setRouteOption()
[[ Contents Previous Page | Next Page Index ]]