de.innovationgate.webgate.api

Class WGSchemaDocument

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGDesignDocument

de.innovationgate.webgate.api.WGSchemaDocument

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext

Direct Known Subclasses:

WGArea, WGContentType, WGLanguage

public abstract class WGSchemaDocument
extends WGDesignDocument

Denotes documents defining the content schema of the content store and their shared functionality, explicitly their data redirection to schema definitions

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.webgate.api.WGDocument

WGDocument.Cache, WGDocument.FakeMetaDataContext, WGDocument.SaveAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTDATA_SCHEMADEFINITION

Fields inherited from class de.innovationgate.webgate.api.WGDesignDocument

META_DESCRIPTION, META_DESIGNREFERENCE, META_NAME, META_VARIANT, METAINFO_DESCRIPTION, METAINFO_DESIGNREFERENCE, METAINFO_NAME, METAINFO_VARIANT

Fields inherited from class de.innovationgate.webgate.api.WGDocument

CSFEATURE_EXTDATA, DERIVATE_NAME_PATTERN, DOCKEY_DIVIDER, EXT_PRIMARY_ATTACHMENT, EXTDATA_META_PREFIX, META_CREATED, META_LASTMODIFIED, META_PASTAUTHORS, META_PASTEDITDATES, META_REVISION, METAINFO_CREATED, METAINFO_LASTMODIFIED, METAINFO_PASTAUTHORS, METAINFO_PASTEDITDATES, METAINFO_REVISION, NOONE_ALLOWED, PAGERESTRICTION_ANY, PAGERESTRICTION_FIXEDTYPES, PAGERESTRICTION_NONE, PAGERESTRICTION_UNSPECIFIED, TYPE_ACLENTRY, TYPE_AREA, TYPE_CONTENT, TYPE_CONTENTTYPE, TYPE_CSSJS, TYPE_DBMETADATA, TYPE_FILECONTAINER, TYPE_FILEDERIVATE, TYPE_LANGUAGE, TYPE_STRUCTENTRY, TYPE_TML, TYPE_USERPROFILE, TYPENAME_ACLENTRY, TYPENAME_AREA, TYPENAME_CONTENT, TYPENAME_CONTENTTYPE, TYPENAME_CSSJS, TYPENAME_DBMETADATA, TYPENAME_FILECONTAINER, TYPENAME_FILEDERIVATE, TYPENAME_LANGUAGE, TYPENAME_STRUCTENTRY, TYPENAME_TML, TYPENAME_USERPROFILE

Constructor Summary

Constructors

Constructor and Description
WGSchemaDocument(WGDatabase db, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags)

Method Summary

Methods

Modifier and Type	Method and Description
WGSchemaDocumentDefinition	createSchemaDefinition() Creates a schema definition predefining all the metadata currently on this document
WGSchemaDocumentDefinition	getSchemaDefinition() Returns the schema definition for this document, if available.
boolean	isMetaDeterminedInSchema(java.lang.String name) Returns if the data of the given metadata field is served from schema definition rather than from the database document
void	performSaveCheck() Performs a validation for saving the document at the current state, just like it actually was saved.
boolean	setMetaData(java.lang.String strName, java.lang.Object value) Sets a meta data of this document.

Methods inherited from class de.innovationgate.webgate.api.WGDesignDocument

buildDesignDocumentKey, createClone, createClone, getDescription, getDesignReference, getMediaKey, getName, getParentLockable, isVariant, mayEditDocument, rename, rename, retrieveCore, setDescription

Methods inherited from class de.innovationgate.webgate.api.WGDocument

afterSave, attachAllFiles, attachAllFiles, attachFile, attachFile, attachFile, attachFileWithoutAnnotation, attachFileWithoutAnnotation, autoSave, buildDocumentKey, createFileDerivate, createFileDerivate, docTypeClassToNumber, doctypeNameToNumber, doctypeNumberToClass, doctypeNumberToName, dropCache, dropCore, equals, evaluateExpression, getCore, getCoreRetrieved, getCreated, getDatabase, getDocumentKey, getDocumentKeyObj, getExpectedMetaClass, getExtdataMetaName, getExtensionData, getExtensionDataNames, getFileData, getFileDerivateData, getFileDerivateMetaData, getFileDerivates, getFileLastModified, getFileMetaData, getFileMimeType, getFileMimeTypes, getFileNames, getFileParent, getFileSize, getFileText, getFileText, getItemDate, getItemNames, getItemNumber, getItemText, getItemValue, getItemValueList, getLastModified, getLastUpdates, getLockStatus, getLockStatus, getMetaData, getMetaDataList, getMetaInfo, getMetaInfoByType, getMetaNames, getName, getNativeObject, getObjectCreated, getPastAuthors, getPastEditDates, getPersistentStore, getPrimaryFileName, getRevision, getType, hasFile, hasFileMetadata, hashCode, hasItem, innerAttachFile, isCachingEnabled, isCoreRetrieved, isDeleted, isDeleted, isDummy, isEdited, isListMeta, isSaved, isTemporary, lock, lock, markEdited, markMetaDataModified, mayRemove, mayRemove, maySave, performRemoveCheck, performRemoveCheck, pushData, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, setMetas, setMetaToDefault, setPrimaryFileName, setValues, unlock, unlock, validateMetas, validateMetas, writeExtensionData, writeFileDerivateMetaData

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.innovationgate.webgate.api.PageHierarchyNode

getChildNodeIterator, getChildNodes, getChildNodeType, getNodeKey, getNodeTitle, getParentNode

Field Detail

EXTDATA_SCHEMADEFINITION

public static final java.lang.String EXTDATA_SCHEMADEFINITION

See Also:

Constant Field Values

Constructor Detail

WGSchemaDocument

public WGSchemaDocument(WGDatabase db,
                WGDocumentCore doc,
                de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
                 throws WGAPIException

Throws:

WGAPIException

Method Detail

getSchemaDefinition

public WGSchemaDocumentDefinition getSchemaDefinition()
                                               throws WGAPIException

Returns the schema definition for this document, if available. Otherwise returns null.

Throws:

WGAPIException

isMetaDeterminedInSchema

public boolean isMetaDeterminedInSchema(java.lang.String name)
                                 throws WGAPIException

Returns if the data of the given metadata field is served from schema definition rather than from the database document

Parameters:

name - Name of the metadata field to test

Returns:

true if the data served is from the schema definition, false if it originates from the document in the OpenWGA content store

Throws:

WGAPIException

performSaveCheck

public void performSaveCheck()
                      throws ResourceIsLockedException,
                             WGAPIException

Description copied from class: WGDocument

Performs a validation for saving the document at the current state, just like it actually was saved. This method finishes quietly if the save check succeeded. Otherwise an adequate WGAuthorisationException is thrown. For checking saving permissions without catching an exception see WGDocument.maySave().

Overrides:

performSaveCheck in class WGDocument

Throws:

WGAPIException

ResourceIsLockedException

createSchemaDefinition

public WGSchemaDocumentDefinition createSchemaDefinition()
                                                  throws WGAPIException

Creates a schema definition predefining all the metadata currently on this document

Throws:

WGAPIException

setMetaData

public boolean setMetaData(java.lang.String strName,
                  java.lang.Object value)
                    throws WGAPIException

Description copied from class: WGDocument

Sets a meta data of this document. Since there are "direct" methods for any metadata on the document subclasses, WGAPI users should not use this method directly, but prefer the direct methods. E.g. Use WGContent.setTitle("Home") instead of WGDocument.setMetaData(WGContent.META_TITLE, "Home")

Overrides:

setMetaData in class WGDocument

Parameters:

strName - Name of the meta data. Use constants META_... of WGDocument and all descendant objects.

value - Value to set this metadata

Returns:

True, if the setting succeeded, false otherwise

Throws:

WGAPIException