de.innovationgate.webgate.api

Class WGDesignDocument

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGDesignDocument

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext

Direct Known Subclasses:

WGDesignResourceDocument, WGSchemaDocument

public abstract class WGDesignDocument
extends WGDocument
implements PageHierarchyNode

Superclass for WGAPI "design documents", i.e. documents that are not directly related to authoring and therefor not editable by pure authors/editors. This does not only contain actual design resource documents, those that are regarded to build an apps design, but does also contain schema documents.

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	META_DESCRIPTION
static java.lang.String	META_DESIGNREFERENCE
static java.lang.String	META_NAME
static java.lang.String	META_VARIANT
static MetaInfo	METAINFO_DESCRIPTION
static MetaInfo	METAINFO_DESIGNREFERENCE
static MetaInfo	METAINFO_NAME
static MetaInfo	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
WGDesignDocument(WGDatabase db, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildDesignDocumentKey(int type, java.lang.String name, java.lang.String mediaKey) Builds a document key for a design document by the given data.
abstract WGDocument	createClone(WGDatabase db) Creates a clone of this design document in another database
WGDocument	createClone(WGDatabase db, WGDocument ref) Creates a clone of this document in another database
java.lang.String	getDescription() Returns the description of this design document
de.innovationgate.wga.config.DesignReference	getDesignReference() Returns a design reference object that uniquely identifies the location of this design
java.lang.String	getMediaKey() The media key of this design document, if any.
abstract java.lang.String	getName() The name of the design document
Lockable	getParentLockable() returns the parent lockable of this lockable for e.g.
boolean	isVariant() Identifies this design document as a variant, i.e. a design from a design provider that may return different data for different databases.
boolean	mayEditDocument() Deprecated. Use WGDocument.maySave()
void	rename(java.lang.String name) Tries to rename the design document.
void	rename(java.lang.String name, java.lang.String mediaKey) Tries to rename the design document.
WGDocumentCore	retrieveCore() (Re-)Retrieves the core object for this document.
boolean	setDescription(java.lang.String desc) Sets a description

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, performSaveCheck, pushData, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, setMetaData, 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

META_NAME

public static final java.lang.String META_NAME

See Also:

Constant Field Values

METAINFO_NAME

public static final MetaInfo METAINFO_NAME

META_VARIANT

public static final java.lang.String META_VARIANT

See Also:

Constant Field Values

METAINFO_VARIANT

public static final MetaInfo METAINFO_VARIANT

META_DESCRIPTION

public static final java.lang.String META_DESCRIPTION

See Also:

Constant Field Values

METAINFO_DESCRIPTION

public static final MetaInfo METAINFO_DESCRIPTION

META_DESIGNREFERENCE

public static final java.lang.String META_DESIGNREFERENCE

See Also:

Constant Field Values

METAINFO_DESIGNREFERENCE

public static final MetaInfo METAINFO_DESIGNREFERENCE

Constructor Detail

WGDesignDocument

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

Constructor. Should not be used outside WGAPI.

Parameters:

db -

doc -

Throws:

WGAPIException

Method Detail

buildDesignDocumentKey

public static java.lang.String buildDesignDocumentKey(int type,
                                      java.lang.String name,
                                      java.lang.String mediaKey)

Builds a document key for a design document by the given data.

Parameters:

type - Type of the design document

name - Name of the design document

mediaKey - Media key of the design document, if any

getMediaKey

public java.lang.String getMediaKey()
                             throws WGAPIException

The media key of this design document, if any.

Throws:

WGAPIException

getName

public abstract java.lang.String getName()
                                  throws WGAPIException

The name of the design document

Throws:

WGAPIException

getDescription

public java.lang.String getDescription()
                                throws WGAPIException

Returns the description of this design document

Throws:

WGAPIException

setDescription

public boolean setDescription(java.lang.String desc)
                       throws WGAPIException

Sets a description

Parameters:

desc -

Throws:

WGAPIException

retrieveCore

public WGDocumentCore retrieveCore()
                            throws WGAPIException

Description copied from class: WGDocument

(Re-)Retrieves the core object for this document.

Throws:

WGAPIException

mayEditDocument

public boolean mayEditDocument()

Deprecated. Use WGDocument.maySave()

Determines, if the currently logged in user may edit this document, judged by his access level.

rename

public void rename(java.lang.String name,
          java.lang.String mediaKey)
            throws WGAPIException

Tries to rename the design document.

Parameters:

name - The new name.

mediaKey - The new media key.

Throws:

WGAPIException

rename

public void rename(java.lang.String name)
            throws WGAPIException

Tries to rename the design document.

Parameters:

name - The new name

Throws:

WGAPIException

createClone

public WGDocument createClone(WGDatabase db,
                     WGDocument ref)
                       throws WGAPIException

Description copied from class: WGDocument

Creates a clone of this document in another database

Specified by:

createClone in class WGDocument

Parameters:

db - The target database

ref - A reference document in the target database. For struct entries, this is the parent entry in the target db. For contents this is the struct entry in the target db.

Returns:

The clone

Throws:

WGAPIException

createClone

public abstract WGDocument createClone(WGDatabase db)
                                throws WGAPIException

Creates a clone of this design document in another database

Parameters:

db - Target database

Returns:

The clone

Throws:

WGAPIException

getParentLockable

public Lockable getParentLockable()

Description copied from interface: Lockable

returns the parent lockable of this lockable for e.g. WGStructEntry in case of WGContent

Specified by:

getParentLockable in interface Lockable

Specified by:

getParentLockable in class WGDocument

isVariant

public boolean isVariant()
                  throws WGAPIException

Identifies this design document as a variant, i.e. a design from a design provider that may return different data for different databases.

Throws:

WGAPIException

getDesignReference

public de.innovationgate.wga.config.DesignReference getDesignReference()
                                                                throws WGAPIException

Returns a design reference object that uniquely identifies the location of this design

Throws:

WGAPIException