de.innovationgate.webgate.api

Class WGLanguage

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGDesignDocument

de.innovationgate.webgate.api.WGSchemaDocument

de.innovationgate.webgate.api.WGLanguage

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext

public class WGLanguage
extends WGSchemaDocument
implements PageHierarchyNode

A language definion. This language can be used for content.

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_EDITORS
static java.lang.String	META_TITLE
static MetaInfo	METAINFO_EDITORS
static MetaInfo	METAINFO_TITLE

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
WGLanguage(WGDatabase db, WGDocumentCore doc) Constructor.
WGLanguage(WGDatabase wgDatabase, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags)

Method Summary

Methods

Modifier and Type	Method and Description
WGDocument	createClone(WGDatabase db) Creates a clone of this design document in another database
de.innovationgate.utils.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.util.List	getContentCreators() Old version of getEditors().
java.util.List	getEditors() Returns a list of names allowed to edit content for this language.
java.util.Locale	getLocale() Returns a java locale that matches the language code represented by this language definition
java.lang.String	getName() Returns the name of the language, i.e. the code
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.
PageHierarchyNode	getParentNode() Return the parent of this node in hierarchy.
java.lang.String	getTitle() Returns the title of the language, i.e. the human readable description
int	getType() Returns the type of this document as constant WGDocument.TYPE_...
static java.util.Locale	languageNameToLocale(java.lang.String lang) Converts a WGAPI language name to a corresponding java locale
boolean	mayCreateContent() Tests if the current user is allowed to create content in this language - asks pageRightsFilter - checks struct edit rights (hierarchicaly)
boolean	mayCreateContent(WGStructEntry page)
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.
boolean	setContentCreators(java.util.List cc) Deprecated.
void	setEditors(java.util.List cc) Set the people allowed to edit content of this language
boolean	setTitle(java.lang.String value) Set the title of this language.

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, 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, hasFile, hasFileMetadata, hashCode, hasItem, innerAttachFile, 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, 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

Field Detail

META_TITLE

public static final java.lang.String META_TITLE

See Also:

Constant Field Values

METAINFO_TITLE

public static final MetaInfo METAINFO_TITLE

META_EDITORS

public static final java.lang.String META_EDITORS

See Also:

Constant Field Values

METAINFO_EDITORS

public static final MetaInfo METAINFO_EDITORS

Constructor Detail

WGLanguage

public WGLanguage(WGDatabase db,
          WGDocumentCore doc)
           throws WGAPIException

Constructor. Should not be used outside WGAPI.

Parameters:

db -

doc -

Throws:

WGAPIException

WGLanguage

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

Throws:

WGAPIException

Method Detail

languageNameToLocale

public static java.util.Locale languageNameToLocale(java.lang.String lang)

Converts a WGAPI language name to a corresponding java locale

Parameters:

lang -

Returns:

A locale object representing the same language as the WGAPI language code

getName

public java.lang.String getName()
                         throws WGAPIException

Returns the name of the language, i.e. the code

Specified by:

getName in class WGDesignDocument

Throws:

WGAPIException

getTitle

public java.lang.String getTitle()
                          throws WGAPIException

Returns the title of the language, i.e. the human readable description

Throws:

WGAPIException

setTitle

public boolean setTitle(java.lang.String value)
                 throws WGAPIException

Set the title of this language.

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

getEditors

public java.util.List getEditors()
                          throws WGAPIException

Returns a list of names allowed to edit content for this language. If empty, anyone is allowed.

Throws:

WGAPIException

getContentCreators

public java.util.List getContentCreators()
                                  throws WGAPIException

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

Throws:

WGAPIException

setEditors

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

Set the people allowed to edit content of this language

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

mayCreateContent

public boolean mayCreateContent()
                         throws WGAPIException

Tests if the current user is allowed to create content in this language - asks pageRightsFilter - checks struct edit rights (hierarchicaly)

Throws:

WGAPIException

mayCreateContent

public boolean mayCreateContent(WGStructEntry page)
                         throws WGAPIException

Throws:

WGAPIException

getLocale

public java.util.Locale getLocale()
                           throws WGAPIException

Returns a java locale that matches the language code represented by this language definition

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 de.innovationgate.utils.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