org.eclipse.uml2
Interface State

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Namespace, Notifier, RedefinableElement, TemplateableElement, Vertex
All Known Subinterfaces:
FinalState

public interface State
extends Namespace, RedefinableElement, Vertex

A representation of the model object 'State'.

The following features are supported:

See Also:
UML2Package.getState()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 ConnectionPointReference createConnection(EClass eClass)
          Creates a ConnectionPointReference and appends it to the 'Connection' containment reference list
 Activity createDoActivity(EClass eClass)
          Creates a Activity and sets the 'Do Activity' containment reference
 Activity createEntry(EClass eClass)
          Creates a Activity and sets the 'Entry' containment reference
 Activity createExit(EClass eClass)
          Creates a Activity and sets the 'Exit' containment reference
 Region createRegion(EClass eClass)
          Creates a Region and appends it to the 'Region' containment reference list
 Constraint createStateInvariant(EClass eClass)
          Creates a Constraint and sets the 'State Invariant' containment reference
 ConnectionPointReference getConnection(String unqualifiedName)
          Retrieves the ConnectionPointReference with the specified name from the 'Connection' containment reference list
 EList getConnections()
          Returns the value of the 'Connection' containment reference list.
 Trigger getDeferrableTrigger(String unqualifiedName)
          Retrieves the Trigger with the specified name from the 'Deferrable Trigger' reference list
 EList getDeferrableTriggers()
          Returns the value of the 'Deferrable Trigger' reference list.
 Activity getDoActivity()
          Returns the value of the 'Do Activity' containment reference
 Activity getEntry()
          Returns the value of the 'Entry' containment reference
 Activity getExit()
          Returns the value of the 'Exit' containment reference
 EList getOwnedElements()
           
 EList getOwnedMembers()
           
 EList getRedefinedElements()
           
 State getRedefinedState()
          Returns the value of the 'Redefined State' reference
 EList getRedefinitionContexts()
           
 Region getRegion(String unqualifiedName)
          Retrieves the Region with the specified name from the 'Region' containment reference list
 EList getRegions()
          Returns the value of the 'Region' containment reference list.
 Constraint getStateInvariant()
          Returns the value of the 'State Invariant' containment reference
 StateMachine getSubmachine()
          Returns the value of the 'Submachine' reference
 boolean isComposite()
          Returns the value of the 'Is Composite' attribute
 boolean isOrthogonal()
          Returns the value of the 'Is Orthogonal' attribute
 boolean isSimple()
          Returns the value of the 'Is Simple' attribute
 boolean isSubmachineState()
          Returns the value of the 'Is Submachine State' attribute
 void setDoActivity(Activity value)
          Sets the value of the 'Do Activity' containment reference
 void setEntry(Activity value)
          Sets the value of the 'Entry' containment reference
 void setExit(Activity value)
          Sets the value of the 'Exit' containment reference
 void setRedefinedState(State value)
          Sets the value of the 'Redefined State' reference
 void setStateInvariant(Constraint value)
          Sets the value of the 'State Invariant' containment reference
 void setSubmachine(StateMachine value)
          Sets the value of the 'Submachine' reference
 
Methods inherited from interface org.eclipse.uml2.Namespace
createElementImport, createOwnedRule, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getOwner, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.Vertex
getContainer, getIncoming, getIncomings, getOutgoing, getOutgoings, getOwner, setContainer
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

isComposite

public boolean isComposite()
Returns the value of the 'Is Composite' attribute.

If the meaning of the 'Is Composite' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Composite' attribute.
See Also:
UML2Package.getState_IsComposite()

isOrthogonal

public boolean isOrthogonal()
Returns the value of the 'Is Orthogonal' attribute.

If the meaning of the 'Is Orthogonal' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Orthogonal' attribute.
See Also:
UML2Package.getState_IsOrthogonal()

isSimple

public boolean isSimple()
Returns the value of the 'Is Simple' attribute.

If the meaning of the 'Is Simple' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Simple' attribute.
See Also:
UML2Package.getState_IsSimple()

isSubmachineState

public boolean isSubmachineState()
Returns the value of the 'Is Submachine State' attribute.

If the meaning of the 'Is Submachine State' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Submachine State' attribute.
See Also:
UML2Package.getState_IsSubmachineState()

getSubmachine

public StateMachine getSubmachine()
Returns the value of the 'Submachine' reference.

If the meaning of the 'Submachine' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Submachine' reference.
See Also:
setSubmachine(StateMachine), UML2Package.getState_Submachine()

setSubmachine

public void setSubmachine(StateMachine value)
Sets the value of the 'Submachine' reference.

Parameters:
value - the new value of the 'Submachine' reference.
See Also:
getSubmachine()

getConnections

public EList getConnections()
Returns the value of the 'Connection' containment reference list. The list contents are of type ConnectionPointReference.

If the meaning of the 'Connection' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Connection' containment reference list.
See Also:
UML2Package.getState_Connection()

getConnection

public ConnectionPointReference getConnection(String unqualifiedName)
Retrieves the ConnectionPointReference with the specified name from the 'Connection' containment reference list.

Parameters:
unqualifiedName - The unqualified name of the ConnectionPointReference to retrieve.
Returns:
The ConnectionPointReference with the specified name, or null.
See Also:
getConnections()

createConnection

public ConnectionPointReference createConnection(EClass eClass)
Creates a ConnectionPointReference and appends it to the 'Connection' containment reference list.

Parameters:
eClass - The Ecore class of the ConnectionPointReference to create.
Returns:
The new ConnectionPointReference.
See Also:
getConnections()

getRedefinedState

public State getRedefinedState()
Returns the value of the 'Redefined State' reference.

If the meaning of the 'Redefined State' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Redefined State' reference.
See Also:
setRedefinedState(State), UML2Package.getState_RedefinedState()

setRedefinedState

public void setRedefinedState(State value)
Sets the value of the 'Redefined State' reference.

Parameters:
value - the new value of the 'Redefined State' reference.
See Also:
getRedefinedState()

getDeferrableTriggers

public EList getDeferrableTriggers()
Returns the value of the 'Deferrable Trigger' reference list. The list contents are of type Trigger.

If the meaning of the 'Deferrable Trigger' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Deferrable Trigger' reference list.
See Also:
UML2Package.getState_DeferrableTrigger()

getDeferrableTrigger

public Trigger getDeferrableTrigger(String unqualifiedName)
Retrieves the Trigger with the specified name from the 'Deferrable Trigger' reference list.

Parameters:
unqualifiedName - The unqualified name of the Trigger to retrieve.
Returns:
The Trigger with the specified name, or null.
See Also:
getDeferrableTriggers()

getRegions

public EList getRegions()
Returns the value of the 'Region' containment reference list. The list contents are of type Region. It is bidirectional and its opposite is 'State'.

If the meaning of the 'Region' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Region' containment reference list.
See Also:
UML2Package.getState_Region(), Region.getState()

getRegion

public Region getRegion(String unqualifiedName)
Retrieves the Region with the specified name from the 'Region' containment reference list.

Parameters:
unqualifiedName - The unqualified name of the Region to retrieve.
Returns:
The Region with the specified name, or null.
See Also:
getRegions()

createRegion

public Region createRegion(EClass eClass)
Creates a Region and appends it to the 'Region' containment reference list.

Parameters:
eClass - The Ecore class of the Region to create.
Returns:
The new Region.
See Also:
getRegions()

getEntry

public Activity getEntry()
Returns the value of the 'Entry' containment reference.

If the meaning of the 'Entry' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Entry' containment reference.
See Also:
setEntry(Activity), UML2Package.getState_Entry()

setEntry

public void setEntry(Activity value)
Sets the value of the 'Entry' containment reference.

Parameters:
value - the new value of the 'Entry' containment reference.
See Also:
getEntry()

createEntry

public Activity createEntry(EClass eClass)
Creates a Activity and sets the 'Entry' containment reference.

Parameters:
eClass - The Ecore class of the Activity to create.
Returns:
The new Activity.
See Also:
getEntry()

getExit

public Activity getExit()
Returns the value of the 'Exit' containment reference.

If the meaning of the 'Exit' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Exit' containment reference.
See Also:
setExit(Activity), UML2Package.getState_Exit()

setExit

public void setExit(Activity value)
Sets the value of the 'Exit' containment reference.

Parameters:
value - the new value of the 'Exit' containment reference.
See Also:
getExit()

createExit

public Activity createExit(EClass eClass)
Creates a Activity and sets the 'Exit' containment reference.

Parameters:
eClass - The Ecore class of the Activity to create.
Returns:
The new Activity.
See Also:
getExit()

getDoActivity

public Activity getDoActivity()
Returns the value of the 'Do Activity' containment reference.

If the meaning of the 'Do Activity' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Do Activity' containment reference.
See Also:
setDoActivity(Activity), UML2Package.getState_DoActivity()

setDoActivity

public void setDoActivity(Activity value)
Sets the value of the 'Do Activity' containment reference.

Parameters:
value - the new value of the 'Do Activity' containment reference.
See Also:
getDoActivity()

createDoActivity

public Activity createDoActivity(EClass eClass)
Creates a Activity and sets the 'Do Activity' containment reference.

Parameters:
eClass - The Ecore class of the Activity to create.
Returns:
The new Activity.
See Also:
getDoActivity()

getStateInvariant

public Constraint getStateInvariant()
Returns the value of the 'State Invariant' containment reference.

If the meaning of the 'State Invariant' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'State Invariant' containment reference.
See Also:
setStateInvariant(Constraint), UML2Package.getState_StateInvariant()

setStateInvariant

public void setStateInvariant(Constraint value)
Sets the value of the 'State Invariant' containment reference.

Parameters:
value - the new value of the 'State Invariant' containment reference.
See Also:
getStateInvariant()

createStateInvariant

public Constraint createStateInvariant(EClass eClass)
Creates a Constraint and sets the 'State Invariant' containment reference.

Parameters:
eClass - The Ecore class of the Constraint to create.
Returns:
The new Constraint.
See Also:
getStateInvariant()

getRedefinitionContexts

public EList getRedefinitionContexts()

Specified by:
getRedefinitionContexts in interface RedefinableElement
Returns:
the value of the 'Redefinition Context' reference list.
See Also:
UML2Package.getRedefinableElement_RedefinitionContext()

getRedefinedElements

public EList getRedefinedElements()

Specified by:
getRedefinedElements in interface RedefinableElement

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface Namespace

getOwnedMembers

public EList getOwnedMembers()

Specified by:
getOwnedMembers in interface Namespace

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.