com.microfocus.awm.meta.interfaces

Interface RToolOutParameter

All Superinterfaces:

AWMObject, DynamicObject, org.eclipse.emf.ecore.EObject, IFunctionPackageDefinable, org.eclipse.emf.common.notify.Notifier, RToolParameter

All Known Implementing Classes:

RToolOutParameterImpl

public interface RToolOutParameter
extends RToolParameter

The output parameters of a tool will be temporarily saved during the execution of an action, so that subsequent tools can use them as input parameters.

The following features are supported:

• To Output Dialog

See Also:

TaurusPackage.getRToolOutParameter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabelFromHierarchy() Returns the Label or the Name, if the Label wasn't set.
boolean	isSetToOutputDialog() Returns whether the value of the 'To Output Dialog' attribute is set.
boolean	isToOutputDialog() Returns the value of the 'To Output Dialog' attribute.
void	setToOutputDialog(boolean value) Sets the value of the 'To Output Dialog' attribute.
void	unsetToOutputDialog() Unsets the value of the 'To Output Dialog' attribute.

Methods inherited from interface com.microfocus.awm.meta.interfaces.RToolParameter

getComplexAttribute, getLabel, getParsedCategory, getSeqNo, getTargetIDFile, getTargetIDParm, getType, getUiCategory, isMassProcessing, isSetSeqNo, isSetType, isSetUiResizable, isUiResizable, setLabel, setMassProcessing, setSeqNo, setTargetIDFile, setTargetIDParm, setType, setUiCategory, setUiResizable, unsetSeqNo, unsetType, unsetUiResizable

Methods inherited from interface com.microfocus.awm.meta.interfaces.DynamicObject

getComplexAttributes, getDynamicAttributes, getDynamicValue, setDynamicValue

Methods inherited from interface com.microfocus.awm.meta.interfaces.AWMObject

getComment, isSetComment, setComment, unsetComment

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.microfocus.awm.meta.interfaces.IFunctionPackageDefinable

getExtensionID, setExtensionID

Method Detail

isToOutputDialog

boolean isToOutputDialog()

Returns the value of the 'To Output Dialog' attribute. The default value is "false".
Indicates whether the parameter should be displayed in the Output dialog box at the end of the action. This only takes place if there is an Output dialog modeled at the end of the tool sequence.

Returns:

the value of the 'To Output Dialog' attribute.

See Also:

isSetToOutputDialog(), unsetToOutputDialog(), setToOutputDialog(boolean), TaurusPackage.getRToolOutParameter_ToOutputDialog()

setToOutputDialog

void setToOutputDialog(boolean value)

Sets the value of the 'To Output Dialog' attribute.

Parameters:

value - the new value of the 'To Output Dialog' attribute.

See Also:

isSetToOutputDialog(), unsetToOutputDialog(), isToOutputDialog()

unsetToOutputDialog

void unsetToOutputDialog()

Unsets the value of the 'To Output Dialog' attribute.

See Also:

isSetToOutputDialog(), isToOutputDialog(), setToOutputDialog(boolean)

isSetToOutputDialog

boolean isSetToOutputDialog()

Returns whether the value of the 'To Output Dialog' attribute is set.

Returns:

whether the value of the 'To Output Dialog' attribute is set.

See Also:

unsetToOutputDialog(), isToOutputDialog(), setToOutputDialog(boolean)

getLabelFromHierarchy

java.lang.String getLabelFromHierarchy()

Returns the Label or the Name, if the Label wasn't set.

Returns:

a label for the parameter