org.andromda.cartridges.jsf.metafacades

Interface JSFManageableEntity

All Superinterfaces:

ClassifierFacade, Entity, GeneralizableElementFacade, ManageableEntity, ModelElementFacade

All Known Implementing Classes:

JSFManageableEntityLogic, JSFManageableEntityLogicImpl

public interface JSFManageableEntity
extends ManageableEntity

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionClassName() The name of the action class that executes the manageable actions.
String	getActionFullPath() The fully qualified path to the action class that execute the manageable actions.
String	getActionPath() The path to the action class that execute the manageable actions.
String	getActionRoles() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.getActionRoles
String	getActionSerialVersionUID() The calcuated serial version UID for this manageable actions.
String	getActionType() The fully qualified name of the action class that execute the manageable actions.
String	getControllerBeanName() The bean name of this manageable controller (this is what is stored in the JSF configuration file).
String	getControllerFullPath() Full path of this manageable controller.
String	getControllerName() Manageable controller class name.
String	getControllerType() Fully qualified name of this manageable controller.
String	getConverterClassName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterClassName
String	getConverterFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterFullPath
String	getConverterType() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterType
String	getExceptionKey() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionKey
String	getExceptionPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionPath
String	getFormBeanClassName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanClassName
String	getFormBeanFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanFullPath
String	getFormBeanName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanName
String	getFormBeanType() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanType
String	getFormSerialVersionUID() The calcuated serial version UID for this action's form.
String	getListGetterName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listGetterName
String	getListName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listName
String	getListSetterName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listSetterName
Collection	getManageableSearchAssociationEnds() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAssociationEnds
Collection	getManageableSearchAttributes() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAttributes
String	getMessageKey() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageKey
String	getMessageValue() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageValue
String	getOdsExportFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.odsExportFullPath
String	getOnlineHelpActionPath() The full path to this entity's online help action.
String	getOnlineHelpKey() The key to lookup the online help documentation.
String	getOnlineHelpPagePath() The full path to this entitiy's online help page.
String	getOnlineHelpValue() The online help documentation.
String	getPopulatorFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorFullPath
String	getPopulatorName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorName
String	getPopulatorType() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorType
Collection<Role>	getRoles() Represents a role a user may play within a system.
String	getSearchFormBeanClassName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanClassName
String	getSearchFormBeanFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanFullPath
String	getSearchFormBeanName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanName
String	getSearchFormBeanType() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanType
String	getTableExportTypes() Tthe available types of export in a single String instance.
int	getTableMaxRows() The maximum number of rows to be displayed in the table at the same time.
String	getValueObjectClassName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.valueObjectClassName
String	getViewFullPath() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewFullPath
String	getViewName() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewName
String	getViewTitleKey() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleKey
String	getViewTitleValue() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleValue
boolean	isJSFManageableEntityMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isNeedsFileUpload() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsFileUpload
boolean	isNeedsUserInterface() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsUserInterface
boolean	isPreload() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.preload
boolean	isSearchable(Object element) TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.isSearchable
boolean	isTableExportable() True if it is possible to export the table data to XML, CSV, PDF or Excel format.
boolean	isTableSortable() True if it is possible to sort the columns of the table.
boolean	isValidationRequired() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.validationRequired

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

getAllManageables, getDisplayAttribute, getFullyQualifiedManageableServiceName, getManageableAssociationEnds, getManageableAttributes, getManageableIdentifier, getManageableMembers, getManageablePackageName, getManageablePackagePath, getManageableServiceAccessorCall, getManageableServiceFullPath, getManageableServiceName, getMaximumListSize, getPageSize, getReferencingManageables, getUsers, isCreate, isDelete, isManageable, isManageableEntityMetaType, isRead, isResolveable, isUpdate, listManageableMembers, listManageableMembersWithWrapperTypes

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

isJSFManageableEntityMetaType

boolean isJSFManageableEntityMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActionClassName

String getActionClassName()

The name of the action class that executes the manageable actions.

Returns:

String

getActionFullPath

String getActionFullPath()

The fully qualified path to the action class that execute the manageable actions.

Returns:

String

getActionPath

String getActionPath()

The path to the action class that execute the manageable actions.

Returns:

String

getActionRoles

String getActionRoles()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.getActionRoles

Returns:

String

getActionSerialVersionUID

String getActionSerialVersionUID()

The calcuated serial version UID for this manageable actions.

Returns:

String

getActionType

String getActionType()

The fully qualified name of the action class that execute the manageable actions.

Returns:

String

getControllerBeanName

String getControllerBeanName()

The bean name of this manageable controller (this is what is stored in the JSF configuration file).

Returns:

String

getControllerFullPath

String getControllerFullPath()

Full path of this manageable controller.

Returns:

String

getControllerName

String getControllerName()

Manageable controller class name.

Returns:

String

getControllerType

String getControllerType()

Fully qualified name of this manageable controller.

Returns:

String

getConverterClassName

String getConverterClassName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterClassName

Returns:

String

getConverterFullPath

String getConverterFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterFullPath

Returns:

String

getConverterType

String getConverterType()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.converterType

Returns:

String

getExceptionKey

String getExceptionKey()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionKey

Returns:

String

getExceptionPath

String getExceptionPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.exceptionPath

Returns:

String

getFormBeanClassName

String getFormBeanClassName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanClassName

Returns:

String

getFormBeanFullPath

String getFormBeanFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanFullPath

Returns:

String

getFormBeanName

String getFormBeanName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanName

Returns:

String

getFormBeanType

String getFormBeanType()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.formBeanType

Returns:

String

getFormSerialVersionUID

String getFormSerialVersionUID()

The calcuated serial version UID for this action's form.

Returns:

String

getListGetterName

String getListGetterName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listGetterName

Returns:

String

getListName

String getListName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listName

Returns:

String

getListSetterName

String getListSetterName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.listSetterName

Returns:

String

getManageableSearchAssociationEnds

Collection getManageableSearchAssociationEnds()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAssociationEnds

Returns:

Collection

getManageableSearchAttributes

Collection getManageableSearchAttributes()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.manageableSearchAttributes

Returns:

Collection

getMessageKey

String getMessageKey()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageKey

Returns:

String

getMessageValue

String getMessageValue()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.messageValue

Returns:

String

getOdsExportFullPath

String getOdsExportFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.odsExportFullPath

Returns:

String

getOnlineHelpActionPath

String getOnlineHelpActionPath()

The full path to this entity's online help action. The returned String does not have a suffix such as '.do'.

Returns:

String

getOnlineHelpKey

String getOnlineHelpKey()

The key to lookup the online help documentation.

Returns:

String

getOnlineHelpPagePath

String getOnlineHelpPagePath()

The full path to this entitiy's online help page. The returned String does not have a suffix such as '.jsp'.

Returns:

String

getOnlineHelpValue

String getOnlineHelpValue()

The online help documentation. The format is HTML without any style.

Returns:

String

getPopulatorFullPath

String getPopulatorFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorFullPath

Returns:

String

getPopulatorName

String getPopulatorName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorName

Returns:

String

getPopulatorType

String getPopulatorType()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.populatorType

Returns:

String

getRoles

Collection<Role> getRoles()

Represents a role a user may play within a system. Provides access to things such as services and service operations.

Returns:

Collection

getSearchFormBeanClassName

String getSearchFormBeanClassName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanClassName

Returns:

String

getSearchFormBeanFullPath

String getSearchFormBeanFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanFullPath

Returns:

String

getSearchFormBeanName

String getSearchFormBeanName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanName

Returns:

String

getSearchFormBeanType

String getSearchFormBeanType()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.searchFormBeanType

Returns:

String

getTableExportTypes

String getTableExportTypes()

Tthe available types of export in a single String instance.

Returns:

String

getTableMaxRows

int getTableMaxRows()

The maximum number of rows to be displayed in the table at the same time. This is also known as the page size. A value of zero or less will display all data in the same table (therefore also on the same page).

Returns:

int

getValueObjectClassName

String getValueObjectClassName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.valueObjectClassName

Returns:

String

getViewFullPath

String getViewFullPath()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewFullPath

Returns:

String

getViewName

String getViewName()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewName

Returns:

String

getViewTitleKey

String getViewTitleKey()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleKey

Returns:

String

getViewTitleValue

String getViewTitleValue()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.viewTitleValue

Returns:

String

isNeedsFileUpload

boolean isNeedsFileUpload()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsFileUpload

Returns:

boolean

isNeedsUserInterface

boolean isNeedsUserInterface()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.needsUserInterface

Returns:

boolean

isPreload

boolean isPreload()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.preload

Returns:

boolean

isSearchable

boolean isSearchable(Object element)

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.isSearchable

Parameters:

element - Object

Returns:

boolean

isTableExportable

boolean isTableExportable()

True if it is possible to export the table data to XML, CSV, PDF or Excel format.

Returns:

boolean

isTableSortable

boolean isTableSortable()

True if it is possible to sort the columns of the table.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFManageableEntity.validationRequired

Returns:

boolean