org.scrashmeow.ojb.console.service
Interface ConfigService

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ConfigServiceImpl

public interface ConfigService

extends java.io.Serializable

The UI configuration service that provides a facade into the model objects for the configuration file for the OJB Console (OJBC.xml)

Author:

Alexander Bibighaus

Method Summary

java.lang.String[]	findAcceptedLanguageKeys() Returns the list of acceptable languages where the strings are the language part of a Locale string
java.util.Locale[]	findAcceptedLocales() Returns the list of acceptable locales
WidgetDefinition	findDefaultAutoincrementWidgetDefinition() Finds the default auto increment widget to use for auto incrementing fields
WidgetDefinition	findDefaultCollectionWidgetDefinition() Finds the default collection widget to use for collection descriptor fields
Nav	findDefaultMenubarNavigation() Returns the default menubar navigation
WidgetDefinition	findDefaultReferenceWidgetDefinition() Finds the default reference widget definition to use for reference descriptor fields
WidgetDefinition	findDefaultWidgetDefinition() Finds the default widget definition
Nav	findNavById(java.lang.String navId) Finds a navigation defintion by ID
java.util.Map	findSearchCriteria(java.lang.String jdbcTypeStr) Finds the available set of valid search criteria for a given jdbc type string
Nav[]	findTabs(java.lang.String id) Find the navigation defintions for a tab id
Nav[]	findToolbarNavigations() Returns all the toolbar navigation definitions
WidgetDefinition	findWidgetDefinitionById(java.lang.String widgetId) Finds a widget definition by ID
WidgetDefinition	findWidgetDefinitionByType(java.lang.String jdbcTypeStr) Finds a widget definition by a jdbc data type string
boolean	isSearchableType(java.lang.String jdbcTypeStr) Determines if a jdbc type str is searchable or not based upon its data type

Method Detail

findAcceptedLanguageKeys

public java.lang.String[] findAcceptedLanguageKeys()

Returns the list of acceptable languages where the strings are the language part of a Locale string

Returns:

a String[] value

findAcceptedLocales

public java.util.Locale[] findAcceptedLocales()

Returns the list of acceptable locales

Returns:

a Locale[] value

findToolbarNavigations

public Nav[] findToolbarNavigations()
                             throws ServiceException

Returns all the toolbar navigation definitions

Returns:

a Nav[] value

Throws:

ServiceException - if an error occurs

findDefaultMenubarNavigation

public Nav findDefaultMenubarNavigation()
                                 throws ServiceException

Returns the default menubar navigation

Returns:

a Nav value

Throws:

ServiceException - if an error occurs

findNavById

public Nav findNavById(java.lang.String navId)
                throws ServiceException

Finds a navigation defintion by ID

Parameters:

navId - a String value

Returns:

a Nav value

Throws:

ServiceException - if an error occurs

findTabs

public Nav[] findTabs(java.lang.String id)
               throws ServiceException

Find the navigation defintions for a tab id

Parameters:

id - a String value

Returns:

a Nav[] value

Throws:

ServiceException - if an error occurs

findWidgetDefinitionById

public WidgetDefinition findWidgetDefinitionById(java.lang.String widgetId)
                                          throws ServiceException

Finds a widget definition by ID

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

findWidgetDefinitionByType

public WidgetDefinition findWidgetDefinitionByType(java.lang.String jdbcTypeStr)
                                            throws ServiceException

Finds a widget definition by a jdbc data type string

Parameters:

jdbcTypeStr - a String value

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

findDefaultWidgetDefinition

public WidgetDefinition findDefaultWidgetDefinition()
                                             throws ServiceException

Finds the default widget definition

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

findDefaultAutoincrementWidgetDefinition

public WidgetDefinition findDefaultAutoincrementWidgetDefinition()
                                                          throws ServiceException

Finds the default auto increment widget to use for auto incrementing fields

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

findDefaultCollectionWidgetDefinition

public WidgetDefinition findDefaultCollectionWidgetDefinition()
                                                       throws ServiceException

Finds the default collection widget to use for collection descriptor fields

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

findDefaultReferenceWidgetDefinition

public WidgetDefinition findDefaultReferenceWidgetDefinition()
                                                      throws ServiceException

Finds the default reference widget definition to use for reference descriptor fields

Returns:

a WidgetDefinition value

Throws:

ServiceException - if an error occurs

isSearchableType

public boolean isSearchableType(java.lang.String jdbcTypeStr)
                         throws ServiceException

Determines if a jdbc type str is searchable or not based upon its data type

Parameters:

jdbcTypeStr - a String value

Returns:

a boolean value

Throws:

ServiceException - if an error occurs

findSearchCriteria

public java.util.Map findSearchCriteria(java.lang.String jdbcTypeStr)
                                 throws ServiceException

Finds the available set of valid search criteria for a given jdbc type string

Parameters:

jdbcTypeStr - a String value

Returns:

a Map value

Throws:

ServiceException - if an error occurs