com.jalios.jcms.dbmember
Class DBMember

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.Member
              com.jalios.jcms.dbmember.DBMember

All Implemented Interfaces:

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

public class DBMember
extends Member
implements DBData

See Also:

Serialized Form

Nested Class Summary

static class

DBMember.Fields

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

Member.AccountSelector, Member.AdministratorSelector, Member.ContactSelector, Member.GroupComparator<T extends Member>, Member.LangComparator<T extends Member>, Member.LastLdapSyncComparator<T extends Member>, Member.LastLoginDateComparator<T extends Member>, Member.LdapAccountComparator<T extends Member>, Member.LoginComparator<T extends Member>, Member.NameComparator<T extends Member>, Member.NotificationPeriodSelector, Member.PublicationCountComparator<T extends Member>, Member.RightComparator<T extends Member>, Member.SessionComparator<T extends Member>, Member.TextSelector, Member.UsageSelector, Member.ValidEmailSelector, Member.WebdavComparator<T extends Member>, Member.WorkerSelector

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>

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

Fields inherited from class com.jalios.jcms.Member

address, canEditCategories, canManageContentStaled, canPublishContent, canUpdateDeleteContent, declaredGroups, delegateMemberSet, DISABLED_PASSWORD, DO_NOT_REASSIGN_PUBLICATION, email, EMAIL_FORMAT_HTML, EMAIL_FORMAT_TEXT, emailFormat, EXTRADBDATA_LAST_LOGIN_TIME, firstName, fullEmail, fullName, groups, IGNORE_LOGIN_DATE, info, isAdmin, isEmailVisible, jobTitle, language, lastLdapSynchro, lastLoginDateCached, lastLoginDateSet, locale, login, MAX_LAST_LOGIN_DATE_HISTORY, mobile, name, notification, OP_UPDATE_PROFILE, organization, password, phone, photo, readCategorySet, REVISION, rightFromClassMap, salutation, usage, USAGE_ACCOUNT, USAGE_CONTACT, USE_CATEGORY_GROUP_AND_MEMBER, USE_CATEGORY_GROUP_ONLY, USE_CATEGORY_MEMBER_ONLY, useCategoryMode, useCategorySet, webdavAccess

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, 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_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

DBMember()

DBMember(Member other)
Constructor by copy : creates a new instance of DBMember from the specified Member.

Method Summary

boolean	belongsToGroup(Group group) This convenient method returns true if this member belongs to a given group.
WKRole	belongsToRole()
WKRole	belongsToRole(boolean checkGroups)
boolean	belongsToRole(WKRole role)
boolean	belongsToRole(WKRole role, boolean checkGroups)
boolean	belongsToWorkspace(Workspace ws) This convenient method returns true if this member belongs to the given workspace.
boolean	canArchive(Publication pub) Check if the member is in a role that can archive the given publication.
boolean	canCreateWorkCopy(Publication pub) Convenience method
boolean	canCreateWorkspace() Check if the member can create a workspace
boolean	canCreateWorkspace(Workspace model) Check if the member can duplicate the model to create a workspace
boolean	canDeleteOther(Class<?> clazz)
boolean	canDeleteOther(Class<?> clazz, Workspace ws)
boolean	canDeleteOther(Data data)
boolean	canEditCategories() Check if the member can edit categories.
boolean	canEditCategories(Workspace ws) Return true if this member can edit at least one category of this workspace
boolean	canManageCategory(Category cat) Check if the member can manage the given category (ie if the given category is a descendant of one of the member's root category)
boolean	canManageCategory(Category cat, boolean searchInGroups, boolean searchInParent) Check if the member can manage the given category (ie if the given category is a descendant of one of the member's root category)
boolean	canMergeWorkCopy(Publication pub) Convenience method
boolean	canPublish(Class clazz, Set<? extends Workspace> workspaceSet) Check if this member can publish this clazz of data (ie if this member has rights (or belongs at least to one group that have this right) and, if the given class inherits from Publication, the member can work on the WF's init state of this class for all of it's workflow.
boolean	canPublishContent() Checks if if this member can publish something else than UGC.
boolean	canPublishContent(Workspace ws) Checks if if this member can publish something else than UGC.
boolean	canUpdateDeleteContent()
boolean	canUpdateDeleteContent(Workspace ws) Check if member can perform Update or Delete for the gicen Workspace
protected boolean	canUpdateDeleteOtherCommon(Class clazz, Workspace ws, boolean checkUpdate)
boolean	canUpdateOther(Class<?> clazz)
boolean	canUpdateOther(Class<?> clazz, Workspace ws)
boolean	canUpdateOther(Data data)
boolean	canUseCategory(Category cat) Check if this member can use the given category.
boolean	canUseCategory(Category cat, boolean searchInGroups, boolean searchInParent) Check if this member can use the given category.
boolean	canUseDescendantCategories(Category cat, boolean checkRoot) Check if this member can use at least one descendant of the given category.
Member	convertToMember(Member opAuthor) Converts this DBMember to a member.
static void	exportCSV(Collection<String> dbMemberIdColl, String lang, Writer writer) Export a dataSet to CSV
void	exportXmlField(StringBuffer sb, int indentLevel) Fills the given StringBuffer with Xml export of fields of this data.
SortedSet<Workspace>	getAdministratedWorkspaceSet() This convenient method returns all the workspace this member is the administrator of.
Set<Category>	getCategoryRootSet() Returns the set of category roots the member can manage
Set<Category>	getCategoryRootSet(Workspace ws) Returns the set of category roots the member can manage in a given workspace
Set<Content>	getContentSet() Get the value of contentSet.
static String	getCSVHeader(String lang) Returns the CSV header of this object
TreeSet<Member>	getDelegateMemberSet() Gets the TreeSet of Member allowed to login as this member.
Set<Member>	getDelegationHolderSet() Retrieves the list of member into which this member is allowed to log in.
int	getEditCategoryMode()
Boolean	getEmailPublic() Retrieves whether this member's email is visible to other members or not.
TreeSet<Category>	getExpandedUseCategorySet() Return the category set this member can use according his category use mode (group, member or group and member)
Workspace	getFavoriteWorkspace(Workspace currentWS, Class<?> clazz) Return the favorite Member Workspace where it can work on
String	getGids() Returns the Group ids to which this member belongs.
protected String[]	getIconParameter(Workspace ws, String userLang) Return a String[2]: Title / Alt for the given parameters
String	getInfo() Gets informations available for this member.
String	getLanguage() Get the value of language.
Date	getLastLdapSynchro() Get the value of lastLdapSynchro.
SortedSet<Date>	getLastLoginDateSet() Retrieve the last login Date of this Member.
String	getLastLoginTimes() Retrieve a comma seperated list of last login time of this member.
static DBMember	getMemberFromEmail(String email, boolean checkDisabled) Retrieve the DBMember having the specified email.
static DBMember	getMemberFromLogin(String login, boolean checkDisabled) Retrieve the DBMember having the specified login.
Notification	getNotification() Get the Notification
Set<Publication>	getPublicationSet() Retrieve a Set containing all the Publication of which this member is the author.
TreeSet<Category>	getReadCategorySet() Gets the TreeSet of Category used for Publication read right.
HashMap<String,DataRight>	getRightFromClassMap() Get the value of rightFromClassMap.
Data	getUpdateInstance() Returns an instance of this object to update it.
int	getUseCategoryMode() Get the value of useCategoryMode.
TreeSet<Category>	getUseCategorySet() Get the value of useCategorySet.
boolean	getWebdavAccess() Get the value of webdavAccess
Set<Publication>	getWorkspacePublicationSet()
Set<Workspace>	getWorkspaceSet()
boolean	hasExplicitRights()
boolean	hasWebdavAccess() This method check if member have a webdav access or belongs to a group having webdav access.
protected boolean	internalCanDeleteOther(Data data)
protected boolean	internalCanManageCategory(Category cat, boolean searchInGroups, boolean searchInParent)
protected boolean	internalCanPublish(Class<?> clazz, Set<? extends Workspace> workspaceSet)
protected boolean	internalCanUpdateDeleteOtherCommon(Class<?> clazz, Workspace ws, boolean checkUpdate)
protected boolean	internalCanUpdateOther(Data data)
protected boolean	internalCanUseCategory(Category cat, boolean searchInGroups, boolean searchInParent)
protected boolean	internalIsWorker()
protected boolean	internalIsWorker(Workspace ws)
void	invalidateCanManageContent() Invalidate the current status of canManageContent (the next time it will be called, it will be computed).
boolean	isAdmin() Checks if this member is an administrator of the site.
boolean	isAdmin(Workspace ws) Returns true if this member is an administrator of the given workspace
boolean	isLdapAccount() Check if this member account has been created from LDAP
boolean	isWorkAdmin() This convenient method check if this member is administrator of at least one workspace.
boolean	isWorker() Check if this member can work either on publications or on categories (this is a convenient method wich performs a 'or' on the values returned by canPublishContent(), canUpdateDeleteContent() and canEditCategories()).
boolean	isWorker(Workspace ws) Check if this member can work either on publications or on categories (this is a convenient method wich performs a 'or' on the values returned by canPublishContent(Workspace), canUpdateDeleteContent(Workspace) and canEditCategories()).
protected void	reassignMemberPubs(Member mbr, Map context)
void	refreshWorkspaceSet() Refresh the workspaces this member belongs to.
void	setAddress(String address) Set the address of this member.
void	setAdmin(boolean isAdmin) Sets if this member can administrate the site.
void	setDelegateMemberSet(TreeSet<Member> v) Set the value of delegateMbrSet.
void	setEmail(String email) Set the email address of this member.
void	setEmailFormat(String emailFormat) Set the email format that will be used to send mail to this member.
void	setEmailPublic(Boolean visible) Sets whether this member's email is visible to other members or not.
void	setFirstName(String firstName) Set the first name of this member.
void	setInfo(String info) Set some informations available for this member.
void	setJobTitle(String jobTitle) Set the job title of this member.
void	setLanguage(String lang) Set the value of language.
void	setLastLdapSynchro(Date v) Set the value of lastLdapSynchro.
void	setLastLoginDate(Date date) Sets the last login Date of this Member.
void	setLastLoginTimes(String lastLoginTimes) Set the comma seperated list of last login time of this member.
void	setLogin(String login) Set the login of this member.
void	setMobile(String mobile) Set the mobile phone number of this member.
void	setName(String name) Set the name of this member.
void	setNotification(Notification notification) Sets the Notification
void	setOrganization(String organization) Set the organization of this member.
void	setPassword(String password) Set the password of this member.
void	setPhone(String phone) Set the phone number of this member.
void	setReadCategorySet(TreeSet<Category> v) Set the value of readCategorySet.
void	setRightFromClassMap(HashMap<String,DataRight> v) Set the value of rightFromClassMap.
void	setSalutation(String salutation) Set the salutation of this member.
void	setUseCategoryMode(int v) Set the value of useCategoryMode.
void	setUseCategorySet(TreeSet<Category> v) Set the value of useCategorySet.
void	setWebdavAccess(boolean webdavAccess) Set the value of webdavAccess
String	toCSV(String lang) Returns a CSV view of this object
String	toFullString()
void	updateContentSet(Content content, boolean add) Update contentSet index
void	updateDelegationHolderSet(Member mbr, boolean add) Internal method used to update the (transient) delegation holder set.
void	updatePublicationSet(Publication pub, boolean add) Update publicationSet index
protected void	updateRights(Member mbr, Map context)
void	updateWorkspaceSet(Workspace ws, boolean add) Update workspaceSet index

Methods inherited from class com.jalios.jcms.Member

addGroup, alertSignup, belongsToGroup, buildPhotoFilename, canPublish, canPublish, canPublish, canPublishAll, canPublishSome, canPublishSome, canRead, canRead, canUploadPhoto, canWorkOn, checkCreate, checkDelete, checkIntegrity, checkMember, checkUpdate, checkUpdateProfile, deleteMemberData, disable, exportXmlRelated, fillExportXmlFieldAttributes, getAddress, getComparator, getCookieMaxAge, getDataImage, getDataImage, getDataName, getDeclaredGroups, getEmail, getEmailFormat, getFirstName, getFriendlyName, getFullEmail, getFullName, getGroupComparator, getGroups, getHtmlIcon, getHtmlIcon, getIcon, getIcon, getIndexingDate, getJobTitle, getLangComparator, getLangSalutation, getLastLdapSyncComparator, getLastLoginDate, getLastLoginDateComparator, getLastName, getLdapComparator, getLocale, getLogin, getLoginComparator, getMobile, getName, getNameComparator, getOrganization, getPassword, getPhone, getPhoto, getPublicationCountComparator, getRight, getRight, getRight, getRightComparator, getSalutation, getSessionComparator, getSignupConfirmationUrl, getUsage, getUsageName, getWebdavComparator, hasPhoto, hasRead, indexLogin, internalCanCreateWorkspace, internalCheckMember, isAccount, isContact, isDeclaredGroup, isDisabled, isEmailValid, isEmailVisible, performDelete, refreshGroups, refreshLoginIndex, removeAllPhotos, removeGroup, removeMemberAttendeeCalendarEvent, setDeclaredGroups, setEmailVisible, setLastName, setLocale, setPhoto, setUsage, toString, unindexLogin

Methods inherited from class com.jalios.jcms.Data

checkCreate, checkDelete, checkIntegrity, checkLock, checkUpdate, checkWrite, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataImage, 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, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getTypeEntry, getTypeFieldsEntries, hashCode, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, lock, markNewImport, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performCreate, performDelete, performUpdate, performUpdate, prepareUpdateContext, prepareUpdateContext, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraInfo, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setMdate, setOpAuthor, setOpDelegate, setRowId, 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

Methods inherited from interface com.jalios.jcms.db.DBData

getRowId, setRowId

Constructor Detail

DBMember

public DBMember()

DBMember

public DBMember(Member other)

Constructor by copy : creates a new instance of DBMember from the specified Member.

Warning : Do not use this constructor to create an update instance for a DBMember, instead use getUpdateInstance() :

   Member updated = (Member) member.getUpdateInstance();
   update.performUpdate(...)
 

Parameters:

other - the member to copy, must not be null.

Since:

jcms-6.1.0

Method Detail

getUpdateInstance

public Data getUpdateInstance()

Description copied from class: Data

Returns an instance of this object to update it.

Overrides:

getUpdateInstance in class Member

Returns:

an instance of this object to update it.

toFullString

public String toFullString()

Overrides:

toFullString in class Member

toCSV

public String toCSV(String lang)

Description copied from class: Member

Returns a CSV view of this object

Overrides:

toCSV in class Member

Parameters:

lang - the output language

Returns:

a CSV view of this object

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-6.1.0

exportCSV

public static void exportCSV(Collection<String> dbMemberIdColl,
                             String lang,
                             Writer writer)

Export a dataSet to CSV

Parameters:

dbMemberIdColl - the set of DBMember's id to be exported

lang - the language

writer - the writer where to print the export

Since:

jcms-5.0.0

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 Member

Parameters:

sb - the StringBuffer

indentLevel - the indent level

getIconParameter

protected String[] getIconParameter(Workspace ws,
                                    String userLang)

Description copied from class: Member

Return a String[2]: Title / Alt for the given parameters

Overrides:

getIconParameter in class Member

Parameters:

ws - the Workspace or Null

userLang - the UserLang or null

Returns:

a String[2]

canPublishContent

public boolean canPublishContent()

Description copied from class: Member

Checks if if this member can publish something else than UGC.

Overrides:

canPublishContent in class Member

Returns:

true if this member can publish something else than UGC.

canPublishContent

public boolean canPublishContent(Workspace ws)

Description copied from class: Member

Checks if if this member can publish something else than UGC.

Overrides:

canPublishContent in class Member

Parameters:

ws - the Workspace to work on

Returns:

true if this member can publish something else than UGC.

canUpdateDeleteContent

public boolean canUpdateDeleteContent()

Overrides:

canUpdateDeleteContent in class Member

Returns:

true if this member has the "update other" / "delete other" right" on at least one CPT.

canUpdateDeleteContent

public boolean canUpdateDeleteContent(Workspace ws)

Description copied from class: Member

Check if member can perform Update or Delete for the gicen Workspace

Overrides:

canUpdateDeleteContent in class Member

Parameters:

ws - the Workspace to ckeck

Returns:

true if this member has the "update other" / "delete other" right" on at least one CPT.

invalidateCanManageContent

public void invalidateCanManageContent()

Description copied from class: Member

Invalidate the current status of canManageContent (the next time it will be called, it will be computed).

Overrides:

invalidateCanManageContent in class Member

canPublish

public boolean canPublish(Class clazz,
                          Set<? extends Workspace> workspaceSet)

Description copied from class: Member

Check if this member can publish this clazz of data (ie if this member has rights (or belongs at least to one group that have this right) and, if the given class inherits from Publication, the member can work on the WF's init state of this class for all of it's workflow. Since JCMS 5.0.1, this method also check that the clazz can be published in at least one workspace.

Overrides:

canPublish in class Member

Parameters:

clazz - the class to test

workspaceSet - the set of workspace to work on

Returns:

true if member is admin or if the member has right to publish such a class and member can work

internalCanPublish

protected boolean internalCanPublish(Class<?> clazz,
                                     Set<? extends Workspace> workspaceSet)

Overrides:

internalCanPublish in class Member

canArchive

public boolean canArchive(Publication pub)

Description copied from class: Member

Check if the member is in a role that can archive the given publication. It checks if the member has the right to put this publication in the archived state in the workflow of the publication, but it does not take into account the current state of the publication.

Overrides:

canArchive in class Member

Parameters:

pub - the publication to check

Returns:

true if it can archive the publication false otherwise

canUpdateOther

public boolean canUpdateOther(Class<?> clazz)

Overrides:

canUpdateOther in class Member

internalCanUpdateDeleteOtherCommon

protected boolean internalCanUpdateDeleteOtherCommon(Class<?> clazz,
                                                     Workspace ws,
                                                     boolean checkUpdate)

Overrides:

internalCanUpdateDeleteOtherCommon in class Member

canUpdateDeleteOtherCommon

protected boolean canUpdateDeleteOtherCommon(Class clazz,
                                             Workspace ws,
                                             boolean checkUpdate)

Overrides:

canUpdateDeleteOtherCommon in class Member

canUpdateOther

public boolean canUpdateOther(Class<?> clazz,
                              Workspace ws)

Overrides:

canUpdateOther in class Member

canUpdateOther

public boolean canUpdateOther(Data data)

Overrides:

canUpdateOther in class Member

internalCanUpdateOther

protected boolean internalCanUpdateOther(Data data)

Overrides:

internalCanUpdateOther in class Member

canDeleteOther

public boolean canDeleteOther(Data data)

Overrides:

canDeleteOther in class Member

internalCanDeleteOther

protected boolean internalCanDeleteOther(Data data)

Overrides:

internalCanDeleteOther in class Member

canDeleteOther

public boolean canDeleteOther(Class<?> clazz)

Overrides:

canDeleteOther in class Member

canDeleteOther

public boolean canDeleteOther(Class<?> clazz,
                              Workspace ws)

Overrides:

canDeleteOther in class Member

isWorker

public boolean isWorker()

Description copied from class: Member

Check if this member can work either on publications or on categories (this is a convenient method wich performs a 'or' on the values returned by canPublishContent(), canUpdateDeleteContent() and canEditCategories()).

Overrides:

isWorker in class Member

Returns:

true if the member can work at least on one publication type (except review) or he can edit the categories.

See Also:

Member.canPublishContent(), Member.canUpdateDeleteContent(), Member.canEditCategories()

internalIsWorker

protected boolean internalIsWorker()

Overrides:

internalIsWorker in class Member

isWorker

public boolean isWorker(Workspace ws)

Description copied from class: Member

Check if this member can work either on publications or on categories (this is a convenient method wich performs a 'or' on the values returned by canPublishContent(Workspace), canUpdateDeleteContent(Workspace) and canEditCategories()).

Overrides:

isWorker in class Member

Parameters:

ws - the workspace to check

Returns:

true if the member can work at least on one publication type (except review) or he can edit the categories.

See Also:

Member.canPublishContent(Workspace), Member.canUpdateDeleteContent(Workspace), Member.canEditCategories()

internalIsWorker

protected boolean internalIsWorker(Workspace ws)

Overrides:

internalIsWorker in class Member

getEditCategoryMode

public int getEditCategoryMode()

Overrides:

getEditCategoryMode in class Member

isAdmin

public boolean isAdmin(Workspace ws)

Description copied from class: Member

Returns true if this member is an administrator of the given workspace

Overrides:

isAdmin in class Member

Parameters:

ws - the workspace to be checked

Returns:

true if this member is an administrator of the given workspace

hasExplicitRights

public boolean hasExplicitRights()

Overrides:

hasExplicitRights in class Member

hasWebdavAccess

public boolean hasWebdavAccess()

Description copied from class: Member

This method check if member have a webdav access or belongs to a group having webdav access.

Overrides:

hasWebdavAccess in class Member

Returns:

boolean true if member have webdav Access

isLdapAccount

public boolean isLdapAccount()

Description copied from class: Member

Check if this member account has been created from LDAP

Overrides:

isLdapAccount in class Member

Returns:

boolean true if it is an LDAP Account

getLastLdapSynchro

public Date getLastLdapSynchro()

Description copied from class: Member

Get the value of lastLdapSynchro.

Overrides:

getLastLdapSynchro in class Member

Returns:

Value of lastLdapSynchro.

setLastLdapSynchro

public void setLastLdapSynchro(Date v)

Description copied from class: Member

Set the value of lastLdapSynchro.

Overrides:

setLastLdapSynchro in class Member

Parameters:

v - Value to assign to lastLdapSynchro.

getWebdavAccess

public boolean getWebdavAccess()

Description copied from class: Member

Get the value of webdavAccess

Overrides:

getWebdavAccess in class Member

Returns:

boolean true if Webdav Access is enabled

setWebdavAccess

public void setWebdavAccess(boolean webdavAccess)

Description copied from class: Member

Set the value of webdavAccess

Overrides:

setWebdavAccess in class Member

getEmailPublic

public Boolean getEmailPublic()

Retrieves whether this member's email is visible to other members or not.

Returns:

true if it is visible, false otherwise

Since:

jcms-6.1

See Also:

Member.isEmailVisible()

setEmailPublic

public void setEmailPublic(Boolean visible)

Sets whether this member's email is visible to other members or not.

Parameters:

visible - true if it is visible, false otherwise

Since:

jcms-6.1

See Also:

Member.setEmailVisible(boolean)

getGids

public String getGids()

Returns the Group ids to which this member belongs.

Returns:

a comma seperated list of Group id

Since:

jcms-6.1

belongsToGroup

public boolean belongsToGroup(Group group)

Description copied from class: Member

This convenient method returns true if this member belongs to a given group.

Overrides:

belongsToGroup in class Member

Parameters:

group - the group

Returns:

true if this member belongs to the given group, false otherwise.

getNotification

public Notification getNotification()

Description copied from class: Member

Get the Notification

Overrides:

getNotification in class Member

Returns:

the notification

setNotification

public void setNotification(Notification notification)

Description copied from class: Member

Sets the Notification

Overrides:

setNotification in class Member

Parameters:

notification - the notification

canEditCategories

public boolean canEditCategories()

Description copied from class: Member

Check if the member can edit categories. Caution: the semantics of this method changed since jcms-3.0. To have fine grain information, please use getCategoryRootSet() method.

Overrides:

canEditCategories in class Member

Returns:

true if the member can edit at least on root of category

See Also:

Member.getCategoryRootSet()

canEditCategories

public boolean canEditCategories(Workspace ws)

Description copied from class: Member

Return true if this member can edit at least one category of this workspace

Overrides:

canEditCategories in class Member

Parameters:

ws - the Workspace to check with

Returns:

true if this member can edit at least one category of this workspace

See Also:

Member.getCategoryRootSet()

getCategoryRootSet

public Set<Category> getCategoryRootSet()

Description copied from class: Member

Returns the set of category roots the member can manage

Overrides:

getCategoryRootSet in class Member

Returns:

a Set of Category (or an empty set if this member has no category right)

getCategoryRootSet

public Set<Category> getCategoryRootSet(Workspace ws)

Description copied from class: Member

Returns the set of category roots the member can manage in a given workspace

Overrides:

getCategoryRootSet in class Member

Parameters:

ws - the Workspace to be test (null for all workspace)

Returns:

a Set of Category (or an empty set if this member has no category right)

canManageCategory

public boolean canManageCategory(Category cat)

Description copied from class: Member

Check if the member can manage the given category (ie if the given category is a descendant of one of the member's root category)

Overrides:

canManageCategory in class Member

Parameters:

cat - the category to test

Returns:

true if this member can manage the category

canManageCategory

public boolean canManageCategory(Category cat,
                                 boolean searchInGroups,
                                 boolean searchInParent)

Description copied from class: Member

Check if the member can manage the given category (ie if the given category is a descendant of one of the member's root category)

Overrides:

canManageCategory in class Member

Parameters:

cat - the category to test

searchInGroups - if true check if one of the group this member belongs to is authorized to read the categorie.

searchInParent - if true check right on parent categories

Returns:

true if this member can manage the category

internalCanManageCategory

protected boolean internalCanManageCategory(Category cat,
                                            boolean searchInGroups,
                                            boolean searchInParent)

Overrides:

internalCanManageCategory in class Member

canCreateWorkspace

public boolean canCreateWorkspace()

Description copied from class: Member

Check if the member can create a workspace

Overrides:

canCreateWorkspace in class Member

Returns:

true if this member can create a Workspace

canCreateWorkspace

public boolean canCreateWorkspace(Workspace model)

Description copied from class: Member

Check if the member can duplicate the model to create a workspace

Overrides:

canCreateWorkspace in class Member

Parameters:

model - the workspace to duplicate

Returns:

true if this member can create a Workspace from the model

getExpandedUseCategorySet

public TreeSet<Category> getExpandedUseCategorySet()

Description copied from class: Member

Return the category set this member can use according his category use mode (group, member or group and member)

Overrides:

getExpandedUseCategorySet in class Member

Returns:

a TreeSet of category this member can use

canUseCategory

public boolean canUseCategory(Category cat)

Description copied from class: Member

Check if this member can use the given category.

Overrides:

canUseCategory in class Member

Parameters:

cat - the category to check

Returns:

true if this member can use the given category.

See Also:

Member.canUseCategory(Category, boolean, boolean)

canUseCategory

public boolean canUseCategory(Category cat,
                              boolean searchInGroups,
                              boolean searchInParent)

Description copied from class: Member

Check if this member can use the given category.

Overrides:

canUseCategory in class Member

Parameters:

cat - the category to check

searchInGroups - if true check if one of the group this member belongs to is authorized to read the categorie.

searchInParent - if true check right on parent categories

Returns:

true if this member can use the given category.

internalCanUseCategory

protected boolean internalCanUseCategory(Category cat,
                                         boolean searchInGroups,
                                         boolean searchInParent)

Overrides:

internalCanUseCategory in class Member

canUseDescendantCategories

public boolean canUseDescendantCategories(Category cat,
                                          boolean checkRoot)

Description copied from class: Member

Check if this member can use at least one descendant of the given category.

Overrides:

canUseDescendantCategories in class Member

Parameters:

cat - the category to check

checkRoot - if true check also the given category

Returns:

true if this member can use at least one descendant of the given category.

getUseCategorySet

public TreeSet<Category> getUseCategorySet()

Description copied from class: Member

Get the value of useCategorySet.

Overrides:

getUseCategorySet in class Member

Returns:

Value of useCategorySet.

setUseCategorySet

public void setUseCategorySet(TreeSet<Category> v)

Description copied from class: Member

Set the value of useCategorySet.

Overrides:

setUseCategorySet in class Member

Parameters:

v - Value to assign to useCategorySet.

getUseCategoryMode

public int getUseCategoryMode()

Description copied from class: Member

Get the value of useCategoryMode.

Overrides:

getUseCategoryMode in class Member

Returns:

Value of useCategoryMode.

setUseCategoryMode

public void setUseCategoryMode(int v)

Description copied from class: Member

Set the value of useCategoryMode.

Overrides:

setUseCategoryMode in class Member

Parameters:

v - Value to assign to useCategoryMode.

getReadCategorySet

public TreeSet<Category> getReadCategorySet()

Description copied from class: Member

Gets the TreeSet of Category used for Publication read right. This category set contains all the categories a publication must match in order to be visible by this member.

Overrides:

getReadCategorySet in class Member

Returns:

a TreeSet of Category.

setReadCategorySet

public void setReadCategorySet(TreeSet<Category> v)

Description copied from class: Member

Set the value of readCategorySet.

Overrides:

setReadCategorySet in class Member

Parameters:

v - Value to assign to readCategorySet.

getDelegateMemberSet

public TreeSet<Member> getDelegateMemberSet()

Description copied from class: Member

Gets the TreeSet of Member allowed to login as this member.

Overrides:

getDelegateMemberSet in class Member

Returns:

a TreeSet of Category.

setDelegateMemberSet

public void setDelegateMemberSet(TreeSet<Member> v)

Description copied from class: Member

Set the value of delegateMbrSet.

Overrides:

setDelegateMemberSet in class Member

Parameters:

v - Value to assign to delegateMbrSet.

updateDelegationHolderSet

public void updateDelegationHolderSet(Member mbr,
                                      boolean add)

Description copied from class: Member

Internal method used to update the (transient) delegation holder set.

Overrides:

updateDelegationHolderSet in class Member

Parameters:

mbr - the member to add or remove from the delegation holder set.

add - true -> add, false -> remove

getDelegationHolderSet

public Set<Member> getDelegationHolderSet()

Description copied from class: Member

Retrieves the list of member into which this member is allowed to log in.

Overrides:

getDelegationHolderSet in class Member

Returns:

a TreeSet of Member (internal variable exposed, do not modify the returned set)

getLanguage

public String getLanguage()

Description copied from class: Member

Get the value of language.

Overrides:

getLanguage in class Member

Returns:

Value of language.

setLanguage

public void setLanguage(String lang)

Description copied from class: Member

Set the value of language.

Overrides:

setLanguage in class Member

Parameters:

lang - Value to assign to language.

canCreateWorkCopy

public boolean canCreateWorkCopy(Publication pub)

Description copied from class: Member

Convenience method

Overrides:

canCreateWorkCopy in class Member

Parameters:

pub - used to create work copy

Returns:

true if the publication can be used

See Also:

Publication.canCreateWorkCopy(Member)

canMergeWorkCopy

public boolean canMergeWorkCopy(Publication pub)

Description copied from class: Member

Convenience method

Overrides:

canMergeWorkCopy in class Member

Parameters:

pub - The publication to merge.

Returns:

boolean true if publication can be merged

See Also:

Publication.canMergeWorkCopy(Member)

getWorkspaceSet

public Set<Workspace> getWorkspaceSet()

Overrides:

getWorkspaceSet in class Member

Returns:

a Set of all Workspace the member belongs to.

refreshWorkspaceSet

public void refreshWorkspaceSet()

Description copied from class: Member

Refresh the workspaces this member belongs to.

Overrides:

refreshWorkspaceSet in class Member

updateWorkspaceSet

public void updateWorkspaceSet(Workspace ws,
                               boolean add)

Description copied from class: Member

Update workspaceSet index

Overrides:

updateWorkspaceSet in class Member

Parameters:

ws - the workspace to be added or removed

add - add if true, remove if false

belongsToWorkspace

public boolean belongsToWorkspace(Workspace ws)

Description copied from class: Member

This convenient method returns true if this member belongs to the given workspace.

Overrides:

belongsToWorkspace in class Member

Parameters:

ws - the workspace to be checked

Returns:

true if this member belongs to this workspace

getWorkspacePublicationSet

public Set<Publication> getWorkspacePublicationSet()

Overrides:

getWorkspacePublicationSet in class Member

belongsToRole

public WKRole belongsToRole()

Overrides:

belongsToRole in class Member

Returns:

the first WKRole the member belongs to

belongsToRole

public WKRole belongsToRole(boolean checkGroups)

Overrides:

belongsToRole in class Member

Parameters:

checkGroups - check also for member groups

Returns:

the first WKRole the member belongs to

belongsToRole

public boolean belongsToRole(WKRole role)

Overrides:

belongsToRole in class Member

Parameters:

role - a WKRole

Returns:

true if member belongs to the WKRole

belongsToRole

public boolean belongsToRole(WKRole role,
                             boolean checkGroups)

Overrides:

belongsToRole in class Member

Parameters:

role - a WKRole

checkGroups - check also for member groups

Returns:

true if member belongs to the WKRole

getAdministratedWorkspaceSet

public SortedSet<Workspace> getAdministratedWorkspaceSet()

Description copied from class: Member

This convenient method returns all the workspace this member is the administrator of.

Overrides:

getAdministratedWorkspaceSet in class Member

Returns:

a set of workspace.

isWorkAdmin

public boolean isWorkAdmin()

Description copied from class: Member

This convenient method check if this member is administrator of at least one workspace.

Overrides:

isWorkAdmin in class Member

Returns:

true if this member is administrator of at least one workspace.

getFavoriteWorkspace

public Workspace getFavoriteWorkspace(Workspace currentWS,
                                      Class<?> clazz)

Description copied from class: Member

Return the favorite Member Workspace where it can work on

Overrides:

getFavoriteWorkspace in class Member

Parameters:

currentWS - the current Workspace

clazz - the class to publish

Returns:

the workspace to use

setName

public void setName(String name)

Description copied from class: Member

Set the name of this member.

Overrides:

setName in class Member

Parameters:

name - the name to use.

setFirstName

public void setFirstName(String firstName)

Description copied from class: Member

Set the first name of this member.

Overrides:

setFirstName in class Member

Parameters:

firstName - the first name to use.

isAdmin

public boolean isAdmin()

Description copied from class: Member

Checks if this member is an administrator of the site.

Overrides:

isAdmin in class Member

Returns:

true if this member is and administrator, false otherwise.

setAdmin

public void setAdmin(boolean isAdmin)

Description copied from class: Member

Sets if this member can administrate the site.

Overrides:

setAdmin in class Member

Parameters:

isAdmin - true if this member is and administrator, false otherwise.

setSalutation

public void setSalutation(String salutation)

Description copied from class: Member

Set the salutation of this member.

Overrides:

setSalutation in class Member

Parameters:

salutation - the salutation token to use, usually one those values

• "mr"
• "mrs"
• "miss"

Even these are the usual string used for the salutation, you can use any other value, as long as you provide the corresponding I18N language property "ui.com.lbl.salut.{value}"

setOrganization

public void setOrganization(String organization)

Description copied from class: Member

Set the organization of this member.

Overrides:

setOrganization in class Member

Parameters:

organization - the organization to use.

setJobTitle

public void setJobTitle(String jobTitle)

Description copied from class: Member

Set the job title of this member.

Overrides:

setJobTitle in class Member

Parameters:

jobTitle - the job title to use.

setPhone

public void setPhone(String phone)

Description copied from class: Member

Set the phone number of this member.

Overrides:

setPhone in class Member

Parameters:

phone - the phone number to use.

setMobile

public void setMobile(String mobile)

Description copied from class: Member

Set the mobile phone number of this member.

Overrides:

setMobile in class Member

Parameters:

mobile - the mobile phone number to use.

setAddress

public void setAddress(String address)

Description copied from class: Member

Set the address of this member.

Overrides:

setAddress in class Member

Parameters:

address - the address (street address, postal code, city, country and all) to use.

setEmail

public void setEmail(String email)

Description copied from class: Member

Set the email address of this member.

Overrides:

setEmail in class Member

Parameters:

email - the email address to use.

setEmailFormat

public void setEmailFormat(String emailFormat)

Description copied from class: Member

Set the email format that will be used to send mail to this member.

Overrides:

setEmailFormat in class Member

Parameters:

emailFormat - the email format to use, must be one of the following values :

• Member.EMAIL_FORMAT_TEXT
• Member.EMAIL_FORMAT_HTML

As of current implementation, default value for a new member is Member.EMAIL_FORMAT_HTML.

getInfo

public String getInfo()

Description copied from class: Member

Gets informations available for this member.

Overrides:

getInfo in class Member

Returns:

the member's information or null if the information has not been set.

setInfo

public void setInfo(String info)

Description copied from class: Member

Set some informations available for this member.

Overrides:

setInfo in class Member

Parameters:

info - the informations to use.

setLogin

public void setLogin(String login)

Description copied from class: Member

Set the login of this member.

Overrides:

setLogin in class Member

Parameters:

login - the login to use, can be any string (id, email, ...), as long as it is kept unique over all members.

setPassword

public void setPassword(String password)

Description copied from class: Member

Set the password of this member.

Overrides:

setPassword in class Member

Parameters:

password - the password to use. Use constants Member.DISABLED_PASSWORD as password value to disable this member.

getRightFromClassMap

public HashMap<String,DataRight> getRightFromClassMap()

Description copied from class: Member

Get the value of rightFromClassMap.

Overrides:

getRightFromClassMap in class Member

Returns:

Value of rightFromClassMap.

setRightFromClassMap

public void setRightFromClassMap(HashMap<String,DataRight> v)

Description copied from class: Member

Set the value of rightFromClassMap.

Overrides:

setRightFromClassMap in class Member

Parameters:

v - Value to assign to rightFromClassMap.

getPublicationSet

public Set<Publication> getPublicationSet()

Description copied from class: Member

Retrieve a Set containing all the Publication of which this member is the author.

Overrides:

getPublicationSet in class Member

Returns:

a Set of Publication, never return null.

updatePublicationSet

public void updatePublicationSet(Publication pub,
                                 boolean add)

Description copied from class: Member

Update publicationSet index

Overrides:

updatePublicationSet in class Member

Parameters:

pub - the publication to be added or removed

add - add if true, remove if false

getContentSet

public Set<Content> getContentSet()

Description copied from class: Member

Get the value of contentSet.

Overrides:

getContentSet in class Member

Returns:

Value of contentSet.

updateContentSet

public void updateContentSet(Content content,
                             boolean add)

Description copied from class: Member

Update contentSet index

Overrides:

updateContentSet in class Member

Parameters:

content - the content to be added or removed

add - add if true, remove if false

reassignMemberPubs

protected void reassignMemberPubs(Member mbr,
                                  Map context)

Overrides:

reassignMemberPubs in class Member

updateRights

protected void updateRights(Member mbr,
                            Map context)

Overrides:

updateRights in class Member

getMemberFromLogin

public static DBMember getMemberFromLogin(String login,
                                          boolean checkDisabled)

Retrieve the DBMember having the specified login.

Parameters:

login - the member's login

checkDisabled - if true, return null if account is disabled

Returns:

the first DBMember found with the specified login or null if none could be found.

Since:

jcms-6.1

getMemberFromEmail

public static DBMember getMemberFromEmail(String email,
                                          boolean checkDisabled)

Retrieve the DBMember having the specified email.

Parameters:

email - the member's email

checkDisabled - if true, return null if account is disabled

Returns:

the first DBMember found with the specified email or null if none could be found.

Since:

jcms-6.1

getLastLoginTimes

public String getLastLoginTimes()

Retrieve a comma seperated list of last login time of this member.

Returns:

a String a coma seperated list of time in millisecond.

Since:

jcms-6.1

setLastLoginTimes

public void setLastLoginTimes(String lastLoginTimes)

Set the comma seperated list of last login time of this member.

Parameters:

lastLoginTimes - a coma seperated list of time in millisecond.

Since:

jcms-6.1

getLastLoginDateSet

public SortedSet<Date> getLastLoginDateSet()

Description copied from class: Member

Retrieve the last login Date of this Member.

Overrides:

getLastLoginDateSet in class Member

Returns:

a Set of Date, return an empty set if this user has never been logged, (never return null).

setLastLoginDate

public void setLastLoginDate(Date date)

Description copied from class: Member

Sets the last login Date of this Member.

Overrides:

setLastLoginDate in class Member

Parameters:

date - the last login date, or null to use now.

convertToMember

public Member convertToMember(Member opAuthor)

Converts this DBMember to a member. This DBMember is deleted and the new member is returned. All the data this DBMember is the author of are be reassigned to the new member.

Parameters:

opAuthor - the author of this operation

Returns:

the new Member.

Since:

jcms-6.1.0