com.jalios.jcms.workspace
Class Workspace

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

All Implemented Interfaces:

EditableData, JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, LangPropertyArgument, Cloneable, Comparable<BasicStorable>

public class Workspace
extends Data
implements EditableData

This class represents a Workspace

Since:

jcms-4.1

Version:

$Revision: 68274 $

Author:

Jean-Philippe Encausse

Nested Class Summary

static class	Workspace.CollaborativeSpaceSelector Select workspace that are Collaborative Spaces.
static class	Workspace.GroupSizeComparator<T extends Workspace>
static class	Workspace.MemberSizeComparator<T extends Workspace>
static class	Workspace.ModelWorkspaceSelector Select model workspaces.
static class	Workspace.NameComparator<T extends Workspace>
static class	Workspace.OpenWorkspaceSelector Select open workspaces.
static class	Workspace.OrderComparator<T extends Workspace>
static class	Workspace.TextSelector Select a set of workspace matching the given text in the Title.
static class	Workspace.TitleSelector Select a set of workspace by their name.

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 ArrayList<Member>	administrators
protected int	alertThreshold
static String	ALL_WORKSPACE_ICON
protected Data	cachedHomeData
protected HashSet<Category>	catSet
protected HashMap<Class<?>,Set<Publication>>	classPubSetMap
protected static Map<String,Set<String>>	cssGlobalMap
protected FileAnalyzerThread	currentAnalyzerThread
protected Group	defaultGroup
protected String	email
protected WorkspaceFileAnalyzer	fileAnalyzer
protected String[]	globalCSS
protected TreeSet<Group>	groupSet
protected HashMap<Class<?>,Set<String>>	instanceWorkflowGroupMap
protected HashMap<Class<?>,Set<String>>	instanceWorkflowIdMap
protected boolean	isClosed
protected boolean	isModel
protected String	language
static String	LAST_QUOTA_NOTIFICATION_DATE
protected long	lastQuotaNotificationDate
protected int	order
protected Workspace	parent
static String	PARENT_WORKSPACE_PARAMNAME
protected WorkspaceFileAnalyzer	previousFileAnalyzer
protected TreeSet<Publication>	pubSet
protected long	quota
protected QuotaElement	quotaAlert
static String	REVISION
protected HashMap<String,WKRole>	roleMap
protected Category	tagRoot
protected String	title
protected HashMap<String,String>	titleML
protected HashMap<Class<?>,Object>	typeMap
protected boolean	useDefaultQuota
protected HashMap<Class<?>,Boolean>	wfByInstanceMap
static String	WORKSPACE_CLOSED_ICON
static String	WORKSPACE_CS_ICON
static String	WORKSPACE_CS_MODEL_ICON
static String	WORKSPACE_ICON
static String	WORKSPACE_MODEL_CLOSED_ICON
static String	WORKSPACE_MODEL_ICON

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, 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, 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

Workspace()

Workspace(Workspace other)

Method Summary

boolean	canPublish(Class clazz) Checks if the given class can be published in this workspace.
ControllerStatus	checkCreate(Member mbr, Map context) Checks if the creation can be performed
ControllerStatus	checkDelete(Member mbr, Map context) Checks if the deletion can be performed
ControllerStatus	checkIntegrity() Checks whether or not data integrity constraints are respected.
ControllerStatus	checkMember(int op, Member mbr, Map context) Checks if the given member can perform the given operation.
ControllerStatus	checkUpdate(Member mbr, Map context) Checks if the update can be performed
ControllerStatus	checkWrite(int op, Member mbr, boolean checkIntegrity, Map context) Checks if the given write operation can be performed
void	exportXmlField(StringBuffer sb, int indentLevel) Fills the given StringBuffer with Xml export of fields of this data.
protected void	exportXmlRelated(StringBuffer sb, String related, int indentLevel)
void	flushHomeUrl() Reset the cache of the home category.
ArrayList<Member>	getAdministrators()
int	getAlertThreshold()
Set<Workspace>	getAllSubWorkspaces() Return all the descendant Workspaces of the current Workspace.
Set<Workspace>	getAllSubWorkspaces(Member loggedMember) Return all the descendant Workspaces of the current Workspace. If the loggedMember parameter is not null, only Workspaces for which the Member is Worker are returned.
static SortedSet<Workspace>	getAllWorkingWorkspaceSet(Member loggedMember, JcmsContext jcmsContext) Gives the list of workspaces for which the current loggedMember is a worker.
static Set<Workspace>	getAllWorkspaceSet() Returns a Set with all workspace, model or not.
static Set<Workspace>	getAllWorkspaceSet(Member member) Returns a Set of workspace, for the given member.
static Set<Workspace>	getAllWorkspaceSetModel() Returns a Set with all workspace model.
static Set<Workspace>	getAllWorkspaceSetWithoutModel() Returns a Set with all workspace without workspace model.
HashSet<Category>	getCatSet()
Set<Category>	getCatSet(Member mbr) Gives the root categories for this Workspace, that the given member may read.
HashMap<Class<?>,Set<Publication>>	getClassPubSetMap()
static Comparator<Workspace>	getComparator(String str, boolean reverse) Deprecated. use ComparatorManager
static String	getCSVHeader(String lang) Returns the CSV header of this object
FileAnalyzerThread	getCurrentAnalyzerThread() Return the current analyzer thread if analyze is in progress
String	getDataName(String language) Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.
Group	getDefaultGroup() Returns the default group for this workspace.
Group	getDefaultGroup(boolean search) Returns the default group for this workspace.
String	getEmail()
WorkspaceFileAnalyzer	getFileAnalyzer(boolean refresh) returns WorkspaceFileAnalyzer instance associated with this workspace.
ObjectLongTreeMap	getFileSizeMap(boolean refresh) Returns the map file size for each content-type.
Category	getFirstWorkspaceCat(Category cat) Returns first workspace category mathching (or parent) given category.
String	getFullEmail() Returns the full email in the form "WorkspaceTitle ".
String	getFullEmail(String lang) Returns the full email in the form "WorkspaceTitle ".
String[]	getGlobalCSS() Getter for globalCSS
Set<String>	getGlobalWYSIWYGStyle() Returns a Set of global style for the current workspace.
static Map<String,Set<String>>	getGlobalWYSIWYGStyleMap()
TreeSet<Group>	getGroupSet()
static Comparator<Workspace>	getGroupSizeComparator(String lang) Returns a new Comparator instance to compare workspace based on the number of groups in each workspace.
String	getHomeUrl(Locale userLocale) Returns the home url for the given workspace calculated from portal categories that belongs to workspace
protected Category	getHomeUrlVisitor(Collection<Category> collect, Set<Publication> portalSet) Internal methods to check home url
String	getIcon() Returns the image path icon for the given workspace
HashMap<Class<?>,Set<String>>	getInstanceWorkflowGroupMap()
HashMap<Class<?>,Set<String>>	getInstanceWorkflowIdMap()
String	getLanguage()
long	getLastQuotaNotificationDate()
Set<String>	getLocalWYSIWYGStyle(String global) Returns a Set of local style for a given global style
Set<Member>	getMemberSet() Returns a set of members that belongs to groups of this workspace.
Set<Member>	getMemberSet(boolean includeDBMember) Returns a set of members that belongs to groups of this workspace.
static Comparator<Workspace>	getMemberSizeComparator(String lang) Returns a new Comparator instance to compare workspace based on the number of members in each workspace.
static Comparator<Workspace>	getNameComparator(String lang) Returns a new Comparator instance to compare workspace based on their title.
int	getOrder()
static Comparator<Workspace>	getOrderComparator(String lang) Returns a new Comparator instance to compare workspace based on their order.
Workspace	getParent()
Workspace	getParent(Member loggedMember) Get the Parent workspace from the one in parameter, if loggedMember is not null, the WS is return only if he is worker of it.
WorkspaceFileAnalyzer	getPreviousFileAnalyzer() returns previous WorkspaceFileAnalyzer instance associated with this workspace if any.
<T extends Publication> Set<T>	getPublicationSet(Class<?> clazz) Return all publication for a given Clazz
<T extends Publication> Set<T>	getPublicationSet(Class<?> clazz, boolean specialState) Return all the publication in/not a special state for the given class
Set<Publication>	getPublicationSet(Workflow workflow) Return all publication for a given Workflow
Set<Publication>	getPublicationSet(Workflow workflow, boolean specialState) Return all the publication in/not a special state for the given Workflow
TreeSet<Publication>	getPubSet()
long	getQuota()
QuotaElement	getQuotaAlert()
static Workspace	getRequestWorkspace(javax.servlet.http.HttpServletRequest request) Get the workspace stored in the request
WKRole	getRole(String wfRoleId) Get the WKRole linked to a WFRole for a given Workflow
WKRole	getRole(WFRole wfRole) Get the WKRole linked to a WFRole for a given Workflow
HashMap<String,WKRole>	getRoleMap() Getter of RoleMap
static Set<Workspace>	getRootWorkspaces(Comparator<Workspace> comparator) All Workspaces with no parent, sorted with comparator if not null.
static Set<Workspace>	getRootWorkspaces(Comparator<Workspace> comparator, Member loggedMember) All Workspaces with no parent the loggedMember in parameter belongs to, sorted with comparator if not null.
static Workspace	getSessionWorkspace(javax.servlet.http.HttpSession session) Get the workspace stored in the session
Set<Workspace>	getSubWorkspaces() Gives the set of all WS just under the ws in parameter.
Set<Workspace>	getSubWorkspaces(Member loggedMember) Return the workspaces just under the workspace in parameter.
Category	getTagRoot()
String	getTitle() Get the value of title.
String	getTitle(String lang) Get the value of title bound to the given language.
String	getTitle(String lang, boolean useDefault) Get the value of title bound to the given language.
HashMap<String,String>	getTitleML() Retrieve the HashMap containing the titles of this Workspace in language other than the main site language.
String	getTypeDescription(Class clazz, String lang) Returns the description for the given type (class) in the given language.
String	getTypeLabel(Class clazz, String lang) Returns the label for the given type (class) in the given language.
HashMap<Class<?>,Object>	getTypeMap() Getter of TypeMap
Set<Class<?>>	getTypeSet() Returns a Set of all visible types
boolean	getUseDefaultQuota()
HashMap<Class<?>,Boolean>	getWfByInstanceMap()
WFRole	getWFRole(WKRole wkRole) Returns the WFRole bound to the given WKRole.
Set<String>	getWFRoleIdSet() Return a set of all WFRoleId
Set<WFRole>	getWFRoleSet() Return a set of all WFRole
Set<WKRole>	getWKRoleSet() Return a set of all WKRole
Set<WKRole>	getWKRoleSet(Class clazz) Return all the WKRole for a given Class
Set<WKRole>	getWKRoleSet(Workflow wf) Return all the WKRole for a given Workflow
Workflow	getWorkflow(Class clazz) Find the Worflow associated to the given class.
Workflow	getWorkflow(Class<?> clazz, boolean checkSuperclass) Find the Worflow associated to the given class or one of it's super class.
Set<Workflow>	getWorkflowSet() Returns a Set of all workflow used by calling getWorkflow(clazz,false) on all clazz.
WSTypeEntry	getWSTypeEntry(Class clazz) Returns a WSTypeEntry describing custom properties for a given type in a given workspace.
WSTypeEntry	getWSTypeEntry(String className) Returns a WSTypeEntry describing custom properties for a given type in a given workspace.
static Set<String>	getWysiwygCSSFileSet() Returns the list of CSS files for the WYSIWYG.
void	handleFileAnalyzeEnd(WorkspaceFileAnalyzer fileAnalyzer) This method is called when global file analyzer has end
boolean	hasDBMember() Returns true if DBMembers belong to this workspace
boolean	hasWKRole(String wfRoleId) Check if a WKRole exists in this workspace for the specified WFRole id
boolean	hasWKRole(WFRole wfRole) Check if a WKRole exists in this workspace for the specified WFRole
boolean	hasWorkflow(Class clazz) Check if the type is linked to a workflow for this workspace
protected static void	initWYSIWYGStyleMap() Parse all css wysiwyg file to build cssGlobalMap if it is null
void	invalidateHasDBMember() Invalidate the cache for hasDBMember method.
boolean	isAdmin(Member member) Check if the member is an administrator of the workspace or of the channel
boolean	isClosed() Getter for isClosed.
boolean	isCollaborativeSpace() Returns true if this workspace is a CollaborativeSpace (i.e.
boolean	isMember(Member member) Returns true if the given member belongs tho this workspace.
boolean	isModel() Getter for model
boolean	isOpen()
boolean	isUseDefaultQuota()
boolean	isWorkspaceCat(Category cat) Checks if the given category is a workspace category or a descendent of worspace categories.
void	linkRole(WFRole wfRole, WKRole wkRole) Link into the workspace a WFRole to a WKRole
void	performDelete(Member mbr, Map context) Performs data deletion
void	performUpdate(Member mbr, Map context) Performs data update.
void	setAdministrators(ArrayList<Member> administrators)
void	setAlertThreshold(int alertThreshold)
void	setCatSet(HashSet<Category> catSet)
void	setClosed(boolean closed) Setter for isClosed
void	setDefaultGroup(Group defaultGroup) Set the default group for this workspace.
void	setEmail(String email)
void	setGlobalCSS(String[] globalCSS) Setter for globcalCSS
void	setInstanceWorkflowGroupMap(HashMap<Class<?>,Set<String>> instanceWorkflowGroupMap)
void	setInstanceWorkflowIdMap(HashMap<Class<?>,Set<String>> instanceWorkflowIdMap)
void	setLanguage(String language)
void	setLastQuotaNotificationDate(long lastQuotaNotificationDate)
void	setModel(boolean model) Setter for model
void	setOrder(int order)
void	setParent(Workspace parent)
void	setQuota(long quota)
void	setQuotaAlert(QuotaElement quotaAlert)
static void	setRequestWorkspace(javax.servlet.http.HttpServletRequest request, Workspace workspace) Set the given workspace to the request.
void	setRole(WFRole wfRole, WKRole wkRole) Binds a WKRole to a WFRole
void	setRoleMap(HashMap<String,WKRole> roleMap) Setter of RoleMap
static void	setSessionWorkspace(javax.servlet.http.HttpSession session, Workspace workspace) Set the given workspace to the session.
void	setTagRoot(Category tagRoot)
void	setTitle(String v) Set the value of title.
void	setTitleML(HashMap<String,String> v) Set the HashMap containing the titles of this Workspace in language other than the main site language.
void	setTypeMap(HashMap<Class<?>,Object> typeMap) Setter of TypeMap
void	setTypeWorkflow(Class<?> clazz, Workflow wf) Link a Workflow to a given Class.
void	setUseDefaultQuota(boolean useDefaultQuota)
void	setWfByInstanceMap(HashMap<Class<?>,Boolean> wfByInstanceMap)
boolean	setWSTypeEntry(Class<?> clazz, WSTypeEntry wste) Link a WSTypeEntry to a given Class.
String	toCSV(String lang) Returns a CSV view of this object
String	toString()
void	updateGroupSet(Group grp, boolean add) Update the groupSet index
void	updatePubSet(Publication pub, boolean add) Update pubSet index

Methods inherited from class com.jalios.jcms.Data

canRequestLock, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayLink, getDisplayLink, 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, getLangPropertyValue, 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, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, 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, toFullString, 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 String REVISION

See Also:

Constant Field Values

LAST_QUOTA_NOTIFICATION_DATE

public static final String LAST_QUOTA_NOTIFICATION_DATE

See Also:

Constant Field Values

title

protected String title

titleML

protected HashMap<String,String> titleML

order

protected int order

administrators

protected ArrayList<Member> administrators

typeMap

protected HashMap<Class<?>,Object> typeMap

wfByInstanceMap

protected HashMap<Class<?>,Boolean> wfByInstanceMap

instanceWorkflowIdMap

protected HashMap<Class<?>,Set<String>> instanceWorkflowIdMap

instanceWorkflowGroupMap

protected HashMap<Class<?>,Set<String>> instanceWorkflowGroupMap

roleMap

protected HashMap<String,WKRole> roleMap

catSet

protected HashSet<Category> catSet

email

protected String email

isModel

protected boolean isModel

isClosed

protected boolean isClosed

globalCSS

protected String[] globalCSS

language

protected String language

tagRoot

protected Category tagRoot

parent

protected Workspace parent

defaultGroup

protected Group defaultGroup

alertThreshold

protected int alertThreshold

quota

protected long quota

useDefaultQuota

protected boolean useDefaultQuota

groupSet

protected transient TreeSet<Group> groupSet

pubSet

protected transient TreeSet<Publication> pubSet

classPubSetMap

protected transient HashMap<Class<?>,Set<Publication>> classPubSetMap

fileAnalyzer

protected transient WorkspaceFileAnalyzer fileAnalyzer

previousFileAnalyzer

protected transient WorkspaceFileAnalyzer previousFileAnalyzer

currentAnalyzerThread

protected transient FileAnalyzerThread currentAnalyzerThread

lastQuotaNotificationDate

protected transient long lastQuotaNotificationDate

quotaAlert

protected transient QuotaElement quotaAlert

PARENT_WORKSPACE_PARAMNAME

public static String PARENT_WORKSPACE_PARAMNAME

WORKSPACE_ICON

public static final String WORKSPACE_ICON

See Also:

Constant Field Values

WORKSPACE_MODEL_ICON

public static final String WORKSPACE_MODEL_ICON

See Also:

Constant Field Values

WORKSPACE_CLOSED_ICON

public static final String WORKSPACE_CLOSED_ICON

See Also:

Constant Field Values

WORKSPACE_CS_ICON

public static final String WORKSPACE_CS_ICON

See Also:

Constant Field Values

WORKSPACE_CS_MODEL_ICON

public static final String WORKSPACE_CS_MODEL_ICON

See Also:

Constant Field Values

WORKSPACE_MODEL_CLOSED_ICON

public static final String WORKSPACE_MODEL_CLOSED_ICON

See Also:

Constant Field Values

ALL_WORKSPACE_ICON

public static final String ALL_WORKSPACE_ICON

See Also:

Constant Field Values

cachedHomeData

protected transient Data cachedHomeData

cssGlobalMap

protected static transient Map<String,Set<String>> cssGlobalMap

Constructor Detail

Workspace

public Workspace()

Workspace

public Workspace(Workspace other)

Method Detail

checkWrite

public ControllerStatus checkWrite(int op,
                                   Member mbr,
                                   boolean checkIntegrity,
                                   Map context)

Description copied from class: Data

Checks if the given write operation can be performed

Overrides:

checkWrite in class Data

Parameters:

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

mbr - the member which requests the write operation

checkIntegrity - if true, requires the constraints integrity to be checked

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

Returns:

a ControllerStatus

getRootWorkspaces

public static Set<Workspace> getRootWorkspaces(Comparator<Workspace> comparator)

All Workspaces with no parent, sorted with comparator if not null.

Parameters:

comparator -

Returns:

All orphean WS

Since:

jcms-7.0.0

getRootWorkspaces

public static Set<Workspace> getRootWorkspaces(Comparator<Workspace> comparator,
                                               Member loggedMember)

All Workspaces with no parent the loggedMember in parameter belongs to, sorted with comparator if not null.

Parameters:

comparator -

loggedMember -

Returns:

All orphean WS, as seen for loggedMember

Since:

jcms-7.0.0

getParent

public Workspace getParent(Member loggedMember)

Get the Parent workspace from the one in parameter, if loggedMember is not null, the WS is return only if he is worker of it.

Parameters:

loggedMember - the logged member

Returns:

The Parent WS if loggedMember is worker of it

setDefaultGroup

public void setDefaultGroup(Group defaultGroup)

Set the default group for this workspace.

Parameters:

defaultGroup - the default group.

Since:

jcms-7.0.0

getDefaultGroup

public Group getDefaultGroup()

Returns the default group for this workspace. If there is no default group, returns the group with lesser DataRight.

Returns:

the default group for this workspace.

Since:

jcms-7.0.0

getDefaultGroup

public Group getDefaultGroup(boolean search)

Returns the default group for this workspace.

Parameters:

search - if true and if there is no default group, returns the group with lesser DataRight.

Returns:

the default group for this workspace.

Since:

jcms-7.0.0

getSubWorkspaces

public Set<Workspace> getSubWorkspaces()

Gives the set of all WS just under the ws in parameter.

Returns:

All children ws in a Set.

getSubWorkspaces

public Set<Workspace> getSubWorkspaces(Member loggedMember)

Return the workspaces just under the workspace in parameter. If the loggedMember parameter is not null, only workspaces for which the loggedMember is worker are returned.

Parameters:

loggedMember - Only Workspaces for which the loggedMember is Worker are returned

Returns:

All the ws sons of the workspace in parameter for which the loggedMember is worker.

getAllSubWorkspaces

public Set<Workspace> getAllSubWorkspaces()

Return all the descendant Workspaces of the current Workspace.

Returns:

All descendant Workspaces in a Set.

getAllSubWorkspaces

public Set<Workspace> getAllSubWorkspaces(Member loggedMember)

Return all the descendant Workspaces of the current Workspace.
If the loggedMember parameter is not null, only Workspaces for which the Member is Worker are returned.

Parameters:

loggedMember - Only Workspaces for which this Member is Worker are returned

Returns:

All the descendant Workspaces of the current Workspace for which the loggedMember is Worker.

toString

public String toString()

Overrides:

toString in class Data

exportXmlField

public void exportXmlField(StringBuffer sb,
                           int indentLevel)

Description copied from class: Data

Fills the given StringBuffer with Xml export of fields of this data.

Overrides:

exportXmlField in class Data

Parameters:

sb - the StringBuffer

indentLevel - the indent level

toCSV

public String toCSV(String lang)

Returns a CSV view of this object

Overrides:

toCSV in class Data

Parameters:

lang - the output language

Returns:

a CSV view of this object

Since:

jcms-5.0.0

getCSVHeader

public static String getCSVHeader(String lang)

Returns the CSV header of this object

Parameters:

lang - the output language

Returns:

the CSV header of this object

Since:

jcms-5.0.0

getIcon

public String getIcon()

Returns the image path icon for the given workspace

Returns:

String image relative path

Since:

jcms-5.5.0

flushHomeUrl

public void flushHomeUrl()

Reset the cache of the home category. Should only be called by category, publication and workspace listeners

getHomeUrl

public String getHomeUrl(Locale userLocale)

Returns the home url for the given workspace calculated from portal categories that belongs to workspace

Parameters:

userLocale - the user local

Returns:

String

getHomeUrlVisitor

protected Category getHomeUrlVisitor(Collection<Category> collect,
                                     Set<Publication> portalSet)

Internal methods to check home url

Parameters:

collect - a collection of category to check

portalSet - the portal set

Returns:

Category the hoem category

isWorkspaceCat

public boolean isWorkspaceCat(Category cat)

Checks if the given category is a workspace category or a descendent of worspace categories.

Parameters:

cat - the child category

Returns:

true if the given category is a workspace category or a descendent of worspace categories.

Since:

jcms 4.1

getFirstWorkspaceCat

public Category getFirstWorkspaceCat(Category cat)

Returns first workspace category mathching (or parent) given category.

Parameters:

cat - the child category

Returns:

category the workspace category.

Since:

jcms 5.7.4

getGlobalWYSIWYGStyle

public Set<String> getGlobalWYSIWYGStyle()

Returns a Set of global style for the current workspace.

Returns:

Set of global style

getLocalWYSIWYGStyle

public Set<String> getLocalWYSIWYGStyle(String global)

Returns a Set of local style for a given global style

Parameters:

global - the selected global style

Returns:

Set of local style

getGlobalWYSIWYGStyleMap

public static Map<String,Set<String>> getGlobalWYSIWYGStyleMap()

getWysiwygCSSFileSet

public static Set<String> getWysiwygCSSFileSet()

Returns the list of CSS files for the WYSIWYG.

Returns:

Set of wysiwyg css files

See Also:

PolicyManager.checkWysiwygCSSFile(Set)

initWYSIWYGStyleMap

protected static void initWYSIWYGStyleMap()

Parse all css wysiwyg file to build cssGlobalMap if it is null

getAllWorkspaceSet

public static Set<Workspace> getAllWorkspaceSet()

Returns a Set with all workspace, model or not. CAUTION: DO NOT alter the returned set, clone prior modification.

Returns:

Set of Workspace

Since:

jcms-5.5.0

getAllWorkspaceSet

public static Set<Workspace> getAllWorkspaceSet(Member member)

Returns a Set of workspace, for the given member. If the Member is an Admin return all workspace (model or not) If member is not null return workspace's member otherwise return empty TreeSet.

Parameters:

member - the working member

Returns:

Set of Workspace

Since:

jcms-5.5.0

getAllWorkspaceSetWithoutModel

public static Set<Workspace> getAllWorkspaceSetWithoutModel()

Returns a Set with all workspace without workspace model.

Returns:

Set of Workspace

Since:

jcms-5.5.0

getAllWorkspaceSetModel

public static Set<Workspace> getAllWorkspaceSetModel()

Returns a Set with all workspace model.

Returns:

Set of Workspace

Since:

jcms-5.5.0

getAllWorkingWorkspaceSet

public static SortedSet<Workspace> getAllWorkingWorkspaceSet(Member loggedMember,
                                                             JcmsContext jcmsContext)

Gives the list of workspaces for which the current loggedMember is a worker.

Parameters:

loggedMember - the current logged member

jcmsContext - the current jcmsContext

Returns:

the sorted, regarding to the title in the current language, set of workspace for which the logged member is worker

getWorkflow

public Workflow getWorkflow(Class clazz)

Find the Worflow associated to the given class. This method also check for super class.

Parameters:

clazz -

Returns:

the workflow linked to the given class.

Since:

jcms-4.1

See Also:

getWorkflow(Class, boolean)

getWorkflow

public Workflow getWorkflow(Class<?> clazz,
                            boolean checkSuperclass)

Find the Worflow associated to the given class or one of it's super class. Since jcms-5.5.0, the workflow stored in the typeMap may be a String or a WSTypeEntry

Parameters:

clazz - the target class

checkSuperclass - should check super class

Returns:

the workflow linked to the given class.

Since:

jcms-4.1

See Also:

getWorkflow(Class)

getWSTypeEntry

public WSTypeEntry getWSTypeEntry(Class clazz)

Returns a WSTypeEntry describing custom properties for a given type in a given workspace. WARNING: If Workspace doesn't handle a WSTypeEntry for this class it will return a fake WSTypeEntry.

Parameters:

clazz - the target class

Returns:

WSTypeEntry the type description or null if it doesn't exists

Since:

jcms-5.5.0

getWSTypeEntry

public WSTypeEntry getWSTypeEntry(String className)

Returns a WSTypeEntry describing custom properties for a given type in a given workspace. WARNING: If Workspace doesn't handle a WSTypeEntry for this class it will return a fake WSTypeEntry.

Parameters:

className - the target class name

Returns:

WSTypeEntry the type description or null if it doesn't exists

Since:

jcms-5.5.0

getTypeLabel

public String getTypeLabel(Class clazz,
                           String lang)

Returns the label for the given type (class) in the given language.

Parameters:

clazz - the class

lang - the language

Returns:

the label for the given type in the given language.

getTypeDescription

public String getTypeDescription(Class clazz,
                                 String lang)

Returns the description for the given type (class) in the given language.

Parameters:

clazz - the class

lang - the language

Returns:

the description for the given type (class) in the given language.

hasWorkflow

public boolean hasWorkflow(Class clazz)

Check if the type is linked to a workflow for this workspace

Parameters:

clazz - the class to check

Returns:

true if the type is linked to a workflow

Since:

jcms-4.1

getTypeSet

public Set<Class<?>> getTypeSet()

Returns a Set of all visible types

Returns:

a Set of all visible types (String)

Since:

jcms-4.1

canPublish

public boolean canPublish(Class clazz)

Checks if the given class can be published in this workspace.

Parameters:

clazz - the Class for which publication authorization should be verified

Returns:

true if the given class can be published in this workspace

Since:

jcms-4.1

getWorkflowSet

public Set<Workflow> getWorkflowSet()

Returns a Set of all workflow used by calling getWorkflow(clazz,false) on all clazz.

Returns:

a Set of all workflow used

Since:

jcms-4.1

setTypeWorkflow

public void setTypeWorkflow(Class<?> clazz,
                            Workflow wf)

Link a Workflow to a given Class. Warning since jcms-5.5.0 Workspace may use a WSTypeEntry. You may also use setWSTypeEntry(Class,WSTypeEntry) If the given class is linked to a WSTypeEntry then this method will throw a RuntimeException.

Parameters:

clazz - the clazz to link

wf - the workflow to link

Since:

jcms-5.5.0

See Also:

setWSTypeEntry(Class, WSTypeEntry)

setWSTypeEntry

public boolean setWSTypeEntry(Class<?> clazz,
                              WSTypeEntry wste)

Link a WSTypeEntry to a given Class. If WSTypeEntry.isSameProperties() than channel properties then do not store the WSTypeEntry. Warning: Caller must create, update or delete the WSTypeEntry this method is only a convenient setter

Parameters:

clazz - the clazz to link

wste - the WSTypeEntry to link with

Returns:

boolean true if the WSTypeEntry is used or false if it is same

Since:

jcms-5.5.0

getPublicationSet

public Set<Publication> getPublicationSet(Workflow workflow)

Return all publication for a given Workflow

Parameters:

workflow -

Returns:

a Set of publication

Since:

jcms-4.1

getPublicationSet

public Set<Publication> getPublicationSet(Workflow workflow,
                                          boolean specialState)

Return all the publication in/not a special state for the given Workflow

Parameters:

workflow -

specialState -

Returns:

a Set of publication

Since:

jcms-4.1

getPubSet

public TreeSet<Publication> getPubSet()

Returns:

Returns the pubSet.

Since:

jcms-4.1

updatePubSet

public void updatePubSet(Publication pub,
                         boolean add)

Update pubSet index

Parameters:

pub - the publication to be added or removed

add - add if true, remove if false

Since:

jcms-5.0.1

getClassPubSetMap

public HashMap<Class<?>,Set<Publication>> getClassPubSetMap()

Returns:

map(class, pubSet)

Since:

jcms-4.1

getPublicationSet

public <T extends Publication> Set<T> getPublicationSet(Class<?> clazz,
                                                        boolean specialState)

Return all the publication in/not a special state for the given class

Parameters:

clazz -

specialState -

Returns:

a Set of publication

Since:

jcms-4.1

getPublicationSet

public <T extends Publication> Set<T> getPublicationSet(Class<?> clazz)

Return all publication for a given Clazz

Parameters:

clazz -

Returns:

a Set of publication

Since:

jcms-4.1

getWFRole

public WFRole getWFRole(WKRole wkRole)

Returns the WFRole bound to the given WKRole.

Parameters:

wkRole - the WKRole to look for.

Returns:

the WFRole bound to the given WKRole.

Since:

jcms-5.0.5

getRole

public WKRole getRole(WFRole wfRole)

Get the WKRole linked to a WFRole for a given Workflow

Parameters:

wfRole - the role

Returns:

WKRole associated to the given WFRole

Since:

jcms-4.1

setRole

public void setRole(WFRole wfRole,
                    WKRole wkRole)

Binds a WKRole to a WFRole

Parameters:

wfRole - the WFRole

wkRole - the WKRole

Since:

jcms-5.5.0

getRole

public WKRole getRole(String wfRoleId)

Get the WKRole linked to a WFRole for a given Workflow

Parameters:

wfRoleId - the role id

Returns:

WKRole associated to the given WFRole

Since:

jcms-4.1

hasWKRole

public boolean hasWKRole(String wfRoleId)

Check if a WKRole exists in this workspace for the specified WFRole id

Parameters:

wfRoleId - the id of the WFRole to check

Returns:

true if the wfRoleID have associated WKRole

Since:

jcms-4.1

hasWKRole

public boolean hasWKRole(WFRole wfRole)

Check if a WKRole exists in this workspace for the specified WFRole

Parameters:

wfRole - the WFRole to check

Returns:

true if the wfRole have associated WKRole

Since:

jcms-4.1

getWFRoleIdSet

public Set<String> getWFRoleIdSet()

Return a set of all WFRoleId

Returns:

a set of WFRoleId

Since:

jcms-4.1

getWFRoleSet

public Set<WFRole> getWFRoleSet()

Return a set of all WFRole

Returns:

a set of WFRole

Since:

jcms-4.1

getWKRoleSet

public Set<WKRole> getWKRoleSet()

Return a set of all WKRole

Returns:

a set of WKRole

Since:

jcms-4.1

getWKRoleSet

public Set<WKRole> getWKRoleSet(Workflow wf)

Return all the WKRole for a given Workflow

Parameters:

wf -

Returns:

a Set of WKRole

Since:

jcms-4.1

getWKRoleSet

public Set<WKRole> getWKRoleSet(Class clazz)

Return all the WKRole for a given Class

Parameters:

clazz - the class

Returns:

a Set of WKRole

Since:

jcms-4.1

linkRole

public void linkRole(WFRole wfRole,
                     WKRole wkRole)

Link into the workspace a WFRole to a WKRole

Parameters:

wfRole -

wkRole -

Since:

jcms-4.1

isAdmin

public boolean isAdmin(Member member)

Check if the member is an administrator of the workspace or of the channel

Parameters:

member -

Returns:

true if the member is an administrator

Since:

jcms-4.1

isMember

public boolean isMember(Member member)

Returns true if the given member belongs tho this workspace.

Parameters:

member - the member

Returns:

true if the given member belongs tho this workspace.

Since:

jcms-7.1.0

getComparator

public static Comparator<Workspace> getComparator(String str,
                                                  boolean reverse)

Deprecated. use ComparatorManager

Since:

jcms-5.0.0

getNameComparator

public static Comparator<Workspace> getNameComparator(String lang)

Returns a new Comparator instance to compare workspace based on their title.

Parameters:

lang - the language in which to compare workspace

Returns:

a new NameComparator instance

Since:

jcms-5.6.1

getOrderComparator

public static Comparator<Workspace> getOrderComparator(String lang)

Returns a new Comparator instance to compare workspace based on their order.

Parameters:

lang - the language in which to compare workspaces'title when order is the same.

Returns:

a new OrderComparator instance

Since:

jcms-5.6.1

getGroupSizeComparator

public static Comparator<Workspace> getGroupSizeComparator(String lang)

Returns a new Comparator instance to compare workspace based on the number of groups in each workspace.

Parameters:

lang - the language in which to compare workspaces'title when number of groups is the same.

Returns:

a new GroupSizeComparator instance

Since:

jcms-5.6.1

getMemberSizeComparator

public static Comparator<Workspace> getMemberSizeComparator(String lang)

Returns a new Comparator instance to compare workspace based on the number of members in each workspace.

Parameters:

lang - the language in which to compare workspaces'title when number of members is the same.

Returns:

a new MemberSizeComparator instance

Since:

jcms-5.6.1

getMemberSet

public Set<Member> getMemberSet()

Returns a set of members that belongs to groups of this workspace. This method only returns Member (no DBMember).

Returns:

a new Set containing all members of this Workspace

getMemberSet

public Set<Member> getMemberSet(boolean includeDBMember)

Returns a set of members that belongs to groups of this workspace.

Parameters:

includeDBMember - if true it includes for DBMember (up to HibernateManager.getDefaultMaxResults()).

Returns:

a new Set containing all members of this Workspace

Since:

jcms-7.0.0

hasDBMember

public boolean hasDBMember()

Returns true if DBMembers belong to this workspace

Returns:

true if DBMembers belong to this workspace

Since:

jcms-7.1.1

invalidateHasDBMember

public void invalidateHasDBMember()

Invalidate the cache for hasDBMember method.

Since:

jcms-7.1.1

setSessionWorkspace

public static void setSessionWorkspace(javax.servlet.http.HttpSession session,
                                       Workspace workspace)

Set the given workspace to the session.

Parameters:

session - the session

workspace - the workspace

Since:

jcms-4.1

getSessionWorkspace

public static Workspace getSessionWorkspace(javax.servlet.http.HttpSession session)

Get the workspace stored in the session

Parameters:

session - the session

Returns:

the workspace in the session

Since:

jcms-4.1

setRequestWorkspace

public static void setRequestWorkspace(javax.servlet.http.HttpServletRequest request,
                                       Workspace workspace)

Set the given workspace to the request.

Parameters:

request - the request

workspace - the workspace

Since:

jcms-5.0

getRequestWorkspace

public static Workspace getRequestWorkspace(javax.servlet.http.HttpServletRequest request)

Get the workspace stored in the request

Parameters:

request - the request

Returns:

the workspace in the request

Since:

jcms-5.0

getDataName

public String getDataName(String language)

Description copied from class: Data

Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.

• The Title (multi-language) for a Publication.
• The Name (multi-language) for a Category.
• The Name for a Group, a Member.
  
• The Title (multi-language) for a Workspace.

Can be seen as a smart multi-language toString(), but never returning null.
Default behaviour is to return toFullString() of Data or empty string if toFullString is null.

Overrides:

getDataName in class Data

Parameters:

language - the language in which to return the name if multilang available for the data.

Returns:

title of Workspace in given language or empty String if not specified.

Since:

jcms-5.1

See Also:

getTitle(String), Data.getDataName(String)

getTitle

public String getTitle(String lang)

Get the value of title bound to the given language.

Parameters:

lang - the language to get the title

Returns:

title in the given language.

Since:

jcms-4.1

getTitle

public String getTitle(String lang,
                       boolean useDefault)

Get the value of title bound to the given language.

Parameters:

lang - the language to get the title

useDefault - should main language used as default language if title does not exist in the given language

Returns:

title in the given language.

Since:

jcms-4.1

getTitle

public String getTitle()

Get the value of title.

Returns:

Value of title.

Since:

jcms-4.1

setTitle

public void setTitle(String v)

Set the value of title.

Parameters:

v - Value to assign to title.

Since:

jcms-4.1

getTitleML

public HashMap<String,String> getTitleML()

Retrieve the HashMap containing the titles of this Workspace in language other than the main site language.

Returns:

an HashMap of String.

Since:

jcms-4.1

setTitleML

public void setTitleML(HashMap<String,String> v)

Set the HashMap containing the titles of this Workspace in language other than the main site language.

Parameters:

v - Value to assign to titleML.

Since:

jcms-4.1

setGlobalCSS

public void setGlobalCSS(String[] globalCSS)

Setter for globcalCSS

Parameters:

globalCSS - Set of css name

getGlobalCSS

public String[] getGlobalCSS()

Getter for globalCSS

Returns:

Set of css name

isModel

public boolean isModel()

Getter for model

Returns:

model is workspace is a model

setModel

public void setModel(boolean model)

Setter for model

Parameters:

model - is workspace is a model

isClosed

public boolean isClosed()

Getter for isClosed. Is a workspace is closed, no contribution, no modification on groups are allowed.

Returns:

isClosed is workspace is Closed For Contribution

setClosed

public void setClosed(boolean closed)

Setter for isClosed

Parameters:

closed - to close this workspace for contribution

isOpen

public boolean isOpen()

getRoleMap

public HashMap<String,WKRole> getRoleMap()

Getter of RoleMap

Returns:

the association: Workflow / WfRoleSet

Since:

jcms-4.1

setRoleMap

public void setRoleMap(HashMap<String,WKRole> roleMap)

Setter of RoleMap

Parameters:

roleMap -

Since:

jcms-4.1

getTypeMap

public HashMap<Class<?>,Object> getTypeMap()

Getter of TypeMap

Returns:

a Map Class / Workflow Id

Since:

jcms-4.1

setTypeMap

public void setTypeMap(HashMap<Class<?>,Object> typeMap)

Setter of TypeMap

Parameters:

typeMap -

Since:

jcms-4.1

getOrder

public int getOrder()

Returns:

Returns the order.

Since:

jcms-4.1

setOrder

public void setOrder(int order)

Parameters:

order - The order to set.

Since:

jcms-4.1

getGroupSet

public TreeSet<Group> getGroupSet()

Returns:

Returns the groupSet.

Since:

jcms-4.1

updateGroupSet

public void updateGroupSet(Group grp,
                           boolean add)

Update the groupSet index

Parameters:

grp - the group to be added or removed

add - add if true, remove if false

Since:

jcms-5.0.1

getAdministrators

public ArrayList<Member> getAdministrators()

Returns:

Returns the administrators.
CAUTION: DO NOT alter the returned List, clone prior modification.

Since:

jcms-4.1

setAdministrators

public void setAdministrators(ArrayList<Member> administrators)

Parameters:

administrators - The administrators to set.

Since:

jcms-4.1

getCatSet

public HashSet<Category> getCatSet()

Returns:

Returns the catSet.

Since:

jcms-4.1

setCatSet

public void setCatSet(HashSet<Category> catSet)

Parameters:

catSet - The catSet to set.

Since:

jcms-4.1

getTagRoot

public Category getTagRoot()

Returns:

the tag root.

Since:

jcms-7.1.0

setTagRoot

public void setTagRoot(Category tagRoot)

Parameters:

tagRoot - the tag root to set.

Since:

jcms-7.1.0

getEmail

public String getEmail()

Returns:

Returns the email.

Since:

jcms-4.1

getLanguage

public String getLanguage()

Returns:

Returns the main Language of the workspace if it is specified. null otherwise.

Since:

jcms-5.7.3

setLanguage

public void setLanguage(String language)

Parameters:

language - The language to set.

Since:

jcms-5.7.3

getParent

public Workspace getParent()

Returns:

Returns the parent Workspace of the current workspace if it has one. null otherwise.

Since:

jcms-7.0.0

setParent

public void setParent(Workspace parent)

Parameters:

parent - The parent workspace to set.

Since:

jcms-7.0.0

getFullEmail

public String getFullEmail()

Returns the full email in the form "WorkspaceTitle ".

Returns:

an email

Since:

jcms-5.0.0

getFullEmail

public String getFullEmail(String lang)

Returns the full email in the form "WorkspaceTitle ".

Parameters:

lang - the language used to retrive Workspace title

Returns:

an email

Since:

jcms-5.0.0

setEmail

public void setEmail(String email)

Parameters:

email - The email to set.

Since:

jcms-4.1

checkIntegrity

public ControllerStatus checkIntegrity()

Checks whether or not data integrity constraints are respected.

Overrides:

checkIntegrity in class Data

Returns:

a ControllerStatus

Since:

jcms-5.0.0

checkMember

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

Checks if the given member can perform the given operation.

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

Since:

jcms-5.0.0

checkCreate

public ControllerStatus checkCreate(Member mbr,
                                    Map context)

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

Since:

jcms-5.0.0

checkUpdate

public ControllerStatus checkUpdate(Member mbr,
                                    Map context)

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

Since:

jcms-5.0.0

checkDelete

public ControllerStatus checkDelete(Member mbr,
                                    Map context)

Checks if the deletion can be performed

Overrides:

checkDelete 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

Since:

jcms-5.0.0

performUpdate

public void performUpdate(Member mbr,
                          Map context)

Description copied from class: Data

Performs data update.

Overrides:

performUpdate in class Data

Parameters:

mbr - the member which requests the write operation

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

Since:

jcms-5.5.0

See Also:

Data.performUpdate(com.jalios.jcms.Member, java.util.Map)

performDelete

public void performDelete(Member mbr,
                          Map context)

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)

Since:

jcms-5.0.0

getCatSet

public Set<Category> getCatSet(Member mbr)

Gives the root categories for this Workspace, that the given member may read.

Parameters:

mbr - the member. May be null.

Returns:

a sub set of getCatSet()

Since:

JCMS-6.1

exportXmlRelated

protected void exportXmlRelated(StringBuffer sb,
                                String related,
                                int indentLevel)

Overrides:

exportXmlRelated in class Data

isCollaborativeSpace

public boolean isCollaborativeSpace()

Returns true if this workspace is a CollaborativeSpace (i.e. generated with the Collaborative Spaces Plugin).

Returns:

true if this workspace is a CollaborativeSpace (i.e. generated with the Collaborative Spaces Plugin).

Since:

jcms-6.1.0

getFileSizeMap

public ObjectLongTreeMap getFileSizeMap(boolean refresh)

Returns the map file size for each content-type. To improve the performances, the map is cached unless it is requested to refresh it.

Parameters:

refresh - if true refresh the map

Returns:

the map file size for each content-type.

Since:

jcms-7.0.0

getPreviousFileAnalyzer

public WorkspaceFileAnalyzer getPreviousFileAnalyzer()

returns previous WorkspaceFileAnalyzer instance associated with this workspace if any. This method doesn't do any refresh nor computation like getFileAnalyzer(boolean)

Returns:

previous WorkspaceFileAnalyzer instance associated with this workspace if any.

getFileAnalyzer

public WorkspaceFileAnalyzer getFileAnalyzer(boolean refresh)

returns WorkspaceFileAnalyzer instance associated with this workspace. Note that as file analyze is down asynchronously, this method should returns null if an analyze is in progress (or if refresh is asked). In this case, user should ask getCurrentAnalyzerThread() to retrieve the analyze thread. getCompleteness() method on the thread can be used to know the state of the thread.

Parameters:

refresh - force to ignore data previously present in cache

Returns:

WorkspaceFileAnalyzer instance associated with this workspace or null if an analyze is in progress (or if refresh is asked).

getCurrentAnalyzerThread

public FileAnalyzerThread getCurrentAnalyzerThread()

Return the current analyzer thread if analyze is in progress

Returns:

the FileAnalyzerThread or null if no analyze is running

handleFileAnalyzeEnd

public void handleFileAnalyzeEnd(WorkspaceFileAnalyzer fileAnalyzer)

This method is called when global file analyzer has end

getWfByInstanceMap

public HashMap<Class<?>,Boolean> getWfByInstanceMap()

setWfByInstanceMap

public void setWfByInstanceMap(HashMap<Class<?>,Boolean> wfByInstanceMap)

getInstanceWorkflowIdMap

public HashMap<Class<?>,Set<String>> getInstanceWorkflowIdMap()

setInstanceWorkflowIdMap

public void setInstanceWorkflowIdMap(HashMap<Class<?>,Set<String>> instanceWorkflowIdMap)

getInstanceWorkflowGroupMap

public HashMap<Class<?>,Set<String>> getInstanceWorkflowGroupMap()

setInstanceWorkflowGroupMap

public void setInstanceWorkflowGroupMap(HashMap<Class<?>,Set<String>> instanceWorkflowGroupMap)

getAlertThreshold

public int getAlertThreshold()

setAlertThreshold

public void setAlertThreshold(int alertThreshold)

getQuota

public long getQuota()

setQuota

public void setQuota(long quota)

getLastQuotaNotificationDate

public long getLastQuotaNotificationDate()

setLastQuotaNotificationDate

public void setLastQuotaNotificationDate(long lastQuotaNotificationDate)

getQuotaAlert

public QuotaElement getQuotaAlert()

setQuotaAlert

public void setQuotaAlert(QuotaElement quotaAlert)

getUseDefaultQuota

public boolean getUseDefaultQuota()

isUseDefaultQuota

public boolean isUseDefaultQuota()

setUseDefaultQuota

public void setUseDefaultQuota(boolean useDefaultQuota)