public interface IAnalystModel
 Add the requirement containers and dictionaries can be accessed using this class.
 To get the current requirement model, please do as following:
 
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 
 IAnalystModel = session.getRequirementModel();
 
This requirement model is accessible only if the Requirement MDAC is deployed in the project.
| Modifier and Type | Field and Description | 
|---|---|
static java.lang.String | 
BUSINESS_RULE_CONTAINER_STEREOTYPE
The name of the stereotype defining a Business Rule Container. 
 | 
static java.lang.String | 
BUSINESS_RULE_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Business Rule Diagram. 
 | 
static java.lang.String | 
BUSINESS_RULE_PropertyTableDefinition_STEREOTYPE
The name of the stereotype defining a Business Rule PropertyTableDefinition. 
 | 
static java.lang.String | 
BUSINESS_RULE_STEREOTYPE
The name of the stereotype defining a Business Rule. 
 | 
static java.lang.String | 
DICTIONARY_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Dictionary Diagram. 
 | 
static java.lang.String | 
GOAL_CONTAINER_STEREOTYPE
The name of the stereotype defining a Goal Container. 
 | 
static java.lang.String | 
GOAL_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Goal Diagram. 
 | 
static java.lang.String | 
GOAL_PropertyTableDefinition_STEREOTYPE
The name of the stereotype defining a Goal PropertyTableDefinition. 
 | 
static java.lang.String | 
GOAL_STEREOTYPE
The name of the stereotype defining a Goal. 
 | 
static java.lang.String | 
REQUIREMENT_CONTAINER_STEREOTYPE
The name of the stereotype defining a Requirement Container. 
 | 
static java.lang.String | 
REQUIREMENT_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Requirement Diagram. 
 | 
static java.lang.String | 
REQUIREMENT_PropertyTableDefinition_STEREOTYPE
The name of the stereotype defining a Requirement PropertyTableDefinition. 
 | 
static java.lang.String | 
REQUIREMENT_STEREOTYPE
The name of the stereotype defining a Requirement. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
addPropertySet(PropertyTableDefinition set)
Add a new property set in the requirement administration model. 
 | 
void | 
addPropertyType(PropertyType type)
Add a new property type in the requirement admin model. 
 | 
BusinessRule | 
createBusinessRule()
Create a new BusinessRule without container. 
The returned BusinessRule has to be added in the BusinessRule hierarchy.  | 
BusinessRule | 
createBusinessRule(java.lang.String name,
                  BusinessRule owner)
Create a new BusinessRule without container. 
The returned BusinessRule has to be added in the BusinessRule hierarchy.  | 
BusinessRule | 
createBusinessRule(java.lang.String name,
                  BusinessRuleContainer owner)
Create a new BusinessRule without container. 
The returned BusinessRule has to be added in the BusinessRule hierarchy.  | 
BusinessRuleContainer | 
createBusinessRuleContainer()
Create a new BusinessRule container without container. 
The returned BusinessRule container has to be added in the BusinessRule hierarchy.  | 
BusinessRuleContainer | 
createBusinessRuleContainer(java.lang.String name,
                           BusinessRuleContainer owner)
Create a new BusinessRule container without container. 
The returned BusinessRule container has to be added in the BusinessRule hierarchy.  | 
Dictionary | 
createDictionary()
Create a new dictionary without container. 
The returned dictionary has to be added in the dictionary hierarchy.  | 
Dictionary | 
createDictionary(java.lang.String name,
                Dictionary owner)
Create a new dictionary without container. 
The returned dictionary has to be added in the dictionary hierarchy.  | 
EnumeratedPropertyType | 
createEnumeratedPropertyType()
Create a new enumerated property type. 
The returned property type has to be added in the admin requirement model, using the addPropertyType(PropertyType) method. | 
Goal | 
createGoal()
Create a new goal without container. 
The returned goal has to be added in the goal hierarchy.  | 
Goal | 
createGoal(java.lang.String name,
          Goal owner)
Create a new goal without container. 
The returned goal has to be added in the goal hierarchy.  | 
Goal | 
createGoal(java.lang.String name,
          GoalContainer owner)
Create a new goal without container. 
The returned goal has to be added in the goal hierarchy.  | 
GoalContainer | 
createGoalContainer()
Create a new goal container without container. 
The returned goal container has to be added in the goal hierarchy.  | 
GoalContainer | 
createGoalContainer(java.lang.String name,
                   GoalContainer owner)
Create a new goal container without container. 
The returned goal container has to be added in the goal hierarchy.  | 
KPI | 
createKPI()
Create a new KPI without container. 
The returned KPI has to be added in the KPI container hierarchy.  | 
KPI | 
createKPI(java.lang.String name,
         KPI owner)
Create a new KPI without container. 
The returned KPI has to be added in the KPI container hierarchy.  | 
KPI | 
createKPI(java.lang.String name,
         KPIContainer owner)
Create a new KPI without container. 
The returned KPI has to be added in the KPI container hierarchy.  | 
KPIContainer | 
createKPIContainer()
Create a new KPI container without container. 
The returned KPI container has to be added in the KPI container hierarchy.  | 
KPIContainer | 
createKPIContainer(java.lang.String name,
                  KPIContainer owner)
Create a new KPI container without container. 
The returned KPI container has to be added in the KPI container hierarchy.  | 
PropertyDefinition | 
createProperty()
Create a new property. 
The returned property has to be added to a property set, defined in the admin requirement model, using the PropertyTableDefinition.getOwned() | 
PropertyEnumerationLitteral | 
createPropertyEnumerationLitteral()
Create a new enumeration litteral for the enumerated property type. 
The returned enumeration litteral has to be added to a enumerated property type.  | 
PropertyTableDefinition | 
createPropertySet()
Create a new property set. 
The returned property set has to be added to the admin requirement model, using the addPropertySet(PropertyTableDefinition) method. | 
AnalystPropertyTable | 
createPropertyTable()
Create a new property value set. 
The returned property value set has to be defined on the following elements: RequirementContainer, Requirement, Dictionary, Term.  | 
PropertyType | 
createPropertyType()
Create a new simple property type. 
The returned property type has to be added to the admin requirement model, using the addPropertyType(PropertyType) method. | 
Requirement | 
createRequirement()
Create a new requirement without container. 
The returned requirement has to be added in the requirement container hierarchy.  | 
Requirement | 
createRequirement(java.lang.String name,
                 Requirement owner)
Create a new requirement without container. 
The returned requirement has to be added in the requirement container hierarchy.  | 
Requirement | 
createRequirement(java.lang.String name,
                 RequirementContainer owner)
Create a new requirement without container. 
The returned requirement has to be added in the requirement container hierarchy.  | 
RequirementContainer | 
createRequirementContainer()
Create a new requirement container without container. 
The returned requirement container has to be added in the requirement container hierarchy.  | 
RequirementContainer | 
createRequirementContainer(java.lang.String name,
                          RequirementContainer owner)
Create a new requirement container without container. 
The returned requirement container has to be added in the requirement container hierarchy.  | 
Risk | 
createRisk()
Create a new risk without container. 
The returned risk has to be added in the risk container hierarchy.  | 
Risk | 
createRisk(java.lang.String name,
          Risk owner)
Create a new risk without container. 
The returned risk has to be added in the risk container hierarchy.  | 
Risk | 
createRisk(java.lang.String name,
          RiskContainer owner)
Create a new risk without container. 
The returned risk has to be added in the risk container hierarchy.  | 
RiskContainer | 
createRiskContainer()
Create a new risk container without container. 
The returned risk container has to be added in the risk container hierarchy.  | 
RiskContainer | 
createRiskContainer(java.lang.String name,
                   RiskContainer owner)
Create a new risk container without container. 
The returned risk container has to be added in the risk container hierarchy.  | 
Term | 
createTerm()
Create a new term without container. 
The returned term has to be added in the dictionary hierarchy.  | 
Term | 
createTerm(java.lang.String name,
          Dictionary owner)
Create a new term without container. 
The returned term has to be added in the dictionary hierarchy.  | 
Test | 
createTest()
Create a new test without container. 
The returned test has to be added in the test container hierarchy.  | 
Test | 
createTest(java.lang.String name,
          Test owner)
Create a new test without container. 
The returned test has to be added in the test container hierarchy.  | 
Test | 
createTest(java.lang.String name,
          TestContainer owner)
Create a new test without container. 
The returned test has to be added in the test container hierarchy.  | 
TestContainer | 
createTestContainer()
Create a new test container without container. 
The returned test container has to be added in the test container hierarchy.  | 
TestContainer | 
createTestContainer(java.lang.String name,
                   TestContainer owner)
Create a new test container without container. 
The returned test container has to be added in the test container hierarchy.  | 
java.util.List<PropertyTableDefinition> | 
getPropertySets()
Get the list of known property sets. 
 | 
java.util.List<PropertyType> | 
getPropertyTypes()
Get the list of known property types. 
 | 
java.util.List<BusinessRuleContainer> | 
getRootBusinessRuleContainer()
Get the main business rules container that owns the business rules elements. 
The requirement elements are the business rules containers and business rules.  | 
java.util.List<Dictionary> | 
getRootDictionary()
Get the main dictionary that owns the sub dictionaries and terms. 
 | 
java.util.List<GoalContainer> | 
getRootGoalContainer()
Get the main goal container that owns the goal elements. 
The requirement elements are the goal containers and goals.  | 
java.util.List<RequirementContainer> | 
getRootRequirementContainer()
Get the main requirement container that owns the requirement elements. 
The requirement elements are the requirement containers and requirements.  | 
void | 
removePropertySet(PropertyTableDefinition set)
Remove an existing property set from the requirement administration model. 
 | 
void | 
removePropertyType(PropertyType type)
Remove an existing property type from the requirement administration model. 
 | 
static final java.lang.String BUSINESS_RULE_CONTAINER_STEREOTYPE
static final java.lang.String BUSINESS_RULE_DIAGRAM_STEREOTYPE
static final java.lang.String BUSINESS_RULE_PropertyTableDefinition_STEREOTYPE
static final java.lang.String BUSINESS_RULE_STEREOTYPE
static final java.lang.String DICTIONARY_DIAGRAM_STEREOTYPE
static final java.lang.String GOAL_CONTAINER_STEREOTYPE
static final java.lang.String GOAL_DIAGRAM_STEREOTYPE
static final java.lang.String GOAL_PropertyTableDefinition_STEREOTYPE
static final java.lang.String GOAL_STEREOTYPE
static final java.lang.String REQUIREMENT_CONTAINER_STEREOTYPE
static final java.lang.String REQUIREMENT_DIAGRAM_STEREOTYPE
static final java.lang.String REQUIREMENT_PropertyTableDefinition_STEREOTYPE
static final java.lang.String REQUIREMENT_STEREOTYPE
void addPropertySet(PropertyTableDefinition set)
 New property sets can be created, using the createPropertySet() method and can added to this model through the use of this method.
set - property setremovePropertySet(PropertyTableDefinition)void addPropertyType(PropertyType type)
 New property types can be created, using the createPropertyType() method and can added to this model through the use of this method.
type - property typeremovePropertyType(PropertyType)BusinessRule createBusinessRule()
BusinessRule createBusinessRule(java.lang.String name, BusinessRule owner)
name - the new element's name.owner - the new element's composition owner.BusinessRule createBusinessRule(java.lang.String name, BusinessRuleContainer owner)
name - the new element's name.owner - the new element's composition owner.BusinessRuleContainer createBusinessRuleContainer()
BusinessRuleContainer createBusinessRuleContainer(java.lang.String name, BusinessRuleContainer owner)
name - the new element's name.owner - the new element's composition owner.Dictionary createDictionary()
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 Dictionary root = model.getRootDictionary();
 
 Dictionary newDictionary = model.createDictionary();
 newDictionary.setName ("dic1");
 root.addOwned (newDictionary);
 
Dictionary createDictionary(java.lang.String name, Dictionary owner)
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 Dictionary root = model.getRootDictionary();
 
 Dictionary newDictionary = model.createDictionary();
 newDictionary.setName ("dic1");
 root.addOwned (newDictionary);
 
name - the new element's name.owner - the new element's composition owner.EnumeratedPropertyType createEnumeratedPropertyType()
addPropertyType(PropertyType) method.addPropertyType(PropertyType)Goal createGoal()
Goal createGoal(java.lang.String name, GoalContainer owner)
name - the new element's name.owner - the new element's composition owner.Goal createGoal(java.lang.String name, Goal owner)
name - the new element's name.owner - the new element's composition owner.GoalContainer createGoalContainer()
GoalContainer createGoalContainer(java.lang.String name, GoalContainer owner)
name - the new element's name.owner - the new element's composition owner.PropertyDefinition createProperty()
PropertyTableDefinition.getOwned()PropertyTableDefinition.getOwned()PropertyEnumerationLitteral createPropertyEnumerationLitteral()
EnumeratedPropertyType.getLitteral()PropertyTableDefinition createPropertySet()
addPropertySet(PropertyTableDefinition) method.addPropertySet(PropertyTableDefinition)AnalystPropertyTable createPropertyTable()
AnalystItem.setAnalystProperties(AnalystPropertyTable)PropertyType createPropertyType()
addPropertyType(PropertyType) method.addPropertyType(PropertyType)Requirement createRequirement()
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 RequirementContainer root = model.getRootContainer();
 
 Requirement newRequirement = model.createRequirement();
 newRequirement.setName ("req1");
 newRequirement.setText ("All the methods have to be documented");
 root.addOwned (newRequirement);
 
Requirement createRequirement(java.lang.String name, Requirement owner)
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 RequirementContainer root = model.getRootContainer();
 
 Requirement newRequirement = model.createRequirement();
 newRequirement.setName ("req1");
 newRequirement.setText ("All the methods have to be documented");
 root.addOwned (newRequirement);
 
name - the new element's name.owner - the new element's composition owner.Requirement createRequirement(java.lang.String name, RequirementContainer owner)
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 RequirementContainer root = model.getRootContainer();
 
 Requirement newRequirement = model.createRequirement();
 newRequirement.setName ("req1");
 newRequirement.setText ("All the methods have to be documented");
 root.addOwned (newRequirement);
 
name - the new element's name.owner - the new element's composition owner.RequirementContainer createRequirementContainer()
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 RequirementContainer root = model.getRootContainer();
 
 RequirementContainer newRequirementContainer = model.createRequirement();
 newRequirementContainer.setName ("functional requirements");
 root.addOwned (newRequirementContainer);
 
RequirementContainer createRequirementContainer(java.lang.String name, RequirementContainer owner)
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 RequirementContainer root = model.getRootContainer();
 
 RequirementContainer newRequirementContainer = model.createRequirement();
 newRequirementContainer.setName ("functional requirements");
 root.addOwned (newRequirementContainer);
 
name - the new element's name.owner - the new element's composition owner.Term createTerm()
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 Dictionary root = model.getRootDictionary();
 
 Term newTerm = model.createRequirement();
 newTerm.setName ("system");
 newTerm.setDefinition ("The system is the place where the program should run");
 root.addOwned (newTerm);
 
Term createTerm(java.lang.String name, Dictionary owner)
 
 IModelingSession session = Modelio.getInstance().getModelingSession();
 IAnalystModel model = session.getRequirementModel();
 Dictionary root = model.getRootDictionary();
 
 Term newTerm = model.createRequirement();
 newTerm.setName ("system");
 newTerm.setDefinition ("The system is the place where the program should run");
 root.addOwned (newTerm);
 
name - the new element's name.owner - the new element's composition owner.java.util.List<PropertyTableDefinition> getPropertySets()
Default property sets already exist and can be extended by the user. This method permits to return the list of known property sets.
java.util.List<PropertyType> getPropertyTypes()
Default property types already exist and can be extended by the user. This method permits to return the list of known property types.
java.util.List<BusinessRuleContainer> getRootBusinessRuleContainer()
java.util.List<Dictionary> getRootDictionary()
java.util.List<GoalContainer> getRootGoalContainer()
java.util.List<RequirementContainer> getRootRequirementContainer()
void removePropertySet(PropertyTableDefinition set)
set - property setaddPropertySet(PropertyTableDefinition)void removePropertyType(PropertyType type)
type - property typeaddPropertyType(PropertyType)Risk createRisk()
Risk createRisk(java.lang.String name, Risk owner)
name - the new element's name.owner - the new element's composition owner.Risk createRisk(java.lang.String name, RiskContainer owner)
name - the new element's name.owner - the new element's composition owner.RiskContainer createRiskContainer()
RiskContainer createRiskContainer(java.lang.String name, RiskContainer owner)
name - the new element's name.owner - the new element's composition owner.Test createTest()
Test createTest(java.lang.String name, Test owner)
name - the new element's name.owner - the new element's composition owner.Test createTest(java.lang.String name, TestContainer owner)
name - the new element's name.owner - the new element's composition owner.TestContainer createTestContainer()
TestContainer createTestContainer(java.lang.String name, TestContainer owner)
name - the new element's name.owner - the new element's composition owner.KPI createKPI(java.lang.String name, KPI owner)
name - the new element's name.owner - the new element's composition owner.KPI createKPI(java.lang.String name, KPIContainer owner)
name - the new element's name.owner - the new element's composition owner.KPI createKPI()
KPIContainer createKPIContainer(java.lang.String name, KPIContainer owner)
name - the new element's name.owner - the new element's composition owner.KPIContainer createKPIContainer()