de.tif.jacob.core.definition
Interface IApplicationDefinition

All Superinterfaces:

IDefinition, INamedObjectDefinition

public interface IApplicationDefinition
extends INamedObjectDefinition, IDefinition

This interface represents an application definition, i.e application design. An application definitions consists of:

a name, a version, a title

table definitions, i.e. ITableDefinition

table aliases, i.e. ITableAlias

browser definitions, i.e. IBrowserDefinition

relations, i.e. IRelation

relation sets, i.e. IRelationSet

domain definitions, i.e. IDomainDefinition

a toolbar definition, i.e. IToolbarDefinition

Method Summary

IAdhocBrowserDefinition	createAdhocBrowserDefinition(IBrowserDefinition browserDefinition) Creates an ad-hoc browser definition, i.e. an modifiable browser definition, by means of a given browser definition as template.
IAdhocBrowserDefinition	createAdhocBrowserDefinition(ITableAlias alias) Creates an ad-hoc browser definition, i.e. an modifiable browser definition, for the given table alias.
java.util.List	getBrowserDefinitions() Returns all browser definitions ordered by name of this application definition.
IRelationSet	getDefaultRelationSet() Returns the default relation set, i.e. the relation set which contains all relations of this application definition.
java.util.List	getDomainDefinitions() Returns all domain definitions of this application definition.
IRelationSet	getLocalRelationSet() Returns the local relation set, i.e. the local relation set contains no relations at all.
java.util.List	getRelations() Returns all relations ordered by name of this application definition.
java.util.List	getRelationSets() Returns all relation sets ordered by name of this application definition.
ISchemaDefinition	getSchemaDefinition(java.lang.String datasourceName) Returns the database schema definition for the given datasource as it is required for this application.
java.util.List	getTableAliases() Returns all table aliases ordered by name of this application definition.
java.util.List	getTableDefinitions() Returns all table definitions ordered by name of this application definition.
java.lang.String	getTitle() Returns the application title.
IToolbarDefinition	getToolbarDefinition() Returns the toolbar definition of this application definition.
Version	getVersion() Returns the version of this application definition.

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getName, getProperty

Methods inherited from interface de.tif.jacob.core.definition.IDefinition

getBrowserDefinition, getDomainDefinition, getRelation, getRelationSet, getTableAlias, getTableDefinition

Method Detail

getTitle

java.lang.String getTitle()

Returns the application title.

Note: The title could be internationalized, if the title starts with a '%' character. In this case the title is interpreted as a key to the respective application resource bundles for internationalization.

Returns:

the application title

getVersion

Version getVersion()

Returns the version of this application definition.

Returns:

the application version

getToolbarDefinition

IToolbarDefinition getToolbarDefinition()

Returns the toolbar definition of this application definition.

Returns:

the toolbar definition

getBrowserDefinitions

java.util.List getBrowserDefinitions()

Returns all browser definitions ordered by name of this application definition.

Returns:

List of IBrowserDefinition

createAdhocBrowserDefinition

IAdhocBrowserDefinition createAdhocBrowserDefinition(ITableAlias alias)

Creates an ad-hoc browser definition, i.e. an modifiable browser definition, for the given table alias. Initial this browser definition does not contain any browser fields.

Parameters:

alias - the table alias to use as base for the created ad-hoc browser definition

Returns:

the newly created ad-hoc browser definition

createAdhocBrowserDefinition

IAdhocBrowserDefinition createAdhocBrowserDefinition(IBrowserDefinition browserDefinition)

Creates an ad-hoc browser definition, i.e. an modifiable browser definition, by means of a given browser definition as template.

Parameters:

browserDefinition - the browser definition to use as template

Returns:

the newly created ad-hoc browser definition

getTableDefinitions

java.util.List getTableDefinitions()

Returns all table definitions ordered by name of this application definition.

Returns:

List{ITableDefinition}

getTableAliases

java.util.List getTableAliases()

Returns all table aliases ordered by name of this application definition.

Returns:

List{ITableAlias}

getRelationSets

java.util.List getRelationSets()

Returns all relation sets ordered by name of this application definition.

Returns:

List of IRelationSet

getDefaultRelationSet

IRelationSet getDefaultRelationSet()

Returns the default relation set, i.e. the relation set which contains all relations of this application definition.

Returns:

the default relation set.

getLocalRelationSet

IRelationSet getLocalRelationSet()

Returns the local relation set, i.e. the local relation set contains no relations at all. Nevertheless, the local relation set provides a specific handling then used with foreign fields.

Returns:

the local relation set

See Also:

IRelationSet.isLocal()

getRelations

java.util.List getRelations()

Returns all relations ordered by name of this application definition.

Returns:

List of IRelation

getDomainDefinitions

java.util.List getDomainDefinitions()

Returns all domain definitions of this application definition.

Returns:

List of IDomainDefinition

getSchemaDefinition

ISchemaDefinition getSchemaDefinition(java.lang.String datasourceName)

Returns the database schema definition for the given datasource as it is required for this application.

Parameters:

datasourceName - the datasource name

Returns:

the schema definition or null, if this application is not based on the given data source.