Package com.esprow.oapi.repository
Interface OapiActor
public interface OapiActor
An element representing a session counterparty or an external entity participating in a session.
The following attributes and references are supported:
-
Method Summary
Modifier and TypeMethodDescriptionReturns a list of all elements present within the container.Returns all metadata on an element (documentation etc.).Returns a list of state variables presented as references to component definitions.Returns a list of state variables organized as components.Returns a list of state variables presented as references to field definitions.Returns a list of state variables presented as field definitions.Returns a list of state variables presented as references to group definitions.Returns a list of state variables presented as repeating groups.getName()
Returns the unique name of the actor.Returns a list of state machines holding the actor's state.Returns a list of timers defining time dependent behaviors.void
setAnnotation
(OapiAnnotation value) Set all metadata on an element (documentation etc.).void
Set the unique name of the actor.
-
Method Details
-
getAllElements
MixedContent getAllElements()Returns a list of all elements present within the container.- Returns:
- a list of all elements present within the container
-
getFields
Returns a list of state variables presented as field definitions.- Returns:
- a list of state variables presented as field definitions
-
getFieldRefs
List<OapiFieldRef> getFieldRefs()Returns a list of state variables presented as references to field definitions.- Returns:
- a list of state variables presented as references to field definitions
-
getComponents
List<OapiComponent> getComponents()Returns a list of state variables organized as components.- Returns:
- a list of state variables organized as components
-
getComponentRefs
List<OapiComponentRef> getComponentRefs()Returns a list of state variables presented as references to component definitions.- Returns:
- a list of state variables presented as references to component definitions
-
getGroups
Returns a list of state variables presented as repeating groups.- Returns:
- a list of state variables presented as repeating groups
-
getGroupRefs
List<OapiGroupRef> getGroupRefs()Returns a list of state variables presented as references to group definitions.- Returns:
- a list of state variables presented as references to group definitions
-
getStates
List<OapiStateMachine> getStates()Returns a list of state machines holding the actor's state.- Returns:
- a list of state machines holding the actor's state
-
getTimers
Returns a list of timers defining time dependent behaviors.- Returns:
- a list of timers defining time dependent behaviors
-
getAnnotation
OapiAnnotation getAnnotation()Returns all metadata on an element (documentation etc.).- Returns:
- all metadata on an element (documentation etc.)
- See Also:
-
setAnnotation
Set all metadata on an element (documentation etc.).- Parameters:
value
- the new value of the 'Annotation' containment reference.- See Also:
-
getName
String getName()Returns the unique name of the actor.- Returns:
- the unique name of the actor
- See Also:
-
setName
Set the unique name of the actor.- Parameters:
value
- the new value of the 'Name' attribute.- See Also:
-