com.jalios.jcms.workspace
Class WSTypeEntry

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.workspace.WSTypeEntry

All Implemented Interfaces:

JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

public class WSTypeEntry
extends Data

This class is a wrapper on TypeEntry handling type properties for each workspace.

Since:

jcms-5.5.0

Version:

$Revision: 27753 $

Author:

Jean-Philippe Encausse

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorComparator<T extends Data>, Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

protected java.lang.Boolean	advancedTab
protected java.lang.String[]	categories
protected java.lang.Boolean	categoryTab
protected java.lang.String	className
protected java.lang.Boolean	debatable
protected java.util.HashMap<java.lang.String,java.lang.String>	descriptionMap
protected java.lang.String[]	groups
protected java.util.HashMap<java.lang.String,java.lang.String>	labelMap
protected java.lang.Boolean	readRightTab
protected java.lang.Boolean	reviewable
static java.lang.String	REVISION
protected java.lang.String[]	templates
protected java.util.Set<java.lang.String>	templateSet
protected java.lang.Boolean	templateTab
protected java.lang.Class<? extends Publication>	type
protected TypeEntry	typeEntry
protected java.lang.Boolean	updateRightTab
protected boolean	useDefaultCategories
protected boolean	useDefaultGroups
protected java.lang.String	workflowId
protected java.lang.Boolean	workflowTab
protected Workspace	workspace
protected boolean	workspaceForced

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, lockDate, lockMember, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Constructor Summary

WSTypeEntry()

WSTypeEntry(java.lang.Class<? extends Publication> clazz, Workspace workspace)

WSTypeEntry(java.lang.String className, Workspace workspace)

WSTypeEntry(WSTypeEntry clone)

Method Summary

ControllerStatus	checkCreate(Member mbr, java.util.Map context) Checks if the creation can be performed
ControllerStatus	checkCreateUpdate(Member mbr, java.util.Map context) Convenient check for Create and Update.
ControllerStatus	checkMember(int op, Member mbr, java.util.Map context) Checks if the given member can perform the given operation.
ControllerStatus	checkUpdate(Member mbr, java.util.Map context) Checks if the update can be performed
java.lang.Boolean	getAdvancedTab() Returns specific advancedTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
java.lang.String[]	getAvailableCategories() Returns the available categories
java.lang.String	getAvailableDescription(java.lang.String lang) Returns the description of this type in the given language.
java.lang.String[]	getAvailableGroups() Returns the available groups
java.lang.String	getAvailableLabel(java.lang.String lang) Returns the label of this type in the given language or else in the channel's language otherwise it returns an available value in an arbitrary language.
java.lang.String[]	getCategories() Returns specific categories sets for this WSTypeEntry It doesn't return any information from TypeEntry.
java.lang.Boolean	getCategoryTab() Returns specific CategoryTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
TypeEntry	getChannelTypeEntry() Returns the Main TypeEntry defined for a given type.
java.lang.String	getClassName() Returns the name of the class of the given Type for this TypeEntry.
java.lang.Boolean	getDebatable() Returns specific debatable state for this WSTypeEntry It doesn't return any information from TypeEntry.
TypeTemplateEntry	getDefaultTemplateEntry(java.lang.String usage) Returns a default TypeTemplateEntry matching the given usage for the current workspace
java.util.Set<TypeTemplateEntry>	getDefaultTemplateEntrySet() Returns all default template entries
java.util.Set<java.lang.String>	getDefaultTemplateNameSet() Returns all default template names
java.util.Map<java.lang.String,java.lang.String>	getDescriptionMap() Returns the description map ({lang, value}).
TypeTemplateEntry	getFirstTemplateEntry(java.lang.String usage, java.lang.String[] names) Returns the first TypeTemplateEntry from given names matching given usage
java.lang.String[]	getGroups() Returns specific groups sets for this WSTypeEntry It doesn't return any information from TypeEntry.
java.util.Map<java.lang.String,java.lang.String>	getLabelMap() Returns the label map ({lang, value}).
java.lang.Boolean	getReadRightTab() Returns specific ReadRightTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
java.lang.Boolean	getReviewable() Returns specific reviewable state for this WSTypeEntry It doesn't return any information from TypeEntry.
java.lang.String	getTabLabel(java.lang.String tabId, java.lang.String lang) Returns the localized label for the given tab identifier.
TypeTemplateEntry	getTemplateEntry(java.lang.String name) Returns a TypeTemplateEntry matching the given template name
java.util.Set<TypeTemplateEntry>	getTemplateEntrySet(java.lang.String usage) Returns a new Set of TypeTemplateEntry matching the given usage for the current workspace
java.lang.String[]	getTemplates() Returns a Set of display template's name used for this type by this workspace.
java.lang.Boolean	getTemplateTab() Returns specific TemplateTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
java.util.Map<java.lang.String,java.util.Set<TypeTemplateEntry>>	getTemplateUsageMap() Returns a Map of usage/Set of TypeTemplateEntry.
java.lang.Class<? extends Publication>	getType() Returns the type this WSTypeEntry controls.
java.lang.Boolean	getUpdateRightTab() Returns specific UpdateRightTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
boolean	getUseDefaultCategories() Convenient getter to check if specific categories has been set Should only be called by WSTypeEntry_HANDLER
boolean	getUseDefaultGroups() Convenient getter to check if specific groups has been set Should only be called by WSTypeEntry_HANDLER
Workflow	getWorkflow(boolean checkSuperclass) Return the workflow for this given type in given workspace.
java.lang.String	getWorkflowId() Return the name of the workflow for this given type in given workspace.
java.lang.Boolean	getWorkflowTab() Returns specific WorkflowTab state for this WSTypeEntry It doesn't return any information from TypeEntry.
Workspace	getWorkspace() Returns the workspace this WSTypeEntry belongs to.
boolean	hasTemplate(java.lang.String name) Returns true if the WSTypeEntry manage/allow the given template
boolean	isAdvancedTab() Returns the available state of advanced tab
boolean	isCategoryTab() Returns the available state of category tab
boolean	isDebatable() Check if type is debatable for the given workspace.
boolean	isForced() Returns true if this object has been forced for a given workspace but not really exists in the store.
boolean	isReadRightTab() Returns the available state of readRight tab
boolean	isReviewable() Check if type is reviewable for the given workspace
boolean	isSameProperties() Checks if this WSTypeEntry have same properties that it's original TypeEntry.
boolean	isTemplateTab() Returns the available state of template tab
boolean	isUpdateRightTab() Returns the available state of updateRight tab
boolean	isWorkflowTab() Returns the available state of workflow tab
void	performCreate(Member mbr, java.util.Map context) Performs data creation
void	performDelete(Member mbr, java.util.Map context) Performs data deletion
void	setAdvancedTab(java.lang.Boolean isAdvancedTab) Sets specific advancedTab state for this WSTypeEntry
void	setCategories(java.lang.String[] categories) Sets specific categories for this WSTypeEntry
void	setCategoryTab(java.lang.Boolean isCategoryTab) Sets specific categories sets for this WSTypeEntry
void	setClassName(java.lang.String className) Set the classname for the WSTypeEntry This method should ONLY be called by Store to set the TypeEntry.
void	setDebatable(java.lang.Boolean isDebatable) Sets specific debatable state for this WSTypeEntry
void	setDescriptionMap(java.util.HashMap<java.lang.String,java.lang.String> descriptionMap) Sets descriptionMap.
void	setGroups(java.lang.String[] groups) Sets specific groups for this WSTypeEntry
void	setLabelMap(java.util.HashMap<java.lang.String,java.lang.String> labelMap) Sets labelMap.
void	setReadRightTab(java.lang.Boolean isReadRightTab) Sets specific readRightTab state for this WSTypeEntry
void	setReviewable(java.lang.Boolean isReviewable) Sets specific reviewable state for this WSTypeEntry
void	setTemplates(java.lang.String[] templates) Sets all the template's name available in the current workspace for the current type.
void	setTemplateTab(java.lang.Boolean isTemplateTab) Sets specific templateTab state for this WSTypeEntry
void	setUpdateRightTab(java.lang.Boolean isUpdateRightTab) Sets specific updateRightTab state for this WSTypeEntry
void	setUseDefaultCategories(boolean useDefaultCategories)
void	setUseDefaultGroups(boolean useDefaultGroups)
void	setWorkflowId(java.lang.String workflowId) Sets the name of the workflow for this given type in given workspace.
void	setWorkflowTab(java.lang.Boolean isWorkflowTab) Sets specific workflowTab state for this WSTypeEntry
void	setWorkspace(Workspace workspace) Sets the workspace without setting workspaceForced This method should only be called by WorkspaceWizardHandler for clone purpose.
java.lang.String	toFullString()

Methods inherited from class com.jalios.jcms.Data

canRequestLock, checkCreate, checkDelete, checkDelete, checkIntegrity, checkIntegrity, checkLock, checkLockMember, checkStrongLockMember, checkUpdate, checkWrite, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlField, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getComparator, getCSVHeader, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, hashCode, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, initializeDBDataCollections, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performDelete, performUpdate, performUpdate, prepareUpdateContext, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, toCSV, toString, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setCdate, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

typeEntry

protected transient TypeEntry typeEntry

type

protected transient java.lang.Class<? extends Publication> type

workspace

protected transient Workspace workspace

workspaceForced

protected transient boolean workspaceForced

templateSet

protected transient java.util.Set<java.lang.String> templateSet

className

protected java.lang.String className

debatable

protected java.lang.Boolean debatable

reviewable

protected java.lang.Boolean reviewable

categoryTab

protected java.lang.Boolean categoryTab

templateTab

protected java.lang.Boolean templateTab

readRightTab

protected java.lang.Boolean readRightTab

updateRightTab

protected java.lang.Boolean updateRightTab

workflowTab

protected java.lang.Boolean workflowTab

advancedTab

protected java.lang.Boolean advancedTab

categories

protected java.lang.String[] categories

groups

protected java.lang.String[] groups

labelMap

protected java.util.HashMap<java.lang.String,java.lang.String> labelMap

descriptionMap

protected java.util.HashMap<java.lang.String,java.lang.String> descriptionMap

useDefaultCategories

protected boolean useDefaultCategories

useDefaultGroups

protected boolean useDefaultGroups

workflowId

protected java.lang.String workflowId

templates

protected java.lang.String[] templates

Constructor Detail

WSTypeEntry

public WSTypeEntry()

WSTypeEntry

public WSTypeEntry(java.lang.Class<? extends Publication> clazz,
                   Workspace workspace)

WSTypeEntry

public WSTypeEntry(java.lang.String className,
                   Workspace workspace)

WSTypeEntry

public WSTypeEntry(WSTypeEntry clone)

Method Detail

isSameProperties

public boolean isSameProperties()

Checks if this WSTypeEntry have same properties that it's original TypeEntry. This convenient method should be used to check if the Data must be stored/used or deleted. It doesn't check for workflow properties because workflow may leave without WSTypeEntry (backward compatibility)

Returns:

boolean true if there is te same properties.

See Also:

Workspace.setWSTypeEntry(Class, WSTypeEntry)

toFullString

public java.lang.String toFullString()

Overrides:

toFullString in class Data

isForced

public boolean isForced()

Returns true if this object has been forced for a given workspace but not really exists in the store. It is only a convenient wrapper.

Returns:

true if this instance has been forced

checkMember

public ControllerStatus checkMember(int op,
                                    Member mbr,
                                    java.util.Map context)

Description copied from class: Data

Checks if the given member can perform the given operation. This method is called by checkWrite. It should be overrided by sub-classes.

Overrides:

checkMember in class Data

Parameters:

op - the operation (OP_CREATE, OP_UPDATE, ...)

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

See Also:

Data.checkMember(int, Member, Map)

checkCreateUpdate

public ControllerStatus checkCreateUpdate(Member mbr,
                                          java.util.Map context)

Convenient check for Create and Update.

Parameters:

mbr - The Member

context - The context

Returns:

ControllerStatus the status of the check

See Also:

checkCreate(Member, Map), checkUpdate(Member, Map)

checkCreate

public ControllerStatus checkCreate(Member mbr,
                                    java.util.Map context)

Description copied from class: Data

Checks if the creation can be performed

Overrides:

checkCreate in class Data

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

See Also:

Data.checkCreate(Member, Map)

checkUpdate

public ControllerStatus checkUpdate(Member mbr,
                                    java.util.Map context)

Description copied from class: Data

Checks if the update can be performed

Overrides:

checkUpdate in class Data

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

See Also:

Data.checkUpdate(Member, Map)

performCreate

public void performCreate(Member mbr,
                          java.util.Map context)

Description copied from class: Data

Performs data creation

Overrides:

performCreate in class Data

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

See Also:

Data.performCreate(Member, Map)

performDelete

public void performDelete(Member mbr,
                          java.util.Map context)

Description copied from class: Data

Performs data deletion

Overrides:

performDelete in class Data

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

See Also:

Data.performDelete(Member, Map)

getTemplateEntry

public TypeTemplateEntry getTemplateEntry(java.lang.String name)

Returns a TypeTemplateEntry matching the given template name

Parameters:

name - the template name

Returns:

TypeTemplateEntry that describe template

Since:

jcms-6.0.0

See Also:

TypeEntry.getTemplateEntry(String)

getFirstTemplateEntry

public TypeTemplateEntry getFirstTemplateEntry(java.lang.String usage,
                                               java.lang.String[] names)

Returns the first TypeTemplateEntry from given names matching given usage

Parameters:

usage - the template usage

names - an array of templates name

Returns:

TypeTemplateEntry matching

Since:

jcms-6.0.0

See Also:

TypeEntry.getFirstTemplateEntry(String, String[])

getDefaultTemplateEntry

public TypeTemplateEntry getDefaultTemplateEntry(java.lang.String usage)

Returns a default TypeTemplateEntry matching the given usage for the current workspace

Parameters:

usage - the template usage

Returns:

TypeTemplateEntry

Since:

jcms-6.0.0

See Also:

TypeEntry.getDefaultTemplateEntry(String)

getTemplateEntrySet

public java.util.Set<TypeTemplateEntry> getTemplateEntrySet(java.lang.String usage)

Returns a new Set of TypeTemplateEntry matching the given usage for the current workspace

Parameters:

usage - the template usage

Returns:

Set of TypeTemplateEntry

Since:

jcms-6.0.0

getDefaultTemplateEntrySet

public java.util.Set<TypeTemplateEntry> getDefaultTemplateEntrySet()

Returns all default template entries

Returns:

Set of TypeTemplateEntry

Since:

jcms-6.0.1

getDefaultTemplateNameSet

public java.util.Set<java.lang.String> getDefaultTemplateNameSet()

Returns all default template names

Returns:

Set of template names

Since:

jcms-6.0.1

getTemplateUsageMap

public java.util.Map<java.lang.String,java.util.Set<TypeTemplateEntry>> getTemplateUsageMap()

Returns a Map of usage/Set of TypeTemplateEntry.

Returns:

Map of TypeTemplateEntry

hasTemplate

public boolean hasTemplate(java.lang.String name)

Returns true if the WSTypeEntry manage/allow the given template

Parameters:

name - the template name to check

Returns:

true if WSTypeEntry

Since:

jcms-6.0.0

getChannelTypeEntry

public TypeEntry getChannelTypeEntry()

Returns the Main TypeEntry defined for a given type.

Returns:

TypeEntry the channel TypeEntry

getWorkflow

public Workflow getWorkflow(boolean checkSuperclass)

Return the workflow for this given type in given workspace. If there is no workflow then return WorkflowManager.DEFAULT_WORKFLOW If there is no Workspace then return null.

Parameters:

checkSuperclass - check super class

Returns:

String the name of the Workflow

getType

public java.lang.Class<? extends Publication> getType()

Returns the type this WSTypeEntry controls.

Returns:

the type this WSTypeEntry controls.

Since:

jcms-5.5.0

getWorkspace

public Workspace getWorkspace()

Returns the workspace this WSTypeEntry belongs to.

Returns:

the workspace this WSTypeEntry belongs to.

Since:

jcms-5.5.0

setWorkspace

public void setWorkspace(Workspace workspace)

Sets the workspace without setting workspaceForced This method should only be called by WorkspaceWizardHandler for clone purpose.

Parameters:

workspace -

isAdvancedTab

public boolean isAdvancedTab()

Returns the available state of advanced tab

Returns:

boolean true to display advanced Tab

See Also:

TypeEntry.isAdvancedTab()

isCategoryTab

public boolean isCategoryTab()

Returns the available state of category tab

Returns:

boolean true to display category Tab

See Also:

TypeEntry.isCategoryTab()

isDebatable

public boolean isDebatable()

Check if type is debatable for the given workspace.

Returns:

boolean true it type is reviewable

See Also:

TypeEntry.isDebatable()

isReadRightTab

public boolean isReadRightTab()

Returns the available state of readRight tab

Returns:

boolean true to display readRight Tab

See Also:

TypeEntry.isReadRightTab()

isReviewable

public boolean isReviewable()

Check if type is reviewable for the given workspace

Returns:

boolean true it type is reviewable

See Also:

TypeEntry.isReviewable()

isTemplateTab

public boolean isTemplateTab()

Returns the available state of template tab

Returns:

boolean true to display template Tab

See Also:

TypeEntry.isTemplateTab()

isUpdateRightTab

public boolean isUpdateRightTab()

Returns the available state of updateRight tab

Returns:

boolean true to display updateRight Tab

See Also:

TypeEntry.isUpdateRightTab()

isWorkflowTab

public boolean isWorkflowTab()

Returns the available state of workflow tab

Returns:

boolean true to display Workflow Tab

See Also:

TypeEntry.isWorkflowTab()

getAvailableCategories

public java.lang.String[] getAvailableCategories()

Returns the available categories

Returns:

String[] an array of categories

See Also:

TypeEntry.getCategories()

getAvailableGroups

public java.lang.String[] getAvailableGroups()

Returns the available groups

Returns:

String[] an array of groups

See Also:

TypeEntry.getGroups()

getAvailableLabel

public java.lang.String getAvailableLabel(java.lang.String lang)

Returns the label of this type in the given language or else in the channel's language otherwise it returns an available value in an arbitrary language.

Parameters:

lang - the language

Returns:

the label of this type in the given language.

See Also:

TypeEntry.getLabel(String)

getAvailableDescription

public java.lang.String getAvailableDescription(java.lang.String lang)

Returns the description of this type in the given language.

Parameters:

lang - the language

Returns:

the description of this type in the given language.

See Also:

TypeEntry.getDescription(String)

getWorkflowId

public java.lang.String getWorkflowId()

Return the name of the workflow for this given type in given workspace. Should only be called by WSTypeEntry_HANDLER

Returns:

String the name of the Workflow

getClassName

public java.lang.String getClassName()

Returns the name of the class of the given Type for this TypeEntry.

Returns:

String the ClassName

getTemplates

public java.lang.String[] getTemplates()

Returns a Set of display template's name used for this type by this workspace.

Returns:

String[] of template name

getAdvancedTab

public java.lang.Boolean getAdvancedTab()

Returns specific advancedTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isAdvancedTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display advancedTab

See Also:

isAdvancedTab()

getCategories

public java.lang.String[] getCategories()

Returns specific categories sets for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call getAvailableCategories() This method should only be called by WSTypeEntry_HANDLER

Returns:

String[] an array of category ids

See Also:

getAvailableCategories()

getGroups

public java.lang.String[] getGroups()

Returns specific groups sets for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call getAvailableGroups() This method should only be called by WSTypeEntry_HANDLER

Returns:

String[] an array of category ids

See Also:

getAvailableGroups()

getCategoryTab

public java.lang.Boolean getCategoryTab()

Returns specific CategoryTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isCategoryTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display category tab

See Also:

isCategoryTab()

getDebatable

public java.lang.Boolean getDebatable()

Returns specific debatable state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isDebatable() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true if debatable

See Also:

isDebatable()

getLabelMap

public java.util.Map<java.lang.String,java.lang.String> getLabelMap()

Returns the label map ({lang, value}).

Returns:

the label map ({lang, value}).

Since:

jcms-5.7.0

getDescriptionMap

public java.util.Map<java.lang.String,java.lang.String> getDescriptionMap()

Returns the description map ({lang, value}).

Returns:

the description map ({lang, value}).

Since:

jcms-5.7.0

getReadRightTab

public java.lang.Boolean getReadRightTab()

Returns specific ReadRightTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isReadRightTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display ReadRightTab

See Also:

isReadRightTab()

getReviewable

public java.lang.Boolean getReviewable()

Returns specific reviewable state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isReviewable() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true if reviewable

See Also:

isReviewable()

getTemplateTab

public java.lang.Boolean getTemplateTab()

Returns specific TemplateTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isTemplateTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display TemplateTab

See Also:

isTemplateTab()

getUpdateRightTab

public java.lang.Boolean getUpdateRightTab()

Returns specific UpdateRightTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isUpdateRightTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display UpdateRightTab

See Also:

isUpdateRightTab()

getWorkflowTab

public java.lang.Boolean getWorkflowTab()

Returns specific WorkflowTab state for this WSTypeEntry It doesn't return any information from TypeEntry. Developpers should call isWorkflowTab() This method should only be called by WSTypeEntry_HANDLER

Returns:

Boolean true to display WorkflowTab

See Also:

isWorkflowTab()

getUseDefaultCategories

public boolean getUseDefaultCategories()

Convenient getter to check if specific categories has been set Should only be called by WSTypeEntry_HANDLER

Returns:

Boolean

getUseDefaultGroups

public boolean getUseDefaultGroups()

Convenient getter to check if specific groups has been set Should only be called by WSTypeEntry_HANDLER

Returns:

Boolean

getTabLabel

public java.lang.String getTabLabel(java.lang.String tabId,
                                    java.lang.String lang)

Returns the localized label for the given tab identifier.

Parameters:

tabId - the tab identifier

lang - the language

Returns:

the localized label for the given tab identifier.

Since:

jcms-5.7.0

setWorkflowId

public void setWorkflowId(java.lang.String workflowId)

Sets the name of the workflow for this given type in given workspace.

Parameters:

workflowId - the name of the Workflow

setClassName

public void setClassName(java.lang.String className)

Set the classname for the WSTypeEntry This method should ONLY be called by Store to set the TypeEntry.

Parameters:

className - the class name

setTemplates

public void setTemplates(java.lang.String[] templates)

Sets all the template's name available in the current workspace for the current type.

Parameters:

templates - array of template name

setCategories

public void setCategories(java.lang.String[] categories)

Sets specific categories for this WSTypeEntry

See Also:

TypeEntry.setCategories(String[])

setGroups

public void setGroups(java.lang.String[] groups)

Sets specific groups for this WSTypeEntry

See Also:

TypeEntry.setGroups(String[])

setLabelMap

public void setLabelMap(java.util.HashMap<java.lang.String,java.lang.String> labelMap)

Sets labelMap.

Parameters:

labelMap -

Since:

jcms-5.7.0

setDescriptionMap

public void setDescriptionMap(java.util.HashMap<java.lang.String,java.lang.String> descriptionMap)

Sets descriptionMap.

Parameters:

descriptionMap -

Since:

jcms-5.7.0

setAdvancedTab

public void setAdvancedTab(java.lang.Boolean isAdvancedTab)

Sets specific advancedTab state for this WSTypeEntry

See Also:

TypeEntry.setAdvancedTab(boolean)

setWorkflowTab

public void setWorkflowTab(java.lang.Boolean isWorkflowTab)

Sets specific workflowTab state for this WSTypeEntry

See Also:

TypeEntry.setWorkflowTab(boolean)

setUpdateRightTab

public void setUpdateRightTab(java.lang.Boolean isUpdateRightTab)

Sets specific updateRightTab state for this WSTypeEntry

See Also:

TypeEntry.setUpdateRightTab(boolean)

setTemplateTab

public void setTemplateTab(java.lang.Boolean isTemplateTab)

Sets specific templateTab state for this WSTypeEntry

See Also:

TypeEntry.setTemplateTab(boolean)

setReviewable

public void setReviewable(java.lang.Boolean isReviewable)

Sets specific reviewable state for this WSTypeEntry

See Also:

TypeEntry.setReviewable(boolean)

setReadRightTab

public void setReadRightTab(java.lang.Boolean isReadRightTab)

Sets specific readRightTab state for this WSTypeEntry

See Also:

TypeEntry.setReadRightTab(boolean)

setDebatable

public void setDebatable(java.lang.Boolean isDebatable)

Sets specific debatable state for this WSTypeEntry

See Also:

TypeEntry.setDebatable(boolean)

setCategoryTab

public void setCategoryTab(java.lang.Boolean isCategoryTab)

Sets specific categories sets for this WSTypeEntry

See Also:

TypeEntry.setCategoryTab(boolean)

setUseDefaultGroups

public void setUseDefaultGroups(boolean useDefaultGroups)

setUseDefaultCategories

public void setUseDefaultCategories(boolean useDefaultCategories)