com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel
Interface Entity

All Superinterfaces:

ModelElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject

public interface Entity

extends ModelElement

Entity object instance interface.

Method Summary

Attribute	findAttribute(java.lang.String pAttributeName) Looks for the Attribute with the given name only in this Entity.
Attribute	findCombinedAttribute(java.lang.String pAttributeName) Looks for the Attribute with the given name in this Entity and supertype Entities.
AssociationRole	findCombinedReference(java.lang.String pReferenceName) Looks for the Reference with the given name in this Entity and supertype Entities.
Selector	findCombinedSelector(java.lang.String pSelectorName) Looks for the Selector with the given name in this Entity and supertype Entities.
ModelElementConstraint	findConstraint(java.lang.String pConstraintName) Looks for the Constraint with the given name only in this Entity.
AssociationRole	findReference(java.lang.String pReferenceName) Looks for the Reference with the given name only in this Entity.
Selector	findSelector(java.lang.String pSelectorName) Looks for the selector with the given name.
java.util.Collection	getAgregatedManyToManyReferences() Returns all references, which are parts of many-to-many association and where this entity is the aggregator.
Attribute	getAttribute(java.lang.String pAttributeName) Looks for the Attribute with the given name only in this Entity.
java.util.Collection	getAttributes() Returns the value of reference attributes.
java.util.Collection	getAttributesUsedForOrdering() Retrieves read only collection of attributes which this entity can be orderd by.
DataType	getCollectionContainsFlagDataType() Returns the value of reference collectionContainsFlagDataType.
DataType	getCollectionEmptyFlagDataType() Returns the value of reference collectionEmptyFlagDataType.
DataType	getCollectionOffsetDataType() Returns the value of reference collectionOffsetDataType.
DataType	getCollectionSizeDataType() Returns the value of reference collectionSizeDataType.
java.util.Collection	getCombinedAgregatedManyToManyReferences() Returns all references, which are parts of many-to-many association and where this entity is the aggregator.
java.util.Collection	getCombinedAttributes()
java.util.Collection	getCombinedAttributesUsedForOrdering() Retrieves read only collection of attributes which this entity can be orderd by.
java.util.Collection	getCombinedConstraints() Returns all Constraints in this Entity and all subentities
java.util.Collection	getCombinedReferences() Returns all referenced roles in this entity and all subentities.
java.util.Collection	getCombinedRoles() Returns all roles played by this entity and all subentities.
java.util.Collection	getCombinedSubtypes()
java.util.Collection	getCombinedTypes() Returns list of DataTypes, Structures and Messages used in the Entity.
ModelElementConstraint	getConstraint(java.lang.String pConstraintName) Looks for the Constraint with the given name only in this Entity.
java.util.List	getConstraints() Returns the value of reference constraints.
Domain	getDomain() Returns the value of reference domain.
java.util.Collection	getEntityStateDiagrams() Returns the value of reference entityStateDiagrams.
java.lang.String	getInstanceIdAttributeNameOverride() Returns the value of attribute instanceIdAttributeNameOverride.
DataType	getInstanceIdDataType() Returns the value of reference instanceIdDataType.
DataType	getOrderingInstructionDataType() Returns the value of reference orderingInstructionDataType.
AssociationRole	getOwnerReference()
java.lang.String	getPluralName() Returns the value of attribute pluralName.
java.util.Collection	getPrimaryKeyElements() Returns the value of reference primaryKeyElements.
AssociationRole	getReference(java.lang.String pReferenceName) Looks for the Reference with the given name only in this Entity.
java.util.Collection	getReferences()
java.util.Collection	getRelationalTableDefinitions() Returns the value of reference relationalTableDefinitions.
java.util.Collection	getReportOutputsUsingEntity() Returns the value of reference reportOutputsUsingEntity.
java.util.Collection	getRoles() Returns the value of reference roles.
Selector	getSelector(java.lang.String pSelectorName) Looks for the Selector with the given name only in this Entity.
java.util.Collection	getSelectors() Returns the value of reference selectors.
java.lang.String	getStateAttributeNameOverride() Returns the value of attribute stateAttributeNameOverride.
DataType	getStateDataType() Returns the value of reference stateDataType.
StateMachine	getStateMachine() Returns the value of reference stateMachine.
EntityStereotype	getStereotype() Returns the value of attribute stereotype.
DataType	getSubsetSizeDataType() Returns the value of reference subsetSizeDataType.
java.util.Collection	getSubtypes() Returns the value of reference subtypes.
Entity	getSupertype() Returns the value of reference supertype.
java.lang.String	getVersionIdAttributeNameOverride() Returns the value of attribute versionIdAttributeNameOverride.
DataType	getVersionIdDataType() Returns the value of reference versionIdDataType.
boolean	isAbstract() Returns the value of attribute isAbstract.
boolean	isFinal() Returns the value of attribute isFinal.
boolean	isModifiable()
void	setAbstract(boolean newValue) Sets the value of isAbstract attribute.
void	setCollectionContainsFlagDataType(DataType newValue) Sets the value of reference collectionContainsFlagDataType.
void	setCollectionEmptyFlagDataType(DataType newValue) Sets the value of reference collectionEmptyFlagDataType.
void	setCollectionOffsetDataType(DataType newValue) Sets the value of reference collectionOffsetDataType.
void	setCollectionSizeDataType(DataType newValue) Sets the value of reference collectionSizeDataType.
void	setDomain(Domain newValue) Sets the value of reference domain.
void	setFinal(boolean newValue) Sets the value of isFinal attribute.
void	setInstanceIdAttributeNameOverride(java.lang.String newValue) Sets the value of instanceIdAttributeNameOverride attribute.
void	setInstanceIdDataType(DataType newValue) Sets the value of reference instanceIdDataType.
void	setOrderingInstructionDataType(DataType newValue) Sets the value of reference orderingInstructionDataType.
void	setPluralName(java.lang.String newValue) Sets the value of pluralName attribute.
void	setStateAttributeNameOverride(java.lang.String newValue) Sets the value of stateAttributeNameOverride attribute.
void	setStateDataType(DataType newValue) Sets the value of reference stateDataType.
void	setStateMachine(StateMachine newValue) Sets the value of reference stateMachine.
void	setStereotype(EntityStereotype newValue) Sets the value of stereotype attribute.
void	setSubsetSizeDataType(DataType newValue) Sets the value of reference subsetSizeDataType.
void	setSupertype(Entity newValue) Sets the value of reference supertype.
void	setVersionIdAttributeNameOverride(java.lang.String newValue) Sets the value of versionIdAttributeNameOverride attribute.
void	setVersionIdDataType(DataType newValue) Sets the value of reference versionIdDataType.

Methods inherited from interface com.metaboss.sdlctools.models.metabossmodel.ModelElement

findAttachment, getAttachment, getAttachments, getCombinedContents, getContents, getDescription, getDiagramModelElements, getName, getOwnerIdentifier, getRef, getReferencedElements, getTags, isContainedWithin, isDerived, mayContain, mayContainWithin, setDescription, setName, setOwnerIdentifier

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

isModifiable

public boolean isModifiable()

Returns:

getOwnerReference

public AssociationRole getOwnerReference()

Returns:

getCombinedReferences

public java.util.Collection getCombinedReferences()

Returns all referenced roles in this entity and all subentities.

Returns:

Returns all referenced roles in this entity and all subentities.

getCombinedSubtypes

public java.util.Collection getCombinedSubtypes()

Returns:

getAgregatedManyToManyReferences

public java.util.Collection getAgregatedManyToManyReferences()

Returns all references, which are parts of many-to-many association and where this entity is the aggregator. Only concerned with this entity and not any super entities.

Returns:

Returns all references, which are parts of many-to-many association and where this entity is the aggregator. Only concerned with this entity and not any super entities.

getAttributesUsedForOrdering

public java.util.Collection getAttributesUsedForOrdering()

Retrieves read only collection of attributes which this entity can be orderd by. Includes only attributes from this entity and excludes all attributes from supertypes.

Returns:

Retrieves read only collection of attributes which this entity can be orderd by. Includes only attributes from this entity and excludes all attributes from supertypes.

getAttribute

public Attribute getAttribute(java.lang.String pAttributeName)

Looks for the Attribute with the given name only in this Entity. Returns the Attribute or throws exception if none found.

Parameters:

pAttributeName -

Returns:

Looks for the Attribute with the given name only in this Entity. Returns the Attribute or throws exception if none found.

findAttribute

public Attribute findAttribute(java.lang.String pAttributeName)

Looks for the Attribute with the given name only in this Entity. Returns the Attribute or null if none found.

Parameters:

pAttributeName -

Returns:

Looks for the Attribute with the given name only in this Entity. Returns the Attribute or null if none found.

findCombinedAttribute

public Attribute findCombinedAttribute(java.lang.String pAttributeName)

Looks for the Attribute with the given name in this Entity and supertype Entities. Returns the Attribute or null if none found.

Parameters:

pAttributeName -

Returns:

Looks for the Attribute with the given name in this Entity and supertype Entities. Returns the Attribute or null if none found.

getSelector

public Selector getSelector(java.lang.String pSelectorName)

Looks for the Selector with the given name only in this Entity. Returns the Selector or throws exception if none found.

Parameters:

pSelectorName -

Returns:

Looks for the Selector with the given name only in this Entity. Returns the Selector or throws exception if none found.

findSelector

public Selector findSelector(java.lang.String pSelectorName)

Looks for the selector with the given name. Returns the selector or null if none found.

Parameters:

pSelectorName -

Returns:

Looks for the selector with the given name. Returns the selector or null if none found.

findCombinedSelector

public Selector findCombinedSelector(java.lang.String pSelectorName)

Looks for the Selector with the given name in this Entity and supertype Entities. Returns the Selector or null if none found.

Parameters:

pSelectorName -

Returns:

Looks for the Selector with the given name in this Entity and supertype Entities. Returns the Selector or null if none found.

getCombinedAttributes

public java.util.Collection getCombinedAttributes()

Returns:

getReferences

public java.util.Collection getReferences()

Returns:

getCombinedAgregatedManyToManyReferences

public java.util.Collection getCombinedAgregatedManyToManyReferences()

Returns all references, which are parts of many-to-many association and where this entity is the aggregator. Looks at this entity and any super entities.

Returns:

Returns all references, which are parts of many-to-many association and where this entity is the aggregator. Looks at this entity and any super entities.

getCombinedAttributesUsedForOrdering

public java.util.Collection getCombinedAttributesUsedForOrdering()

Retrieves read only collection of attributes which this entity can be orderd by. Includes attributes from this entity and all attributes from supertypes.

Returns:

Retrieves read only collection of attributes which this entity can be orderd by. Includes attributes from this entity and all attributes from supertypes.

getCombinedRoles

public java.util.Collection getCombinedRoles()

Returns all roles played by this entity and all subentities.

Returns:

Returns all roles played by this entity and all subentities.

getReference

public AssociationRole getReference(java.lang.String pReferenceName)

Looks for the Reference with the given name only in this Entity. Returns the Reference or throws exception if none found.

Parameters:

pReferenceName -

Returns:

Looks for the Reference with the given name only in this Entity. Returns the Reference or throws exception if none found.

findReference

public AssociationRole findReference(java.lang.String pReferenceName)

Looks for the Reference with the given name only in this Entity. Returns the Reference or null if none found.

Parameters:

pReferenceName -

Returns:

Looks for the Reference with the given name only in this Entity. Returns the Reference or null if none found.

findCombinedReference

public AssociationRole findCombinedReference(java.lang.String pReferenceName)

Looks for the Reference with the given name in this Entity and supertype Entities. Returns the Reference or null if none found.

Parameters:

pReferenceName -

Returns:

Looks for the Reference with the given name in this Entity and supertype Entities. Returns the Reference or null if none found.

findConstraint

public ModelElementConstraint findConstraint(java.lang.String pConstraintName)

Looks for the Constraint with the given name only in this Entity. Returns the Constraint or null if none found.

Parameters:

pConstraintName -

Returns:

Looks for the Constraint with the given name only in this Entity. Returns the Constraint or null if none found.

getConstraint

public ModelElementConstraint getConstraint(java.lang.String pConstraintName)

Looks for the Constraint with the given name only in this Entity. Returns the Constraint or throws exception if none found.

Parameters:

pConstraintName -

Returns:

Looks for the Constraint with the given name only in this Entity. Returns the Constraint or throws exception if none found.

getCombinedConstraints

public java.util.Collection getCombinedConstraints()

Returns all Constraints in this Entity and all subentities

Returns:

Returns all Constraints in this Entity and all subentities

getCombinedTypes

public java.util.Collection getCombinedTypes()

Returns list of DataTypes, Structures and Messages used in the Entity. This includes owned and referenced elements.

Returns:

Returns list of DataTypes, Structures and Messages used in the Entity. This includes owned and referenced elements.

getStereotype

public EntityStereotype getStereotype()

Returns the value of attribute stereotype.

Returns:

Value of attribute stereotype.

setStereotype

public void setStereotype(EntityStereotype newValue)

Sets the value of stereotype attribute. See getStereotype() for description on the attribute.

Parameters:

newValue - New value to be set.

isAbstract

public boolean isAbstract()

Returns the value of attribute isAbstract.

Returns:

Value of attribute isAbstract.

setAbstract

public void setAbstract(boolean newValue)

Sets the value of isAbstract attribute. See isAbstract() for description on the attribute.

Parameters:

newValue - New value to be set.

isFinal

public boolean isFinal()

Returns the value of attribute isFinal.

Returns:

Value of attribute isFinal.

setFinal

public void setFinal(boolean newValue)

Sets the value of isFinal attribute. See isFinal() for description on the attribute.

Parameters:

newValue - New value to be set.

getPluralName

public java.lang.String getPluralName()

Returns the value of attribute pluralName.

Returns:

Value of attribute pluralName.

setPluralName

public void setPluralName(java.lang.String newValue)

Sets the value of pluralName attribute. See getPluralName() for description on the attribute.

Parameters:

newValue - New value to be set.

getInstanceIdAttributeNameOverride

public java.lang.String getInstanceIdAttributeNameOverride()

Returns the value of attribute instanceIdAttributeNameOverride. The customised name of the InstanceId attribute for this entity. Should only be set in rare cases when name 'InstanceId' is needed to name another attribute

Returns:

Value of attribute instanceIdAttributeNameOverride.

setInstanceIdAttributeNameOverride

public void setInstanceIdAttributeNameOverride(java.lang.String newValue)

Sets the value of instanceIdAttributeNameOverride attribute. See getInstanceIdAttributeNameOverride() for description on the attribute.

Parameters:

newValue - New value to be set.

getVersionIdAttributeNameOverride

public java.lang.String getVersionIdAttributeNameOverride()

Returns the value of attribute versionIdAttributeNameOverride. The customised name of the VersionId attribute for this entity. Should only be set in rare cases when name 'VersionId' is needed to name another attribute

Returns:

Value of attribute versionIdAttributeNameOverride.

setVersionIdAttributeNameOverride

public void setVersionIdAttributeNameOverride(java.lang.String newValue)

Sets the value of versionIdAttributeNameOverride attribute. See getVersionIdAttributeNameOverride() for description on the attribute.

Parameters:

newValue - New value to be set.

getStateAttributeNameOverride

public java.lang.String getStateAttributeNameOverride()

Returns the value of attribute stateAttributeNameOverride. The customised name of the State attribute for this entity. Should only be set in rare cases when name 'State' is needed to name another attribute

Returns:

Value of attribute stateAttributeNameOverride.

setStateAttributeNameOverride

public void setStateAttributeNameOverride(java.lang.String newValue)

Sets the value of stateAttributeNameOverride attribute. See getStateAttributeNameOverride() for description on the attribute.

Parameters:

newValue - New value to be set.

getOrderingInstructionDataType

public DataType getOrderingInstructionDataType()

Returns the value of reference orderingInstructionDataType.

Returns:

Value of reference orderingInstructionDataType.

setOrderingInstructionDataType

public void setOrderingInstructionDataType(DataType newValue)

Sets the value of reference orderingInstructionDataType. See getOrderingInstructionDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getVersionIdDataType

public DataType getVersionIdDataType()

Returns the value of reference versionIdDataType.

Returns:

Value of reference versionIdDataType.

setVersionIdDataType

public void setVersionIdDataType(DataType newValue)

Sets the value of reference versionIdDataType. See getVersionIdDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getSupertype

public Entity getSupertype()

Returns the value of reference supertype.

Returns:

Value of reference supertype.

setSupertype

public void setSupertype(Entity newValue)

Sets the value of reference supertype. See getSupertype() for description on the reference.

Parameters:

newValue - New value to be set.

getSubtypes

public java.util.Collection getSubtypes()

Returns the value of reference subtypes.

Returns:

Value of reference subtypes.

getAttributes

public java.util.Collection getAttributes()

Returns the value of reference attributes.

Returns:

Value of reference attributes.

getCollectionContainsFlagDataType

public DataType getCollectionContainsFlagDataType()

Returns the value of reference collectionContainsFlagDataType.

Returns:

Value of reference collectionContainsFlagDataType.

setCollectionContainsFlagDataType

public void setCollectionContainsFlagDataType(DataType newValue)

Sets the value of reference collectionContainsFlagDataType. See getCollectionContainsFlagDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getRelationalTableDefinitions

public java.util.Collection getRelationalTableDefinitions()

Returns the value of reference relationalTableDefinitions.

Returns:

Value of reference relationalTableDefinitions.

getStateDataType

public DataType getStateDataType()

Returns the value of reference stateDataType.

Returns:

Value of reference stateDataType.

setStateDataType

public void setStateDataType(DataType newValue)

Sets the value of reference stateDataType. See getStateDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getSelectors

public java.util.Collection getSelectors()

Returns the value of reference selectors.

Returns:

Value of reference selectors.

getRoles

public java.util.Collection getRoles()

Returns the value of reference roles.

Returns:

Value of reference roles.

getCollectionEmptyFlagDataType

public DataType getCollectionEmptyFlagDataType()

Returns the value of reference collectionEmptyFlagDataType.

Returns:

Value of reference collectionEmptyFlagDataType.

setCollectionEmptyFlagDataType

public void setCollectionEmptyFlagDataType(DataType newValue)

Sets the value of reference collectionEmptyFlagDataType. See getCollectionEmptyFlagDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getConstraints

public java.util.List getConstraints()

Returns the value of reference constraints.

Returns:

Value of reference constraints.

getPrimaryKeyElements

public java.util.Collection getPrimaryKeyElements()

Returns the value of reference primaryKeyElements.

Returns:

Value of reference primaryKeyElements.

getSubsetSizeDataType

public DataType getSubsetSizeDataType()

Returns the value of reference subsetSizeDataType.

Returns:

Value of reference subsetSizeDataType.

setSubsetSizeDataType

public void setSubsetSizeDataType(DataType newValue)

Sets the value of reference subsetSizeDataType. See getSubsetSizeDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getReportOutputsUsingEntity

public java.util.Collection getReportOutputsUsingEntity()

Returns the value of reference reportOutputsUsingEntity.

Returns:

Value of reference reportOutputsUsingEntity.

getStateMachine

public StateMachine getStateMachine()

Returns the value of reference stateMachine.

Returns:

Value of reference stateMachine.

setStateMachine

public void setStateMachine(StateMachine newValue)

Sets the value of reference stateMachine. See getStateMachine() for description on the reference.

Parameters:

newValue - New value to be set.

getCollectionOffsetDataType

public DataType getCollectionOffsetDataType()

Returns the value of reference collectionOffsetDataType.

Returns:

Value of reference collectionOffsetDataType.

setCollectionOffsetDataType

public void setCollectionOffsetDataType(DataType newValue)

Sets the value of reference collectionOffsetDataType. See getCollectionOffsetDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getCollectionSizeDataType

public DataType getCollectionSizeDataType()

Returns the value of reference collectionSizeDataType.

Returns:

Value of reference collectionSizeDataType.

setCollectionSizeDataType

public void setCollectionSizeDataType(DataType newValue)

Sets the value of reference collectionSizeDataType. See getCollectionSizeDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getDomain

public Domain getDomain()

Returns the value of reference domain.

Returns:

Value of reference domain.

setDomain

public void setDomain(Domain newValue)

Sets the value of reference domain. See getDomain() for description on the reference.

Parameters:

newValue - New value to be set.

getInstanceIdDataType

public DataType getInstanceIdDataType()

Returns the value of reference instanceIdDataType.

Returns:

Value of reference instanceIdDataType.

setInstanceIdDataType

public void setInstanceIdDataType(DataType newValue)

Sets the value of reference instanceIdDataType. See getInstanceIdDataType() for description on the reference.

Parameters:

newValue - New value to be set.

getEntityStateDiagrams

public java.util.Collection getEntityStateDiagrams()

Returns the value of reference entityStateDiagrams.

Returns:

Value of reference entityStateDiagrams.