## Uses of Interface
com.corticon.eclipse.studio.vocabulary.core.IEntity

- Packages that use IEntity
  Package | Description
  --- | ---
  com.corticon.eclipse.studio.rule.rulesheet.core |
  com.corticon.eclipse.studio.rule.rulesheet.table.core |
  com.corticon.eclipse.studio.test.testsheet.treeset.core |
  com.corticon.eclipse.studio.vocabulary.core |
  com.corticon.eclipse.studio.vocabulary.tree.core |

- - ### Uses of IEntity in com.corticon.eclipse.studio.rule.rulesheet.core

    Methods in com.corticon.eclipse.studio.rule.rulesheet.core that return IEntity
    Modifier and Type | Method and Description
    --- | ---
    `IEntity` | IRulesheetModelAPI.`findEntity(java.lang.String astrEntityName)` Given an entity name appearing in the Scope section, return the corresponding IEntity by traversing from Scope to the Vocabulary.

    Methods in com.corticon.eclipse.studio.rule.rulesheet.core with parameters of type IEntity
    Modifier and Type | Method and Description
    --- | ---
    `com.corticon.rulesemf.canonicalrulemodel.rulesheet.LogicalVariable` | IRulesheetModelAPI.`addLogicalVariable(IEntity aIEntity, int aiIndex)` Add a new LogicalVariable instance to the PRuleset.
    `boolean` | IRulesheetModelAPI.`setLogicalVariableQualifier(com.corticon.rulesemf.canonicalrulemodel.rulesheet.LogicalVariable aLogicalVariable, IEntity aIEntity)` Set the Logical Variable qualifier.

  - ### Uses of IEntity in com.corticon.eclipse.studio.rule.rulesheet.table.core

    Methods in com.corticon.eclipse.studio.rule.rulesheet.table.core with parameters of type IEntity
    Modifier and Type | Method and Description
    --- | ---
    `com.corticon.rulesemf.viewrulemodel.rulesheet.decisiontable.ScopeEntity` | IRulesheetTableModelAPI.`addScopeEntity(IEntity aIEntity)` Add a new entity to the Scope section.
    `java.util.List<com.corticon.rulesemf.viewrulemodel.rulesheet.decisiontable.ScopeAlias>` | IRulesheetTableModelAPI.`findAllScopeAlias(IEntity aIEntity, com.corticon.rulesemf.viewrulemodel.rulesheet.decisiontable.ScopeNode aStartNode)`

  - ### Uses of IEntity in com.corticon.eclipse.studio.test.testsheet.treeset.core

    Methods in com.corticon.eclipse.studio.test.testsheet.treeset.core that return IEntity
    Modifier and Type | Method and Description
    --- | ---
    `IEntity` | ITestsheetTreeSetModelAPI.`getTestNodeActualType(com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestNode aTestNode)` Return the IEntity facade representing the actual type for a given TestNode.

    Methods in com.corticon.eclipse.studio.test.testsheet.treeset.core with parameters of type IEntity
    Modifier and Type | Method and Description
    --- | ---
    `com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestAttribute` | ITestsheetTreeSetModelAPI.`addTestAttribute(int aiTreeviewID, com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestNode aTestNode, org.eclipse.emf.ecore.EAttribute aEAttribute, IEntity aIEntity)` Deprecated. Clean up of ModelAPI for EMF parameter objects. Replacing them with Corticon interfaces to conceal EMF behind top layer of our API. This will enable us to change out EMF if ever needed.
    `com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestAttribute` | ITestsheetTreeSetModelAPI.`addTestAttribute(int aiTreeviewID, com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestNode aTestNode, IAttribute aIAttribute, IEntity aIEntity)` Deprecated. No need to supply IEntity, it can be inferred from IAttribute.
    `com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestEntity` | ITestsheetTreeSetModelAPI.`addTestEntity(int aiTreeviewID, IEntity aIEntity)` Add a new entity to the specified test.
    `com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestEntity` | ITestsheetTreeSetModelAPI.`addTestEntityAndAttributes(int aiTreeviewID, IEntity aIEntity)` Add a new entity to the specified test.
    `com.corticon.rulesemf.viewtestmodel.testsheet.treeset.TestEntity` | ITestsheetTreeSetModelAPI.`addTestEntityAndAttributes(int aiTreeviewID, IEntity aIEntity, boolean abDeclaredOnly)` Add a new entity to the specified test.

  - ### Uses of IEntity in com.corticon.eclipse.studio.vocabulary.core

    Fields in com.corticon.eclipse.studio.vocabulary.core declared as IEntity
    Modifier and Type | Field and Description
    --- | ---
    `IEntity` | AssociationParameters.`myTargetEntity` Reference to the target entity of the new association.
    `IEntity` | AssociationParameters.`oppositeTargetEntity` Reference to the source entity of the new association.

    Methods in com.corticon.eclipse.studio.vocabulary.core that return IEntity
    Modifier and Type | Method and Description
    --- | ---
    `IEntity` | IVocabularyModelAPI.`addEntity()` Add a new entity to the Vocabulary.
    `IEntity` | IVocabularyModelAPI.`addEntity(IDomain aIDomain)` Add a new entity to the Vocabulary.
    `IEntity` | IVocabularyModelAPI.`addEntity(IDomain aIDomain, IEntity aIEntitySource)` Add a new entity to the Vocabulary and copy features from the given IEntity Source.
    `IEntity` | IAssociationDialogAPI.`findEntity(java.lang.String astrEntityName)` Find the entity matching the fully-qualified entity name.
    `IEntity` | IVocabularyModelAPI.`findEntity(java.lang.String astrEntityName)` Find first entity matching a given name.
    `IEntity` | IVocabularyModelAPI.`findEntity(java.lang.String astrEntityName, boolean abBase)` Find first entity matching a given name.
    `IEntity` | VocabularyCache.`findEntity(java.lang.String astrEntityName, int aiVocabularyNameCache)`
    `IEntity` | IVocabularyModelAPI.`findXMLEntity(java.lang.String astrXMLEntityName)` Find first entity with a given XML class name.
    `IEntity` | IAssociationDialogAPI.`getEntity()` Return a reference to the parent entity of the association, or in the case of a new association, the entity to which the new association will be added.
    `IEntity` | IAssociationEnd.`getParentEntity()` Return the parent entity.
    `IEntity` | IAttribute.`getParentEntity()` Return the parent entity.
    `IEntity` | IAssociationEnd.`getQualifier()` Getter for qualifier.
    `IEntity` | IAssociationEnd.`getSourceEntity()` Return the source entity.
    `IEntity` | IAssociationEnd.`getTargetEntity()` Return the target entity.

    Methods in com.corticon.eclipse.studio.vocabulary.core with parameters of type IEntity
    Modifier and Type | Method and Description
    --- | ---
    `IAttribute` | IVocabularyModelAPI.`addAttribute(IEntity aIEntity)` Add a new attribute to the specified entity.
    `IAttribute` | IVocabularyModelAPI.`addAttribute(IEntity aIEntity, IAttribute attributeSource, java.lang.String attributeName)` Add a new attribute to the specified entity, copied from the supplied attribute.
    `IEntity` | IVocabularyModelAPI.`addEntity(IDomain aIDomain, IEntity aIEntitySource)` Add a new entity to the Vocabulary and copy features from the given IEntity Source.
    `IAssociationEnd` | IDatabaseMappingAPI.`getAssociationEndFromPrimaryKeyColumnName(IEntity aIEntity, java.lang.String astrColumnName)` Given an IEntity instance and a database column name, use database metadata in an brute-force effort to locate the matching IAssociationEnd instance, if any.
    `AssociationParameters` | IVocabularyModelAPI.`getAssociationParametersNew(IEntity aIEntity)` Returns an AssociationParameters instance populated with default values that are appropriate for a new association.
    `IAttribute` | IDatabaseMappingAPI.`getAttributeFromPrimaryKeyColumnName(IEntity aIEntity, java.lang.String astrColumnName)` Given an IEntity instance and a database column name (part of primary key), use database metadata in a brute-force effort to locate the matching IAttribute, if any.
    `java.lang.String` | IJavaMappingAPI.`getClassName(IEntity aIEntity)` Return the "best matching" class name for a given entity considering the entity and the best possible match on package name (if explicitly specified).
    `java.lang.String` | IJavaMappingAPI.`getClassNameSmartMatch(IEntity aIEntity)` Given an entity, determine the best matching class name from the metadata if available.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentityColumnName(IEntity aIEntity)` Given an entity, returns the datastore identity column name if specified, or a default name if none is specified.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentitySequence(IEntity aIEntity)` Given an entity, returns the datastore identity sequence name if specified, or a default name if none is specified.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentitySequenceNameColumnName(IEntity aIEntity)` Given an entity, returns the datastore identity sequence name column name if specified, or a default name if none is specified.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentitySequenceNextvalColumnName(IEntity aIEntity)` Given an entity, returns the datastore identity sequence nextval column name if specified, or a default name if none is specified.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentitySequenceTableName(IEntity aIEntity)` Given an entity, returns the datastore identity sequence table name if specified, or a default name if none is specified.
    `java.lang.String` | IDatabaseMappingAPI.`getDatastoreIdentityStrategy(IEntity aIEntity)` Given an entity, returns the datastore identity strategy if specified, or a default name if none is specified.
    `java.lang.String` | IVocabularyModelAPI.`getDefaultIdentityStrategy(IEntity aIEntity)` Return a default identity strategy for a given entity
    `java.lang.String` | IVocabularyModelAPI.`getDefaultIdentityStrategyType(IEntity aIEntity)` Return a default identity strategy type for a given entity
    `java.util.List` | IDatabaseMappingAPI.`getEntityIdentityForEntity(IEntity aIEntity)` Given an entity, return the effective Entity Identity set taking into account a user specified value or a default derived from database metadata.
    `java.util.List` | IDatabaseMappingAPI.`getEntityIdentitySmartMatch(IEntity aIEntity)` Infer and return the entity identity from database metadata for the specified IEntity instance.
    `int` | VocabularyCache.`getEntityNameCount(IEntity aIEntity, int aiVocabularyNameCache)` Return the count of the number of times the specified unqualified entity name appears in the Vocabulary.
    `java.util.List` | IVocabularyModelAPI.`getListEntityIdentity(IEntity aIEntity)` Return a list of items needed to populate the entity identity combo box.
    `java.util.List` | IVocabularyModelAPI.`getListEntityIdentity(IEntity aIEntity, boolean abBase)` Return a list of items needed to populate the entity identity combo box.
    `java.lang.String` | IVocabularyModelAPI.`getNewAttributeName(IEntity aIEntity)` Return a guaranteed-unique attribute name of the form Attribute_ where is a sequence number (starting with 1).
    `java.lang.String` | IAssociationDialogAPI.`getNewRoleName(IEntity aIEntitySource, IEntity aIEntityTarget)` Return a guaranteed-unique role name.
    `java.lang.String` | IVocabularyModelAPI.`getNewRoleName(IEntity aIEntitySource, IEntity aIEntityTarget)` Return a guaranteed-unique role name.
    `java.lang.String` | IVocabularyModelAPI.`getNextAvailableAttributeName(IEntity aIEntity, java.lang.String astrAttributeName)` This method will take in the astrAttributeName that is passed in and verify that it is unique in this Entity.
    `java.lang.String` | IVocabularyModelAPI.`getNextAvailableConvertedAttributeName(IEntity aIEntity, java.lang.String astrAttributeName)` This method will take in the astrAttributeName and call into getConvertedAttributeName(String) and getNextAvailableAttributeName(IEntity, String) for the name that was passed into this method.
    `java.lang.String` | IVocabularyModelAPI.`getNextAvailableConvertedRoleName(IEntity aIEntitySource, IEntity aIEntityTarget, java.lang.String astrRoleName)` This method will take in the astrRoleName and call into getConvertedRoleName(String) and getNextAvailableRoleName(IEntity, IEntity, String) for the passed in role name.
    `java.lang.String` | IVocabularyModelAPI.`getNextAvailableRoleName(IEntity aIEntitySource, IEntity aIEntityTarget, java.lang.String astrRoleName)` This method will take in the astrRoleName that is passed in and verify that it is unique within a passed in source entity.
    `java.lang.String` | IJavaMappingAPI.`getObjectSetMethodTypeForSpecificAssociationSetMethodName(IEntity aIEntity, java.lang.String astrSetMethodName)` This will look up the datatype based on the IEntity's associated Java Class and the specified Setter Method
    `java.lang.String` | IJavaMappingAPI.`getObjectSetMethodTypeForSpecificAttributeSetMethodName(IEntity aIEntity, java.lang.String astrSetMethodName)` This will look up the datatype based on the IEntity's associated Java Class and the specified Setter Method
    `java.lang.String` | IJavaMappingAPI.`getPackageName(IEntity aIEntity)` Return the "best matching" Package name for a given entity considering the entity, the class name and the package name (if explicitly specified).
    `java.lang.String` | IJavaMappingAPI.`getPackageNameSmartMatch(IEntity aIEntity)` Given an entity, determine the best matching package name from the metadata if available.
    `java.lang.String` | IDatabaseMappingAPI.`getTableNameForEntity(IEntity aIEntity)` Return the "best matching" fully-qualified table name for a given entity considering the entity, the class name and the table name (if explicitly specified).
    `java.lang.String` | IDatabaseMappingAPI.`getTableNameSmartMatch(IEntity aIEntity)` Given an entity, determine the best matching table name from the metadata if available.
    `java.lang.String` | IDatabaseMappingAPI.`getVersionColumn(IEntity aIEntity)` Given an entity, returns the version column name if specified, or a default name if none is specified.
    `java.lang.String` | IVocabularyModelAPI.`getVocabularyDomainHierarchy(IEntity aIEntity)` Given an IEntity, return a localized Vocabulary domain hierarchy for that entity.
    `java.lang.String` | IVocabularyModelAPI.`getVocabularyElementSuffix(IEntity aIEntity, boolean abAssociationFormat, boolean abBase)` Return the appropriate localized suffix for a given Vocabulary entity.
    `boolean` | IVocabularyModelAPI.`isInheritedFeature(IEntity aIEntity, IElement aIElementFeature)` Returns `true` if the given Vocabulary element (attribute or association) is an inherited feature of the specified entity.
    `boolean` | IEntity.`isInstance(IEntity aIEntity)` Return `true` if the specified argument is an instance of this entity (i.e., either the same as this entity or a direct or indirect descendent entity).
    `boolean` | IVocabularyModelAPI.`isRoleNameUsed(IEntity aIEntity, java.lang.String astrRoleName)` Determine whether the specified role name is currently in use within the specified Entity.
    `boolean` | IDatabaseMetadataAPI.`isSequence(IEntity aEntity, java.lang.String astrName)` Determine whether the specified name is a database sequence.
    `boolean` | IEntity.`isSubtype(IEntity aIEntity)` Return `true` if the specified argument is a direct or indirect subtype of this entity.
    `boolean` | IEntity.`isSupertype(IEntity aIEntity)` Return `true` if the specified argument is a direct or indirect supertype of this entity.
    `boolean` | IDatabaseMappingAPI.`isTable(IEntity aIEntity)` Determine whether the specified entity is mapped to a database table.
    `boolean` | IDatabaseMappingAPI.`isView(IEntity aIEntity)` Determine whether the specified entity is mapped to a database view.
    `boolean` | IVocabularyModelAPI.`isVocabularyEntityNameUnique(IEntity aIEntity, boolean abBase)` Determine whether the name of the specified entity would be ambiguous if it were not for its domain qualification (i.e., the unqualified entity name is used by more than one Vocabulary entity).
    `void` | IAssociationDialogAPI.`setEntity(IEntity aIEntity)` Set a reference to the entity, the parent of the association, or in the case of a new association, the entity to which the new association will be added.
    `boolean` | IVocabularyModelAPI.`setEntityClassTable(IEntity aIEntity, java.lang.String astrValue)` Set Entity class:table property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreCaching(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore caching indicator.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentityColumn(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:column property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentitySequence(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:sequence property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentitySequenceNameColumnName(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:sequence-name-column-name property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentitySequenceNextvalColumnName(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:sequence-nextval-column-name property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentitySequenceTableName(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:sequence-table-name property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastoreIdentityStrategy(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-identity:strategy property.
    `boolean` | IVocabularyModelAPI.`setEntityDatastorePersistent(IEntity aIEntity, java.lang.String astrValue)` Set Entity datastore-persistent indicator.
    `boolean` | IVocabularyModelAPI.`setEntityIdentity(IEntity aIEntity, java.lang.String astrValue)` Set Entity Identity.
    `boolean` | IVocabularyModelAPI.`setEntityJavaClassName(IEntity aIEntity, java.lang.String astrValue)` Set Entity Java Class name.
    `boolean` | IVocabularyModelAPI.`setEntityJavaPackage(IEntity aIEntity, java.lang.String astrValue)` Set Entity Java Package.
    `boolean` | IVocabularyModelAPI.`setEntityName(IEntity aIEntity, java.lang.String astrValue)` Set Entity name.
    `boolean` | IVocabularyModelAPI.`setEntitySupertypes(IEntity aIEntity, java.util.List aListEntities)` Set Entity Supertype(s) given a list of IEntity facades.
    `boolean` | IVocabularyModelAPI.`setEntitySupertypes(IEntity aIEntity, java.lang.String astrValue)` Set Entity Supertype(s).
    `boolean` | IVocabularyModelAPI.`setEntityVersionColumn(IEntity aIEntity, java.lang.String astrValue)` Set Entity version:column property.
    `boolean` | IVocabularyModelAPI.`setEntityVersionStrategy(IEntity aIEntity, java.lang.String astrValue)` Set Entity version:strategy property.
    `boolean` | IVocabularyModelAPI.`setEntityXMLClassName(IEntity aIEntity, java.lang.String astrValue)` Set Entity XML Class name.
    `boolean` | IVocabularyModelAPI.`setEntityXMLNamespace(IEntity aIEntity, java.lang.String astrValue)` Set Entity XML Namespace.
    `void` | IAssociationEnd.`setQualifier(IEntity aIEntityQualifier)` Setter for qualifier.

  - ### Uses of IEntity in com.corticon.eclipse.studio.vocabulary.tree.core

    Methods in com.corticon.eclipse.studio.vocabulary.tree.core with parameters of type IEntity
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | IVocabularyTreeModelAPI.`getEntityIdentity(IEntity aIEntity, boolean abBase)` Given an IEntity, return a list of the entity's identity attributes in standard set notation.
    `java.lang.String` | IVocabularyTreeModelAPI.`getEntitySupertypes(IEntity aIEntity, boolean abBase)` Given an IEntity, return a list of the entity's supertypes in standard set notation.

Copyright © 2005-2013 Progress Software Corporation and/or its subsidiaries and affiliates. All rights reserved.