com.atlassian.activeobjects.config

Interface ActiveObjectsConfiguration

All Known Implementing Classes:

DefaultActiveObjectsConfiguration

public interface ActiveObjectsConfiguration

This represents the configuration of active objects for a given module descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AO_TABLE_PREFIX

Method Summary

Modifier and Type	Method and Description
DataSourceType	getDataSourceType() The datasource type that this active objects is meant to use.
Set<Class<? extends net.java.ao.RawEntity<?>>>	getEntities() The set of 'configured' entities for the active objects configuration.
net.java.ao.schema.NameConverters	getNameConverters() Gets the name converters to use with Active Objects
PluginKey	getPluginKey() The plugin key for which this configuration is defined.
net.java.ao.SchemaConfiguration	getSchemaConfiguration() Gets the schema configuration to use with Active Objects
Prefix	getTableNamePrefix() The prefix to use for table names in the database
List<ActiveObjectsUpgradeTask>	getUpgradeTasks() Gets the upgrade tasks associated with Active Objects

Field Detail

AO_TABLE_PREFIX

static final String AO_TABLE_PREFIX

See Also:

Constant Field Values

Method Detail

getPluginKey

PluginKey getPluginKey()

The plugin key for which this configuration is defined.

Returns:

a PluginKey, cannot be null

getDataSourceType

DataSourceType getDataSourceType()

The datasource type that this active objects is meant to use.

Returns:

a valid DataSourceType

getTableNamePrefix

Prefix getTableNamePrefix()

The prefix to use for table names in the database

Returns:

the prefix to use for table names in the database.

getNameConverters

net.java.ao.schema.NameConverters getNameConverters()

Gets the name converters to use with Active Objects

Returns:

the name converters

getSchemaConfiguration

net.java.ao.SchemaConfiguration getSchemaConfiguration()

Gets the schema configuration to use with Active Objects

Returns:

a schema configuration

getEntities

Set<Class<? extends net.java.ao.RawEntity<?>>> getEntities()

The set of 'configured' entities for the active objects configuration.

Returns:

a set of entity classes, empty of no entities have been defined.

getUpgradeTasks

List<ActiveObjectsUpgradeTask> getUpgradeTasks()

Gets the upgrade tasks associated with Active Objects

Returns:

the upgrade tasks