MObject (Modelio 4.1 API (commercial))

All Superinterfaces:

java.lang.Comparable<MObject>

All Known Subinterfaces:

AbstractDiagram, Abstraction, AbstractProject, AbstractPseudoState, AbstractResource, AcceptCallEventAction, AcceptChangeEventAction, AcceptSignalAction, AcceptTimeEventAction, Access, ActiveStructureElement, Activity, ActivityAction, ActivityDiagram, ActivityEdge, ActivityFinalNode, ActivityGroup, ActivityNode, ActivityParameterNode, ActivityPartition, Actor, Aggregation, AnalystContainer, AnalystElement, AnalystItem, AnalystProject, AnalystPropertyTable, AndJunction, ApplicationCollaboration, ApplicationComponent, ApplicationEvent, ApplicationFolder, ApplicationFunction, ApplicationInteraction, ApplicationInterface, ApplicationInternalActiveStructureElement, ApplicationInternalBehaviorElement, ApplicationProcess, ApplicationService, ArchimateAbstractElement, ArchimateProject, ArchimateView, Artifact, Artifact, Assessment, Assignment, Association, Association, AssociationEnd, Attribute, AttributeLink, Behavior, BehavioralFeature, BehaviorDiagram, BehaviorElement, BehaviorParameter, BindableInstance, Binding, BpmnActivity, BpmnAdHocSubProcess, BpmnArtifact, BpmnAssociation, BpmnBaseElement, BpmnBoundaryEvent, BpmnBusinessRuleTask, BpmnCallActivity, BpmnCancelEventDefinition, BpmnCatchEvent, BpmnCollaboration, BpmnCollaborationDiagram, BpmnCompensateEventDefinition, BpmnComplexBehaviorDefinition, BpmnComplexGateway, BpmnConditionalEventDefinition, BpmnDataAssociation, BpmnDataInput, BpmnDataObject, BpmnDataOutput, BpmnDataState, BpmnDataStore, BpmnEndEvent, BpmnEndPoint, BpmnErrorEventDefinition, BpmnEscalationEventDefinition, BpmnEvent, BpmnEventBasedGateway, BpmnEventDefinition, BpmnExclusiveGateway, BpmnFlowElement, BpmnFlowNode, BpmnGateway, BpmnGroup, BpmnImplicitThrowEvent, BpmnInclusiveGateway, BpmnInterface, BpmnIntermediateCatchEvent, BpmnIntermediateThrowEvent, BpmnItemAwareElement, BpmnItemDefinition, BpmnLane, BpmnLaneSet, BpmnLinkEventDefinition, BpmnLoopCharacteristics, BpmnManualTask, BpmnMessage, BpmnMessageEventDefinition, BpmnMessageFlow, BpmnMultiInstanceLoopCharacteristics, BpmnOperation, BpmnParallelGateway, BpmnParticipant, BpmnProcess, BpmnProcessCollaborationDiagram, BpmnProcessDesignDiagram, BpmnReceiveTask, BpmnResource, BpmnResourceParameter, BpmnResourceParameterBinding, BpmnResourceRole, BpmnScriptTask, BpmnSendTask, BpmnSequenceFlow, BpmnSequenceFlowDataAssociation, BpmnServiceTask, BpmnSharedDefinitions, BpmnSharedElement, BpmnSignalEventDefinition, BpmnStandardLoopCharacteristics, BpmnStartEvent, BpmnSubProcess, BpmnSubProcessDiagram, BpmnTask, BpmnTerminateEventDefinition, BpmnThrowEvent, BpmnTimerEventDefinition, BpmnTransaction, BpmnUserTask, BusinessActor, BusinessCollaboration, BusinessEvent, BusinessFolder, BusinessFunction, BusinessInteraction, BusinessInterface, BusinessInternalActiveStructureElement, BusinessInternalBehaviorElement, BusinessObject, BusinessPassiveStructureElement, BusinessProcess, BusinessRole, BusinessRule, BusinessRuleContainer, BusinessService, CallAction, CallBehaviorAction, CallOperationAction, Capability, CentralBufferNode, ChoicePseudoState, Class, ClassAssociation, ClassDiagram, Classifier, Clause, Collaboration, CollaborationUse, CombinedFragment, CommunicationChannel, CommunicationDiagram, CommunicationInteraction, CommunicationMessage, CommunicationNetwork, CommunicationNode, Component, ComponentRealization, CompositeElement, CompositeStructureDiagram, Composition, Concept, ConditionalNode, ConnectionPointReference, Connector, ConnectorEnd, Constraint, Constraint, Contract, ControlFlow, ControlNode, CourseOfAction, DataFlow, DataObject, DataStoreNode, DataType, DecisionMergeNode, DeepHistoryPseudoState, Deliverable, Dependency, DependencyRelationship, DeploymentDiagram, Device, DiagramSet, Dictionary, DistributionNetwork, Document, Driver, DurationConstraint, DynamicPropertyDefinition, DynamicRelationship, Element, Element, ElementImport, ElementRealization, EntryPointPseudoState, EnumeratedPropertyType, Enumeration, EnumerationLiteral, Equipment, Event, Event, ExceptionHandler, ExecutionOccurenceSpecification, ExecutionSpecification, ExitPointPseudoState, ExpansionNode, ExpansionRegion, ExtensionPoint, ExternalActiveStructureElement, ExternalBehaviorElement, ExternElement, ExternProcessor, Facility, FakeMObject, Feature, FinalNode, FinalState, Flow, FlowFinalNode, Folder, ForkJoinNode, ForkPseudoState, Gap, Gate, GeneralClass, Generalization, GeneralOrdering, GenericAnalystContainer, GenericAnalystElement, Goal, Goal, GoalContainer, GraphDiagram, Grouping, ImpactDiagram, ImpactLink, ImpactModel, ImpactProject, ImplementationEvent, ImplementationFolder, Influence, InformationFlow, InformationItem, InitialNode, InitialPseudoState, InputPin, Instance, InstanceNode, Interaction, InteractionFragment, InteractionOperand, InteractionUse, Interface, InterfaceRealization, InternalActiveStructureElement, InternalBehaviorElement, InternalTransition, InterruptibleActivityRegion, JoinPseudoState, Junction, JunctionPseudoState, KPI, KPIContainer, Lifeline, Link, LinkEnd, LocalPropertyTable, Location, LoopNode, Manifestation, Material, MatrixDefinition, MatrixValueDefinition, Meaning, Message, MessageEnd, MessageFlow, MetaclassReference, MethodologicalLink, Model, ModelElement, ModelTree, ModuleComponent, ModuleParameter, MotivationElement, MotivationFolder, NameSpace, NaryAssociation, NaryAssociationEnd, NaryConnector, NaryConnectorEnd, NaryLink, NaryLinkEnd, Node, Node, Note, NoteType, ObjectDiagram, ObjectFlow, ObjectNode, OccurrenceSpecification, OpaqueAction, OpaqueBehavior, Operation, OrJunction, OtherRelationship, Outcome, OutputPin, Package, PackageImport, PackageMerge, Parameter, PartDecomposition, PassiveStructureElement, Path, PhysicalFolder, Pin, Plateau, Port, Principle, Product, Profile, Project, PropertyDefinition, PropertyEnumerationLitteral, PropertyTable, PropertyTableDefinition, PropertyType, ProvidedInterface, QueryDefinition, RaisedException, Realization, Region, Relationship, RelationshipConnector, Representation, RequiredInterface, Requirement, Requirement, RequirementContainer, Resource, Resource, ResourceType, Risk, RiskContainer, SendSignalAction, SequenceDiagram, Serving, ShallowHistoryPseudoState, Signal, Specialization, Stakeholder, State, StateInvariant, StateMachine, StateMachineDiagram, StateVertex, StaticDiagram, Stereotype, StrategyBehaviorElement, StrategyFolder, StructuralFeature, StructuralRelationship, StructuredActivityNode, StructureElement, Substitution, SystemSoftware, TaggedValue, TagParameter, TagType, TechnologyActiveStructureElement, TechnologyCollaboration, TechnologyEvent, TechnologyFolder, TechnologyFunction, TechnologyInteraction, TechnologyInterface, TechnologyInternalActiveStructureElement, TechnologyInternalBehaviorElement, TechnologyObject, TechnologyProcess, TechnologyService, TemplateBinding, TemplateParameter, TemplateParameterSubstitution, Term, TerminatePseudoState, TerminateSpecification, Test, TestContainer, Transition, Triggering, TypedPropertyTable, UmlModelElement, Usage, UseCase, UseCaseDependency, UseCaseDiagram, Value, ValuePin, ValueStream, ViewPoint, ViewPointDiagram, WorkPackage
```
public interface MObject
extends java.lang.Comparable<MObject>
```
This interface defines the services available to programmers outside 'vcore' for handling SmObjectImpl instances.
The MObject services are obviously a subset of those provided by SmObjectImpl which is an internal implementation class of vcore.

Author:

phv

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Object`	`accept(MVisitor v)` Accept a visitor.
`void`	`delete()` Delete the object from the model.
`java.util.List<? extends MObject>`	`getCompositionChildren()` Get the child objects in the composition graph.
`MObject`	`getCompositionOwner()` Get the object owning this object in the composition graph.
`MClass`	`getMClass()` Get the object metaclass.
`java.lang.String`	`getName()` Get the object name.
`MStatus`	`getStatus()` Get the object status flags.
`java.lang.String`	`getUuid()` Get the object unique identifier.
`boolean`	`isDeleted()` Tells whether the element is deleted in the model.
`boolean`	`isModifiable()` Tells whether the object can be modified
`boolean`	`isShell()` Tells whether the object is an unresolved reference.
`boolean`	`isValid()` Tells whether the object is usable.
`java.lang.Object`	`mGet(MAttribute att)` Get an attribute value
`java.util.List<MObject>`	`mGet(MDependency dep)` Get the given dependency content as a List.
`void`	`mSet(MAttribute att, java.lang.Object value)` Set an attribute value
`void`	`setName(java.lang.String name)` Set the name of the object.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - accept
```
java.lang.Object accept(MVisitor v)
```
    Accept a visitor.
    The Acyclic Visitor pattern allows new functions to be added to existing class hierarchies without affecting those hierarchies, and without creating the dependency cycles that are inherent to the GangOfFour VisitorPattern
    
    Parameters:
    
    v - a visitor
    
    Returns:
    
    an object returned by the visitor.
    
    See Also:
    
    http://c2.com/cgi/wiki?AcyclicVisitor
  - delete
```
void delete()
```
    Delete the object from the model.
  - getCompositionChildren
```
java.util.List<? extends MObject> getCompositionChildren()
```
    Get the child objects in the composition graph.
    Navigates string composition dependencies and shared composition ones.
    Beware: There are cycles in the composition graph computed using this method.
    To avoid dealing with cycles you can use CompositionGetter.getAllChildren(Collection)
    
    Returns:
    
    the owned objects.
    
    See Also:
    
    CompositionGetter.getAllChildren(java.util.Collection)
  - getCompositionOwner
```
MObject getCompositionOwner()
```
    Get the object owning this object in the composition graph.
    
    Returns:
    
    the owner or null if this object is orphan.
  - getMClass
```
MClass getMClass()
```
    Get the object metaclass.
    
    Returns:
    
    the object metaclass.
  - getName
```
java.lang.String getName()
```
    Get the object name.
    This method must never return null.
    
    Returns:
    
    the name of the object.
  - getStatus
```
MStatus getStatus()
```
    Get the object status flags.
    The status flags tell for example whether the object is visible browsable, modifiable, its CMS state ...
    
    Returns:
    
    the object status.
  - getUuid
```
java.lang.String getUuid()
```
    Get the object unique identifier.
    
    Returns:
    
    the object identifier.
  - isDeleted
```
boolean isDeleted()
```
    Tells whether the element is deleted in the model.
    A deleted object has the following behavior:
    - A deleted object is not modifiable. Trying to modify it will result in an exception.
    - The object attributes are still readable.
    - A deleted object is not visible from its non deleted owner and references, but the deleted object dependencies are still browsable.
    Returns:
    
    true if the element is alive or shell, false if it has been deleted.
    
    See Also:
    
    isShell(), isValid()
  - isModifiable
```
boolean isModifiable()
```
    Tells whether the object can be modified
    
    Returns:
    
    true if the object can be modified else false.
  - isShell
```
boolean isShell()
```
    Tells whether the object is an unresolved reference.
    A shell object is an object that is not present in any known repository but is referenced in another one.
    A shell object has the following behavior:
    - A shell object is not modifiable. Trying to modify it will result in an exception.
    - Only the name of the object has a significant value.
    - Other attributes have a default value and dependencies are empty.
    Browsing a shell object will return empty collections.
    Returns:
    
    true if the object is unresolved, else false.
  - isValid
```
boolean isValid()
```
    Tells whether the object is usable.
    An object is usable if its modeling session and its repository is open and if the object is not deleted nor shell.
    
    Returns:
    
    true if the object is valid else false.
    
    See Also:
    
    isDeleted(), isShell()
  - mGet
```
java.lang.Object mGet(MAttribute att)
```
    Get an attribute value
    
    Parameters:
    
    att - an attribute
    
    Returns:
    
    its value.
  - mGet
```
java.util.List<MObject> mGet(MDependency dep)
```
    Get the given dependency content as a List.
    The returned list reflects the content of the dependency at any moment. Modifying the list will modify the dependency content.
    
    Parameters:
    
    dep - the dependency to get.
    
    Returns:
    
    a reference to its content.
  - mSet
```
void mSet(MAttribute att,
          java.lang.Object value)
```
    Set an attribute value
    
    Parameters:
    
    att - an attribute
    
    value - its new value.
  - setName
```
void setName(java.lang.String name)
```
    Set the name of the object.
    
    Parameters:
    
    name - the name of the object.

Interface MObject

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

accept

delete

getCompositionChildren

getCompositionOwner

getMClass

getName

getStatus

getUuid

isDeleted

isModifiable

isShell

isValid

mGet

mGet

mSet

setName