nl.gx.webmanager.cms.integration
Interface DatabaseEntity

All Superinterfaces:

ElementHolder, Presentable, ResourceEntity, Wrapper

All Known Subinterfaces:

DatabasePageType

public interface DatabaseEntity
extends ResourceEntity, ElementHolder

Database enabled pages have a data source.

Method Summary

QueryColumn[]	getColumns() Return the columns which are used for the detail screen.
javax.sql.DataSource	getDataSource() Return data source.
java.lang.String	getDataSourceName() Return data source name.
java.lang.String	getDataSourceType() Return data source type.
java.lang.String	getIdentifier() Return a string unique among all database entities.
java.lang.String	getInfoQuery() Return query which retrieves the information of the reference.
java.lang.String	getQuery() Return the query which is used to retrieve the title of the database reference with the ID from the Querystring.
java.lang.String	getQueryFromID(int entryId) Return the query which is used to retrieve the title of the database reference with a given ID.
java.lang.String	getSearchQuery() Return query which is used to search for a reference, e.g.

Methods inherited from interface nl.gx.webmanager.cms.integration.ResourceEntity

getTitle

Methods inherited from interface nl.gx.webmanager.cms.core.ElementHolder

addRelatedLink, createRichTextElements, getElementHolderElements, getElements, getElementsFBOMap, getFBOMap, getLastElement, getModelElements, getModelElementsFBOMap, getRelatedLink, getRelatedLinks, getWebsite, insertLastElementAtCursor, isAdditionalElementsAllowed, setElementHolderElements, setModelElements

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getDataSourceName

java.lang.String getDataSourceName()

Return data source name.

Returns:

data source name.

getDataSourceType

java.lang.String getDataSourceType()

Return data source type.

Returns:

data source type.

getDataSource

javax.sql.DataSource getDataSource()

Return data source.

Returns:

data source.

getInfoQuery

java.lang.String getInfoQuery()

Return query which retrieves the information of the reference. This query is one of the setting to be entered when creating a database page model. It's typically something like 'SELECT id, name, .. FROM myTable WHERE id = @dbid@ Any column can be returned, though '@dbid@' is predefined and will be replaced on the fly by the database id of the reference.

Returns:

query which retrieves the information of the reference.

getSearchQuery

java.lang.String getSearchQuery()

Return query which is used to search for a reference, e.g. when making a link to a database page in the edit environment, the search string entered in the popup screen is the parameter for this query and its results are presented to the user. This query is one of the setting to be entered when creating a database page model. It's typically something like 'SELECT myId as id,myName as name FROM myTable WHERE myName LIKE '%@search@%' ORDER BY name' Returining both a 'id' and 'name' column is compulsory, the predefined '@search@' will be replaced by the search string.

Returns:

query which is used to search for reference.

getColumns

QueryColumn[] getColumns()

Return the columns which are used for the detail screen.

Returns:

the columns which are used for the detail screen.

getQuery

java.lang.String getQuery()

Return the query which is used to retrieve the title of the database reference with the ID from the Querystring.

Returns:

the query which is used to retrieve the title of the database reference.

getQueryFromID

java.lang.String getQueryFromID(int entryId)

Return the query which is used to retrieve the title of the database reference with a given ID.

Returns:

the query which is used to retrieve the title of the database reference.

getIdentifier

java.lang.String getIdentifier()

Return a string unique among all database entities.

Specified by:

getIdentifier in interface ResourceEntity

Returns:

a string unique among all database entities.