org.andromda.metafacades.uml

Interface ManageableEntity

All Superinterfaces:

ClassifierFacade, Entity, GeneralizableElementFacade, ModelElementFacade

public interface ManageableEntity
extends Entity

An Entity that is Manageable: will produce CRUD operations in the EntityManager implementation. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
List<ManageableEntity>	getAllManageables() All entities to which can be browsed from this entity.
ManageableEntityAttribute	getDisplayAttribute() The attribute used as a key link to display values for this entity.
String	getFullyQualifiedManageableServiceName() The fully qualified service name of the entity.
List<ManageableEntityAssociationEnd>	getManageableAssociationEnds() The associations to other entities from this entity.
List<ManageableEntityAttribute>	getManageableAttributes() Lists the attributes that can be managed for this entity.
ManageableEntityAttribute	getManageableIdentifier() The identifier used when managing this entity.
List<ModelElementFacade>	getManageableMembers() ManageableAttributes and ManageableAssociationEnds
String	getManageablePackageName() The entity package name.
String	getManageablePackagePath() The Package path of the Entity
String	getManageableServiceAccessorCall() The entity accessor (getter) call.
String	getManageableServiceFullPath() The service full path of the entity.
String	getManageableServiceName() The service name of the entity.
int	getMaximumListSize() The maximum number of rows to load from the database.
int	getPageSize() The maximum number of rows to load from the database.
List<ManageableEntity>	getReferencingManageables() Other Manageable Entities which reference this entity.
List<ActorFacade>	getUsers() The Actors (Roles) which can manage the Entity.
boolean	isCreate() Create a create operation on the entity manager?
boolean	isDelete() Create a delete operation on the entity manager?
boolean	isManageable() True: Entity is manageable.
boolean	isManageableEntityMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isRead() Create a read operation on the entity manager?
boolean	isResolveable() The maximum number of rows to load from the database.
boolean	isUpdate() Create an update operation on the entity manager?
String	listManageableMembers(boolean withTypes) Returns a string with the attributes without wrapper types.
String	listManageableMembersWithWrapperTypes() Returns a string with the attributes and wrapper types.

Methods inherited from interface org.andromda.metafacades.uml.Entity

getAllEntityReferences, getAttributeNameList, getAttributeNameList, getAttributes, getAttributes, getAttributeTypeList, getBusinessOperations, getChildEnds, getEmbeddedValues, getEntityReferences, getFullyQualifiedIdentifierTypeName, getIdentifierAssociationEnds, getIdentifierGetterName, getIdentifierName, getIdentifiers, getIdentifiers, getIdentifierSetterName, getIdentifierTypeName, getMaxSqlNameLength, getOperationCallFromAttributes, getOperationCallFromAttributes, getParentEnd, getProperties, getQueryOperations, getQueryOperations, getRequiredAttributeNameList, getRequiredAttributes, getRequiredAttributeTypeList, getRequiredProperties, getRequiredPropertyNameList, getRequiredPropertyTypeList, getSchema, getTableName, isChild, isCompositeIdentifier, isDynamicIdentifiersPresent, isEntityMetaType, isIdentifiersPresent, isUsingAssignedIdentifier, isUsingForeignIdentifier

Methods inherited from interface org.andromda.metafacades.uml.ClassifierFacade

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from interface org.andromda.metafacades.uml.GeneralizableElementFacade

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isManageableEntityMetaType

boolean isManageableEntityMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllManageables

List<ManageableEntity> getAllManageables()

All entities to which can be browsed from this entity. Currently this property will simple hold all entities, so the value is the same for any arbitrary entity. Hiding entities can be done in the presentation tier, for example depending on runtime security information.

Returns:

List

getDisplayAttribute

ManageableEntityAttribute getDisplayAttribute()

The attribute used as a key link to display values for this entity.

Returns:

ManageableEntityAttribute

getFullyQualifiedManageableServiceName

String getFullyQualifiedManageableServiceName()

The fully qualified service name of the entity.

Returns:

String

getManageableAssociationEnds

List<ManageableEntityAssociationEnd> getManageableAssociationEnds()

The associations to other entities from this entity.

Returns:

List

getManageableAttributes

List<ManageableEntityAttribute> getManageableAttributes()

Lists the attributes that can be managed for this entity. This feature is particularly important when resolving inherited attributes and ids.

Returns:

List

getManageableIdentifier

ManageableEntityAttribute getManageableIdentifier()

The identifier used when managing this entity.

Returns:

ManageableEntityAttribute

getManageableMembers

List<ModelElementFacade> getManageableMembers()

ManageableAttributes and ManageableAssociationEnds

Returns:

List

getManageablePackageName

String getManageablePackageName()

The entity package name.

Returns:

String

getManageablePackagePath

String getManageablePackagePath()

The Package path of the Entity

Returns:

String

getManageableServiceAccessorCall

String getManageableServiceAccessorCall()

The entity accessor (getter) call.

Returns:

String

getManageableServiceFullPath

String getManageableServiceFullPath()

The service full path of the entity.

Returns:

String

getManageableServiceName

String getManageableServiceName()

The service name of the entity.

Returns:

String

getMaximumListSize

int getMaximumListSize()

The maximum number of rows to load from the database.

Returns:

int

getPageSize

int getPageSize()

The maximum number of rows to load from the database.

Returns:

int

getReferencingManageables

List<ManageableEntity> getReferencingManageables()

Other Manageable Entities which reference this entity.

Returns:

List

getUsers

List<ActorFacade> getUsers()

The Actors (Roles) which can manage the Entity.

Returns:

List

isCreate

boolean isCreate()

Create a create operation on the entity manager?

Returns:

boolean

isDelete

boolean isDelete()

Create a delete operation on the entity manager?

Returns:

boolean

isManageable

boolean isManageable()

True: Entity is manageable.

Returns:

boolean

isRead

boolean isRead()

Create a read operation on the entity manager?

Returns:

boolean

isResolveable

boolean isResolveable()

The maximum number of rows to load from the database.

Returns:

boolean

isUpdate

boolean isUpdate()

Create an update operation on the entity manager?

Returns:

boolean

listManageableMembers

String listManageableMembers(boolean withTypes)

Returns a string with the attributes without wrapper types.

Parameters:

withTypes - boolean

Returns:

String

listManageableMembersWithWrapperTypes

String listManageableMembersWithWrapperTypes()

Returns a string with the attributes and wrapper types.

Returns:

String