Package de.espirit.firstspirit.access.store.templatestore

Interface SchemaContainer

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, StoreElementFolder, Workflowable

All Known Subinterfaces:

SchemaFolder, Schemes

public interface SchemaContainer
extends IDProvider, StoreElementFolder

Interface providing methods for elements which can have schemas as children.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Method Summary

Modifier and Type	Method	Description
Schema	createSchema(String name, String layer)	Same as createSchemaFolder(name, layer, false).
Schema	createSchema(String name, String layer, boolean unifyName)	Factory for a new schema.
SchemaFolder	createSchemaFolder(String name)	Same as createSchemaFolder(name, null).
SchemaFolder	createSchemaFolder(String name, Map<Language,String> lang2DisplayName)	Creates a new SchemaFolder with the given name and displaynames as child of this SchemaContainer.
String[]	getLayerNames()	A layer encapsulates a server data source, ususally a relational database.
TableTemplate	getTableTemplate(long ID)	Returns the table template specified by the given IDProvider.getId() or null if no table template with the given ID exists in this subtree

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

createSchemaFolder

SchemaFolder createSchemaFolder(String name)
                         throws LockException,
ElementDeletedException

Same as createSchemaFolder(name, null).

Returns:

a SchemaFolder

Throws:

LockException - on error

ElementDeletedException - on error

Since:

3.0

createSchemaFolder

SchemaFolder createSchemaFolder(String name,
 Map<Language,String> lang2DisplayName)
                         throws LockException,
ElementDeletedException

Creates a new SchemaFolder with the given name and displaynames as child of this SchemaContainer.

Parameters:

name - the name of the new folder

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

Returns:

the new folder

Throws:

LockException - if this folder is locked in another session

ElementDeletedException - if this folder is already deleted on the server

Since:

4.2.400

createSchema

Schema createSchema(String name,
 String layer)
             throws LockException,
ElementDeletedException

Same as createSchemaFolder(name, layer, false).

Returns:

a de.espirit.firstspirit.access.store.templatestore.Schema

Throws:

ElementDeletedException - on error

LockException - on error

Since:

4.0

createSchema

Schema createSchema(String name,
 String layer,
 boolean unifyName)
             throws LockException,
ElementDeletedException

Factory for a new schema.

Parameters:

name - the schema folder name

layer - the layer name string

unifyName - should the schema folder name be unified

Returns:

a de.espirit.firstspirit.access.store.templatestore.Schema

Throws:

LockException - on error

ElementDeletedException - on error

Since:

4.0

getLayerNames

String[] getLayerNames()

A layer encapsulates a server data source, ususally a relational database. Use this function to get a list of valid layer names.

Returns:

array of valid layer names, possibly empty but not null

Since:

4.0

getTableTemplate

TableTemplate getTableTemplate(long ID)

Returns the table template specified by the given IDProvider.getId() or null if no table template with the given ID exists in this subtree

Parameters:

ID - the ID of the table template

Returns:

the table template or null

Since:

4.0