public interface Schema extends TemplateStoreElement, PackagePoolItem
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
Uid type, see
IDProvider.getUid() . |
BLOCKED, MODIFIED, UNMODIFIED
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
Query |
addQuery(String uid) |
TableTemplate |
addTableTemplate(EntityType table,
String uidSuggestion) |
Query |
createQuery(String uidSuggestion,
boolean unifyUidOnServer)
Creates a new query under this schema with the given uidSuggestioni.
|
TableTemplate |
createTableTemplate(EntityType entityType,
String uidSuggestion,
boolean unifyUidOnServer)
Creates a table template under this schema for the given entity type.
|
ReferenceEntry[] |
getIncomingReferences(Entity entity)
Returns current incoming references of the given
entity . |
ReferenceEntry[] |
getIncomingReferences(Entity entity,
boolean release)
Returns current or release incoming references of the given
entity . |
String |
getLayer() |
String |
getLayout() |
Schema |
getOrSchema()
The database schema.
|
ReferenceEntry[] |
getOutgoingReferences(Entity entity)
Returns current outgoing references of the given
entity . |
ReferenceEntry[] |
getOutgoingReferences(Entity entity,
boolean release)
Returns current or release outgoing references of the given
entity . |
Session |
getSession()
Returns the current
or session
Same as getSession(false) . |
Session |
getSession(boolean release)
Returns the
or session . |
boolean |
isReadOnly() |
boolean |
isSyncable() |
void |
resetReadTimestamp()
Resest the read timestamp of the
sessions so that external changes in the database
become visible. |
void |
setLayer(String layerName)
Set the database layer to use for this schema.
|
void |
setLayout(String value) |
void |
setOrSchema(Schema orSchema)
Set the database schema.
|
getSubRootInStore
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
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, setMeta, setMetaFormData, setUid
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, 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, update
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
static final IDProvider.UidType UID_TYPE
IDProvider.getUid()
.@NotNull Session getSession()
or session
Same as getSession(false)
.@NotNull Session getSession(boolean release)
or session
. Use true
to get the release or session
,
false
to get the current or session
.Schema getOrSchema()
void setOrSchema(Schema orSchema)
orSchema
- The database schema to set.String getLayer()
void setLayer(@Nullable String layerName)
String newLayer = ...; String dbSchemaName = ...; schema.setLock(true, false)
; schema.setLayer(newLayer); schema.StoreElement.save()
; // sync layer information de.espirit.or.schema.Schema orSchema = schema.getOrSchema()
; orSchema.setName
(dbSchemaName); schema.setOrSchema
(orSchema); schema.StoreElement.save()
; // sync database information schema.setLock(false, false)
;
layerName
- The layer nameProject.getLayers()
String getLayout() throws IOException
IOException
void setLayout(String value) throws IOException
IOException
TableTemplate addTableTemplate(EntityType table, String uidSuggestion) throws LockException, ElementDeletedException
LockException
ElementDeletedException
TableTemplate createTableTemplate(EntityType entityType, String uidSuggestion, boolean unifyUidOnServer) throws LockException, ElementDeletedException
unifyUidOnServer == true
to unify uid on the server. Otherwise a DuplicateReferenceNameException
will be thrown if a table template with the given uid already exists on the server.entityType
- the entity type to create the table template for (see getOrSchema()
.getEntityType(String)
).uidSuggestion
- the suggestion for the uid for the created table templateunifyUidOnServer
- indicates wether the given uid should be unified on the server or notLockException
- if this schema is locked on the server in a different sessionDuplicateReferenceNameException
- if a table template with the given uid already exists
for this schema and param unifyUidOnServer == false
ElementDeletedException
- if this schema is already deleted on the server.getOrSchema()
,
getEntityType(String)
Query addQuery(String uid) throws IOException, LockException, ElementDeletedException
IOException
LockException
ElementDeletedException
Query createQuery(String uidSuggestion, boolean unifyUidOnServer) throws LockException, ElementDeletedException
unifyUidOnServer == true
to unify uid on the server. Otherwise a DuplicateReferenceNameException
will be thrown if a query or table template with the given uid already exists on the server.uidSuggestion
- the suggestion for the uid for the created table templateunifyUidOnServer
- indicates wether the given uid should be unified on the server or notLockException
- if this schema is locked on the server in a different sessionDuplicateReferenceNameException
- if a query with the given uid already exists
for this schema and param unifyUidOnServer == false
ElementDeletedException
boolean isReadOnly()
boolean isSyncable()
@NotNull ReferenceEntry[] getIncomingReferences(Entity entity)
entity
.entity
- data object@NotNull ReferenceEntry[] getIncomingReferences(Entity entity, boolean release)
entity
.entity
- data objectrelease
- current or release references.@NotNull ReferenceEntry[] getOutgoingReferences(Entity entity)
entity
.entity
- data object@NotNull ReferenceEntry[] getOutgoingReferences(Entity entity, boolean release)
entity
.entity
- data objectrelease
- current or release references.void resetReadTimestamp()
sessions
so that external changes in the database
become visible.Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500