de.innovationgate.webgate.api

Class WGContentType

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGDesignDocument

de.innovationgate.webgate.api.WGSchemaDocument

de.innovationgate.webgate.api.WGContentType

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext

public class WGContentType
extends WGSchemaDocument
implements PageHierarchyNode

Formerly referred to as "Doctype", this is a document describing a type of content document. It decides, which design should be used to display it, who may create content of that type and which workflow is needed, before a content document of that type is released.

Nested Class Summary

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

WGDocument.FakeMetaDataContext, WGDocument.SaveAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_ALLOWED_CHILDTYPES
static java.lang.String	META_ALLOWED_POSITIONS
static java.lang.String	META_AUTHORING
static java.lang.String	META_CHILDPAGERESTRICTIONS
static java.lang.String	META_DESCRIPTIONALIASES
static java.lang.String	META_EDITORS
static java.lang.String	META_EVENT_CREATECONTENT
static java.lang.String	META_EVENT_SAVECONTENT
static java.lang.String	META_EVENT_STATUSCHANGE
static java.lang.String	META_EVENT_WORKFLOWMAIL
static java.lang.String	META_INNER_LAYOUT
static java.lang.String	META_NAMEALIASES
static java.lang.String	META_OUTER_LAYOUT
static java.lang.String	META_POSITIONING
static java.lang.String	META_PREFERREDPARENT
static java.lang.String	META_WORKFLOW
static MetaInfo	METAINFO_ALLOWED_CHILDTYPES
static MetaInfo	METAINFO_ALLOWED_POSITIONS
static MetaInfo	METAINFO_AUTHORING
static MetaInfo	METAINFO_CHILDPAGERESTRICTIONS
static MetaInfo	METAINFO_DESCRIPTIONALIASES
static MetaInfo	METAINFO_EDITORS
static MetaInfo	METAINFO_EVENT_CREATECONTENT
static MetaInfo	METAINFO_EVENT_SAVECONTENT
static MetaInfo	METAINFO_EVENT_STATUSCHANGE
static MetaInfo	METAINFO_EVENT_WORKFLOWMAIL
static MetaInfo	METAINFO_INNER_LAYOUT
static MetaInfo	METAINFO_NAMEALIASES
static MetaInfo	METAINFO_OUTER_LAYOUT
static MetaInfo	METAINFO_POSITIONING
static MetaInfo	METAINFO_PREFERREDPARENT
static MetaInfo	METAINFO_WORKFLOW
static java.lang.String	POSITIONING_CHILDENTRIES Content type is allowed in all child entries
static java.lang.String	POSITIONING_EVERYWHERE Content type is allowed everywhere.
static java.lang.String	POSITIONING_FIXEDPARENTS Content type is allowed under special parent documents, specified as allowed positions
static java.lang.String	POSITIONING_FIXEDPARENTTYPES Content type is allowed under parent documents with special content types, specified as allowed positions
static java.lang.String	POSITIONING_ROOTENTRIES Content type is allowed in all root entries.

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

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
WGContentType(WGDatabase db, WGDocumentCore doc) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
WGDocument	createClone(WGDatabase db) Creates a clone of this design document in another database
void	dropCache() Drops the cache of this document.
java.util.List<java.lang.String>	getAllowedChildTypes() Returns the allowed content types for child pages on pages of this type.
java.util.List	getAllowedPositions() Returns the list of allowed positions for content of this type.
SkippingIterator<? extends PageHierarchyNode>	getChildNodeIterator(int pageSize) Returns an iterator for the child nodes of this hierarchy node
java.util.List<PageHierarchyNode>	getChildNodes() Returns the child nodes of this hierarchy node
java.lang.Class	getChildNodeType() Return the class type of child nodes
java.lang.String	getChildPageRestrictions() Returns the restrictions regarding childpages on pages of this content type.
java.util.List	getContentCreators() Deprecated.
java.util.List	getDescriptionAliases() Returns aliases for descriptions in different languages.
java.lang.String	getDescriptionForLanguage(java.lang.String lang) Returns a content type description for the specified language.
java.util.List	getEditors() Returns a list of users allowed to edit content based on this content type.
WGEventScript	getEventContentCreated() Retrieves the event script for event "contentCreated"
WGEventScript	getEventContentSaved() Retrieves the event script for event "contentSaved"
WGEventScript	getEventStatusChange() Retrieves the event script for event "statusChange"
WGEventScript	getEventWorkflowMail() Retrieves the event script for event "workflowMail"
WGTMLModule	getInnerLayout(java.lang.String mediaKey) Returns the inner layout for this content type.
java.lang.String	getInnerLayoutName() Returns the name of WebTML modules used as inner layouts for this content type
java.lang.String	getName() Returns the name of this content type.
java.util.List	getNameAliases() Returns the name aliases for this content type in other languages.
java.lang.String	getNameForLanguage(java.lang.String lang) Returns a content type name for the specified language.
java.lang.String	getNodeKey() Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
java.lang.String	getNodeTitle(java.lang.String language) Returns the display title for the node.
WGTMLModule	getOuterLayout(java.lang.String mediaKey) Returns the outer layout for this content type.
java.lang.String	getOuterLayoutName() Returns the name of WebTML modules used as outer layouts for this content type
PageHierarchyNode	getParentNode() Return the parent of this node in hierarchy.
java.lang.String	getPositioning() Returns in which positions content of this type is allowed.
WGStructEntry	getPreferredParent() Returns the preferred parent for documents of this content type.
int	getType() Returns the type of this document as constant WGDocument.TYPE_...
java.lang.String	getWorkflow() Retrieves the name of the workflow for this content type.
boolean	isAuthoring() Returns if this content type is available for authoring purposes
boolean	mayCreateChildEntry(WGDocument parent) Tests, if the user is allowed to create struct entries in this content type for the given parent, according to this content type.
boolean	mayCreateContent() Tests if the current user may create contents for this content type.
void	performSaveCheck() Performs a validation for saving the document at the current state, just like it actually was saved.
void	pushData(WGDocument doc) Pushed the data of this document to another document of the same type.
void	setAllowedChildTypes(java.util.List<java.lang.String> types) Sets the allowed content types for child pages on pages of this type.
boolean	setAllowedPositions(java.util.List pos) Sets the allowed positions for this content type.
void	setAuthoring(boolean authoring) Sets if this content type should be available for authoring purposes.
void	setChildPageRestrictions(java.lang.String childPages) Sets the restrictions regarding childpages on pages of this content type.
boolean	setContentCreators(java.util.List cc) Deprecated.
boolean	setDescriptionAliases(java.util.List aliases) Sets the description aliases in different languages.
void	setEditors(java.util.List cc) Sets the list of allowed content creators for this content type.
boolean	setEventContentCreated(WGEventScript script) Sets the event script for event "contentCreated"
boolean	setEventContentSaved(WGEventScript script) Sets the event script for event "contentSaved"
boolean	setEventStatusChange(WGEventScript script) Sets the event script for event "statusChange"
boolean	setEventWorkflowMail(WGEventScript script) Sets the event script for event "workflowMail"
boolean	setInnerLayout(WGTMLModule mod) Sets the inner layout for this content type.
boolean	setInnerLayoutName(java.lang.String modName) Sets the inner layout for this content type by specifying the name without reference to the document
boolean	setNameAliases(java.util.List aliases) Sets the name aliases in different languages.
boolean	setOuterLayout(WGTMLModule mod) Sets the outer layout for this content type.
boolean	setOuterLayoutName(java.lang.String modName) Sets the outer layout for this content type by specifying the name without reference to the document
boolean	setPositioning(java.lang.String pos) Sets the allowed positioning of content of this content type.
boolean	setPreferredParent(WGStructEntry parent) Sets the preferred parent for documents of this content type.
boolean	setWorkflow(java.lang.String name) Sets the workflow name of this content type.

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

createSchemaDefinition, getSchemaDefinition, isMetaDeterminedInSchema, setMetaData

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

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

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

afterSave, attachAllFiles, attachAllFiles, attachFile, attachFile, attachFile, buildDocumentKey, createFileDerivate, createFileDerivate, docTypeClassToNumber, doctypeNameToNumber, doctypeNumberToClass, doctypeNumberToName, dropCore, equals, evaluateExpression, extractFile, 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, hasFile, hasFileMetadata, hashCode, hasItem, isCachingEnabled, isCoreRetrieved, isDeleted, isDeleted, isDummy, isEdited, isListMeta, isSaved, isTemporary, lock, lock, markEdited, markMetaDataModified, mayRemove, mayRemove, maySave, performRemoveCheck, performRemoveCheck, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItemValue, setMetaToDefault, setPrimaryFileName, unlock, unlock, validateMetas, validateMetas, writeExtensionData, writeFileDerivateMetaData

Methods inherited from class java.lang.Object

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

Field Detail

POSITIONING_EVERYWHERE

public static final java.lang.String POSITIONING_EVERYWHERE

Content type is allowed everywhere.

See Also:

Constant Field Values

POSITIONING_ROOTENTRIES

public static final java.lang.String POSITIONING_ROOTENTRIES

Content type is allowed in all root entries.

See Also:

Constant Field Values

POSITIONING_CHILDENTRIES

public static final java.lang.String POSITIONING_CHILDENTRIES

Content type is allowed in all child entries

See Also:

Constant Field Values

POSITIONING_FIXEDPARENTS

public static final java.lang.String POSITIONING_FIXEDPARENTS

Content type is allowed under special parent documents, specified as allowed positions

See Also:

Constant Field Values

POSITIONING_FIXEDPARENTTYPES

public static final java.lang.String POSITIONING_FIXEDPARENTTYPES

Content type is allowed under parent documents with special content types, specified as allowed positions

See Also:

Constant Field Values

META_WORKFLOW

public static final java.lang.String META_WORKFLOW

See Also:

Constant Field Values

METAINFO_WORKFLOW

public static final MetaInfo METAINFO_WORKFLOW

META_OUTER_LAYOUT

public static final java.lang.String META_OUTER_LAYOUT

See Also:

Constant Field Values

METAINFO_OUTER_LAYOUT

public static final MetaInfo METAINFO_OUTER_LAYOUT

META_INNER_LAYOUT

public static final java.lang.String META_INNER_LAYOUT

See Also:

Constant Field Values

METAINFO_INNER_LAYOUT

public static final MetaInfo METAINFO_INNER_LAYOUT

META_EDITORS

public static final java.lang.String META_EDITORS

See Also:

Constant Field Values

METAINFO_EDITORS

public static final MetaInfo METAINFO_EDITORS

META_ALLOWED_POSITIONS

public static final java.lang.String META_ALLOWED_POSITIONS

See Also:

Constant Field Values

METAINFO_ALLOWED_POSITIONS

public static final MetaInfo METAINFO_ALLOWED_POSITIONS

META_POSITIONING

public static final java.lang.String META_POSITIONING

See Also:

Constant Field Values

METAINFO_POSITIONING

public static final MetaInfo METAINFO_POSITIONING

META_CHILDPAGERESTRICTIONS

public static final java.lang.String META_CHILDPAGERESTRICTIONS

See Also:

Constant Field Values

METAINFO_CHILDPAGERESTRICTIONS

public static final MetaInfo METAINFO_CHILDPAGERESTRICTIONS

META_ALLOWED_CHILDTYPES

public static final java.lang.String META_ALLOWED_CHILDTYPES

See Also:

Constant Field Values

METAINFO_ALLOWED_CHILDTYPES

public static final MetaInfo METAINFO_ALLOWED_CHILDTYPES

META_EVENT_CREATECONTENT

public static final java.lang.String META_EVENT_CREATECONTENT

See Also:

Constant Field Values

METAINFO_EVENT_CREATECONTENT

public static final MetaInfo METAINFO_EVENT_CREATECONTENT

META_EVENT_SAVECONTENT

public static final java.lang.String META_EVENT_SAVECONTENT

See Also:

Constant Field Values

METAINFO_EVENT_SAVECONTENT

public static final MetaInfo METAINFO_EVENT_SAVECONTENT

META_EVENT_WORKFLOWMAIL

public static final java.lang.String META_EVENT_WORKFLOWMAIL

See Also:

Constant Field Values

METAINFO_EVENT_WORKFLOWMAIL

public static final MetaInfo METAINFO_EVENT_WORKFLOWMAIL

META_EVENT_STATUSCHANGE

public static final java.lang.String META_EVENT_STATUSCHANGE

See Also:

Constant Field Values

METAINFO_EVENT_STATUSCHANGE

public static final MetaInfo METAINFO_EVENT_STATUSCHANGE

META_NAMEALIASES

public static final java.lang.String META_NAMEALIASES

See Also:

Constant Field Values

METAINFO_NAMEALIASES

public static final MetaInfo METAINFO_NAMEALIASES

META_DESCRIPTIONALIASES

public static final java.lang.String META_DESCRIPTIONALIASES

See Also:

Constant Field Values

METAINFO_DESCRIPTIONALIASES

public static final MetaInfo METAINFO_DESCRIPTIONALIASES

META_PREFERREDPARENT

public static final java.lang.String META_PREFERREDPARENT

See Also:

Constant Field Values

METAINFO_PREFERREDPARENT

public static final MetaInfo METAINFO_PREFERREDPARENT

META_AUTHORING

public static final java.lang.String META_AUTHORING

See Also:

Constant Field Values

METAINFO_AUTHORING

public static final MetaInfo METAINFO_AUTHORING

Constructor Detail

WGContentType

public WGContentType(WGDatabase db,
             WGDocumentCore doc)
              throws WGAPIException

Constructor. Should not be used outside the WGAPI.

Throws:

WGAPIException

Method Detail

dropCache

public void dropCache()
               throws WGAPIException

Description copied from class: WGDocument

Drops the cache of this document.

Overrides:

dropCache in class WGDocument

Throws:

WGAPIException

getName

public java.lang.String getName()
                         throws WGAPIException

Returns the name of this content type.

Specified by:

getName in class WGDesignDocument

Throws:

WGAPIException

getNameForLanguage

public java.lang.String getNameForLanguage(java.lang.String lang)
                                    throws WGAPIException

Returns a content type name for the specified language. This method first searches the aliases for a matching name. If none is found the default name of the content type is returned.

Parameters:

lang -

Returns:

The content type name in the given language or default if not available in this language

Throws:

WGAPIException

getDescriptionForLanguage

public java.lang.String getDescriptionForLanguage(java.lang.String lang)
                                           throws WGAPIException

Returns a content type description for the specified language. This method first searches the aliases for a matching description. If none is found the default description of the content type is returned.

Parameters:

lang -

Returns:

The content type description in the given language or default if not available in this language

Throws:

WGAPIException

getOuterLayout

public WGTMLModule getOuterLayout(java.lang.String mediaKey)
                           throws WGAPIException

Returns the outer layout for this content type.

Parameters:

mediaKey - The media key of the needed layout.

Returns:

WGTMLModule

Throws:

WGAPIException

getOuterLayoutName

public java.lang.String getOuterLayoutName()
                                    throws WGAPIException

Returns the name of WebTML modules used as outer layouts for this content type

Throws:

WGAPIException

getInnerLayoutName

public java.lang.String getInnerLayoutName()
                                    throws WGAPIException

Returns the name of WebTML modules used as inner layouts for this content type

Throws:

WGAPIException

setOuterLayout

public boolean setOuterLayout(WGTMLModule mod)
                       throws WGAPIException

Sets the outer layout for this content type. Only the name of the given tml module is taken. The media key will not be fixed to the modules' one.

Parameters:

mod - The module, whose name will be taken as outer layout.

Throws:

WGAPIException

setOuterLayoutName

public boolean setOuterLayoutName(java.lang.String modName)
                           throws WGAPIException

Sets the outer layout for this content type by specifying the name without reference to the document

Parameters:

modName - The name of the WebTML module representing outer layout

Throws:

WGAPIException

getInnerLayout

public WGTMLModule getInnerLayout(java.lang.String mediaKey)
                           throws WGAPIException

Returns the inner layout for this content type.

Parameters:

mediaKey - The media key of the needed layout

Returns:

WGTMLModule

Throws:

WGAPIException

setInnerLayout

public boolean setInnerLayout(WGTMLModule mod)
                       throws WGAPIException

Sets the inner layout for this content type. Only the name of the given tml module is taken. The media key will not be fixed to the modules' one.

Parameters:

mod - The module, whose name will be taken as inner layout.

Throws:

WGAPIException

setInnerLayoutName

public boolean setInnerLayoutName(java.lang.String modName)
                           throws WGAPIException

Sets the inner layout for this content type by specifying the name without reference to the document

Parameters:

modName - Name of the WebTML module to use for inner layout

Throws:

WGAPIException

getEditors

public java.util.List getEditors()
                          throws WGAPIException

Returns a list of users allowed to edit content based on this content type.

Returns:

List

Throws:

WGAPIException

getContentCreators

public java.util.List getContentCreators()
                                  throws WGAPIException

Deprecated.

Old version of getEditors(). Avoid in new developments.

Throws:

WGAPIException

setEditors

public void setEditors(java.util.List cc)
                throws WGAPIException

Sets the list of allowed content creators for this content type.

Parameters:

cc -

Throws:

WGAPIException

setContentCreators

public boolean setContentCreators(java.util.List cc)
                           throws WGAPIException

Deprecated.

Old version of setEditors(List). Avoid in new developments.

Parameters:

cc -

Throws:

WGAPIException

mayCreateChildEntry

public boolean mayCreateChildEntry(WGDocument parent)
                            throws WGAPIException

Tests, if the user is allowed to create struct entries in this content type for the given parent, according to this content type. Note that this only checks the restrictions of this content type regarding its possible parent, not its restrictions about possible children.

Parameters:

parent - A struct entry or an area, that should be the parent for the new entry

Throws:

WGAPIException

mayCreateContent

public boolean mayCreateContent()
                         throws WGAPIException

Tests if the current user may create contents for this content type.

Returns:

boolean

Throws:

WGAPIException

getPositioning

public java.lang.String getPositioning()
                                throws WGAPIException

Returns in which positions content of this type is allowed.

Throws:

WGAPIException

setPositioning

public boolean setPositioning(java.lang.String pos)
                       throws WGAPIException

Sets the allowed positioning of content of this content type. Must be a constant WGContentType.POSITIONING_...

Parameters:

pos -

Throws:

WGAPIException

getAllowedPositions

public java.util.List getAllowedPositions()
                                   throws WGAPIException

Returns the list of allowed positions for content of this type. If positioning is set to POSITIONING_FIXEDPARENTS, these are the struct keys of the allowed parents. If positioning is set to POSITIONING_FIXEDPARENTTYPES, these are the content types, that the parents must be of.

Throws:

WGAPIException

setAllowedPositions

public boolean setAllowedPositions(java.util.List pos)
                            throws WGAPIException

Sets the allowed positions for this content type. Only valid when positioning is of Type WGContentType.POSITIONING_FIXED...

Parameters:

pos -

Throws:

WGAPIException

createClone

public WGDocument createClone(WGDatabase db)
                       throws WGAPIException

Description copied from class: WGDesignDocument

Creates a clone of this design document in another database

Specified by:

createClone in class WGDesignDocument

Parameters:

db - Target database

Returns:

The clone

Throws:

WGAPIException

pushData

public void pushData(WGDocument doc)
              throws WGAPIException

Description copied from class: WGDocument

Pushed the data of this document to another document of the same type. This method is allowed to save the target document if necessary, but is not required to.

Overrides:

pushData in class WGDocument

Parameters:

doc - The target document receiving the data.

Throws:

WGAPIException - If something goes wrong

getWorkflow

public java.lang.String getWorkflow()
                             throws WGAPIException

Retrieves the name of the workflow for this content type.

Throws:

WGAPIException

setWorkflow

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

Sets the workflow name of this content type.

Parameters:

name -

Throws:

WGAPIException

getNameAliases

public java.util.List getNameAliases()
                              throws WGAPIException

Returns the name aliases for this content type in other languages. For format see "setNameAliases"

Throws:

WGAPIException

setNameAliases

public boolean setNameAliases(java.util.List aliases)
                       throws WGAPIException

Sets the name aliases in different languages. Aliases are specified as list. Every list entry represents a different language. Format is: languagecode:Name-in-Language-Version Example: en:My Content type de:Mein Seitentyp fr:French for "My Content Type" (Sorry, my french does not go far beyond "Bonjour!")

Parameters:

aliases -

Throws:

WGAPIException

getDescriptionAliases

public java.util.List getDescriptionAliases()
                                     throws WGAPIException

Returns aliases for descriptions in different languages. For format see "setNameAliases"

Throws:

WGAPIException

setDescriptionAliases

public boolean setDescriptionAliases(java.util.List aliases)
                              throws WGAPIException

Sets the description aliases in different languages. For format see "setNameAliases"

Parameters:

aliases -

Throws:

WGAPIException

getEventContentCreated

public WGEventScript getEventContentCreated()
                                     throws WGAPIException

Retrieves the event script for event "contentCreated"

Returns:

WGEventScript-Object for this event

Throws:

WGAPIException

getEventStatusChange

public WGEventScript getEventStatusChange()
                                   throws WGAPIException

Retrieves the event script for event "statusChange"

Returns:

WGEventScript-Object for this event

Throws:

WGAPIException

getEventContentSaved

public WGEventScript getEventContentSaved()
                                   throws WGAPIException

Retrieves the event script for event "contentSaved"

Returns:

WGEventScript-Object for this event

Throws:

WGAPIException

getEventWorkflowMail

public WGEventScript getEventWorkflowMail()
                                   throws WGAPIException

Retrieves the event script for event "workflowMail"

Returns:

WGEventScript-Object for this event

Throws:

WGAPIException

setEventContentCreated

public boolean setEventContentCreated(WGEventScript script)
                               throws WGAPIException

Sets the event script for event "contentCreated"

Parameters:

script - The script to execute for this event

Returns:

true if storage succeeded, false otherwise

Throws:

WGAPIException

setEventContentSaved

public boolean setEventContentSaved(WGEventScript script)
                             throws WGAPIException

Sets the event script for event "contentSaved"

Parameters:

script - The script to execute for this event

Returns:

true if storage succeeded, false otherwise

Throws:

WGAPIException

setEventWorkflowMail

public boolean setEventWorkflowMail(WGEventScript script)
                             throws WGAPIException

Sets the event script for event "workflowMail"

Parameters:

script - The script to execute for this event

Returns:

true if storage succeeded, false otherwise

Throws:

WGAPIException

setEventStatusChange

public boolean setEventStatusChange(WGEventScript script)
                             throws WGAPIException

Sets the event script for event "statusChange"

Parameters:

script - The script to execute for this event

Returns:

true if storage succeeded, false otherwise

Throws:

WGAPIException

getPreferredParent

public WGStructEntry getPreferredParent()
                                 throws WGAPIException

Returns the preferred parent for documents of this content type. This information is used by WGA Content Clients, which cannot determine the position for the new content (e.g. WGA Word Client). When these clients use this content type, the new content is placed under the document specified here.

Throws:

WGAPIException

setPreferredParent

public boolean setPreferredParent(WGStructEntry parent)
                           throws WGAPIException

Sets the preferred parent for documents of this content type. This information is used by WGA Content Clients, which cannot determine the position for the new content (e.g. WGA Word Client). When these clients use this content type, the new content is placed under the document specified here.

Parameters:

parent - The parent struct entry to prefer

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 WGSchemaDocument

Throws:

WGAPIException

ResourceIsLockedException

getChildNodes

public java.util.List<PageHierarchyNode> getChildNodes()
                                                throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the child nodes of this hierarchy node

Specified by:

getChildNodes in interface PageHierarchyNode

Throws:

WGAPIException

getChildNodeIterator

public SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                   throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns an iterator for the child nodes of this hierarchy node

Specified by:

getChildNodeIterator in interface PageHierarchyNode

Parameters:

pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise

Throws:

WGAPIException

getChildNodeType

public java.lang.Class getChildNodeType()

Description copied from interface: PageHierarchyNode

Return the class type of child nodes

Specified by:

getChildNodeType in interface PageHierarchyNode

getNodeKey

public java.lang.String getNodeKey()
                            throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.

Specified by:

getNodeKey in interface PageHierarchyNode

Throws:

WGAPIException

getNodeTitle

public java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.

Specified by:

getNodeTitle in interface PageHierarchyNode

Parameters:

language - The language whose title is wanted

Returns:

The title

Throws:

WGAPIException

getParentNode

public PageHierarchyNode getParentNode()
                                throws WGAPIException

Description copied from interface: PageHierarchyNode

Return the parent of this node in hierarchy. Return null at the root level.

Specified by:

getParentNode in interface PageHierarchyNode

Throws:

WGAPIException

getType

public int getType()

Description copied from class: WGDocument

Returns the type of this document as constant WGDocument.TYPE_...

Specified by:

getType in class WGDocument

isAuthoring

public boolean isAuthoring()
                    throws WGAPIException

Returns if this content type is available for authoring purposes

Throws:

WGAPIException

setAuthoring

public void setAuthoring(boolean authoring)
                  throws WGAPIException

Sets if this content type should be available for authoring purposes. Set false to prohibit its use in authoring clients like Content Manager.

Parameters:

authoring -

Throws:

WGAPIException

getChildPageRestrictions

public java.lang.String getChildPageRestrictions()
                                          throws WGAPIException

Returns the restrictions regarding childpages on pages of this content type. Returns constants PAGERESTRICTION_...

Throws:

WGAPIException

setChildPageRestrictions

public void setChildPageRestrictions(java.lang.String childPages)
                              throws WGAPIException

Sets the restrictions regarding childpages on pages of this content type.

Parameters:

childPages - Restriction string. Use constants PAGERESTRICTION_...

Throws:

WGAPIException

getAllowedChildTypes

public java.util.List<java.lang.String> getAllowedChildTypes()
                                                      throws WGAPIException

Returns the allowed content types for child pages on pages of this type. Only effective when getChildPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES

Throws:

WGAPIException

setAllowedChildTypes

public void setAllowedChildTypes(java.util.List<java.lang.String> types)
                          throws WGAPIException

Sets the allowed content types for child pages on pages of this type. Only effective when getChildPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES

Parameters:

types - Names of content types

Throws:

WGAPIException