com.microfocus.awm.meta.interfaces

Interface RFilterAction

All Superinterfaces:

AWMObject, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

RFilterActionImpl

public interface RFilterAction
extends AWMObject

The relationship "Filter type has Actions" is used to define actions that can be carried out on the filter. It is possible to define more than one filter has action relatiopnships. Exactly one of the relationships should have the attribute Default_Action set to true. This action is carried out when the user double clicks the filter entry.

The following features are supported:

• Target ID
• Default Action
• Label

See Also:

TaurusPackage.getRFilterAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel() Returns the value of the 'Label' attribute.
java.lang.String	getLabelFromHierarchy() Returns the Label or, if the Label wasn't set, the Label of the referenced ActionDescriptor (TargetID).
ActionDescriptor	getTargetID() Returns the value of the 'Target ID' reference.
boolean	isDefaultAction() Returns the value of the 'Default Action' attribute.
boolean	isSetDefaultAction() Returns whether the value of the 'Default Action' attribute is set.
void	setDefaultAction(boolean value) Sets the value of the 'Default Action' attribute.
void	setLabel(java.lang.String value) Sets the value of the 'Label' attribute.
void	setTargetID(ActionDescriptor value) Sets the value of the 'Target ID' reference.
void	unsetDefaultAction() Unsets the value of the 'Default Action' attribute.

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

Method Detail

getTargetID

ActionDescriptor getTargetID()

Returns the value of the 'Target ID' reference. The reference to an action descriptor that is to be carried out by the filter action, preferably an action descriptor that returns an element list.

Returns:

the value of the 'Target ID' reference.

See Also:

setTargetID(ActionDescriptor), TaurusPackage.getRFilterAction_TargetID()

setTargetID

void setTargetID(ActionDescriptor value)

Sets the value of the 'Target ID' reference.

Parameters:

value - the new value of the 'Target ID' reference.

See Also:

getTargetID()

isDefaultAction

boolean isDefaultAction()

Returns the value of the 'Default Action' attribute. The default value is "true".
Defines whether this action should be carried out by a double-click on the filter entry. Only one action of a filter type can be declared as a default action.

Returns:

the value of the 'Default Action' attribute.

See Also:

isSetDefaultAction(), unsetDefaultAction(), setDefaultAction(boolean), TaurusPackage.getRFilterAction_DefaultAction()

setDefaultAction

void setDefaultAction(boolean value)

Sets the value of the 'Default Action' attribute.

Parameters:

value - the new value of the 'Default Action' attribute.

See Also:

isSetDefaultAction(), unsetDefaultAction(), isDefaultAction()

unsetDefaultAction

void unsetDefaultAction()

Unsets the value of the 'Default Action' attribute.

See Also:

isSetDefaultAction(), isDefaultAction(), setDefaultAction(boolean)

isSetDefaultAction

boolean isSetDefaultAction()

Returns whether the value of the 'Default Action' attribute is set.

Returns:

whether the value of the 'Default Action' attribute is set.

See Also:

unsetDefaultAction(), isDefaultAction(), setDefaultAction(boolean)

getLabel

java.lang.String getLabel()

Returns the value of the 'Label' attribute.
The display name of the action in the context menu of a selected filter.

Returns:

the value of the 'Label' attribute.

See Also:

setLabel(String), TaurusPackage.getRFilterAction_Label()

getLabelFromHierarchy

java.lang.String getLabelFromHierarchy()

Returns the Label or, if the Label wasn't set, the Label of the referenced ActionDescriptor (TargetID). If the ActionDescriptors Label wasn't set, too, its ID will be returned.

setLabel

void setLabel(java.lang.String value)

Sets the value of the 'Label' attribute.

Parameters:

value - the new value of the 'Label' attribute.

See Also:

getLabel()