Package com.jalios.jcms
Class WFRole
java.lang.Object
com.jalios.jcms.WFRole
- All Implemented Interfaces:
Comparable
This class represent a Role. A role is a list of members and a list
of weighted group.
- Since:
- jcms-4.0.2
- Author:
- Olivier Dedieu
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringbuildRoleUID(String wfId, String roleId) Build the unique role ID.intMust be implemented with the interface Comparable Used in different comparator for sortingbooleangetDescription(String lang) Returns the localized name of this description according thelangattribute.Returns the map of localized description.getId()Returns the unique id of this role.Returns the localized name of this role according thelangattribute.Returns the map of localized name.Returns the roleId of this role.getWfId()Returns the workflow ID this role belongs to.org.jdom.ElementReturns the XML Element of this role.voidReload all I18N informations for this WFRole.voidsetDescriptionMap(Map<String, String> descriptionMap) Sets the map of localized description.voidsetNameMap(Map<String, String> nameMap) Sets the map of localized name.voidSets the roleId of this role.voidSets the workflow ID this role belongs to.voidsetXmlElt(org.jdom.Element xmlElt) Sets the XML Element of this role.toString()
-
Field Details
-
ID_SEPARATOR
- See Also:
-
-
Constructor Details
-
WFRole
public WFRole() -
WFRole
-
WFRole
-
-
Method Details
-
reloadI18N
public void reloadI18N()Reload all I18N informations for this WFRole. This includes : label and description.- Since:
- jcms-8.0.2
-
toString
-
compareTo
Must be implemented with the interface Comparable Used in different comparator for sorting- Specified by:
compareToin interfaceComparable
-
getName
Returns the localized name of this role according thelangattribute.- Parameters:
lang- the language.- Returns:
- the localized name of this role.
- Since:
- jcms-5.7.0
-
getDescription
Returns the localized name of this description according thelangattribute.- Parameters:
lang- the language.- Returns:
- the localized name of this description.
- Since:
- jcms-5.7.0
-
getId
Returns the unique id of this role.- Returns:
- the unique id of this role.
- Since:
- jcms-9.0.0
-
buildRoleUID
Build the unique role ID.- Parameters:
wfId- the ID of the workflow of the roleroleId- the ID of the role.- Returns:
- the unique role ID.
- Since:
- jcms-9.0.0
-
getRoleId
Returns the roleId of this role. Generally you should targets a role with getId() instead of getRoleId().- Returns:
- the roleId of this role.
- Since:
- jcms-9.0.0
-
setRoleId
Sets the roleId of this role.- Parameters:
roleId- the roleId.- Since:
- jcms-9.0.0
-
getNameMap
Returns the map of localized name.- Returns:
- the map of localized name.
- Since:
- jcms-5.7.0
-
setNameMap
Sets the map of localized name.- Parameters:
nameMap- the map of localized name.- Since:
- jcms-5.7.0
-
getDescriptionMap
Returns the map of localized description.- Returns:
- the map of localized description.
- Since:
- jcms-5.7.0
-
setDescriptionMap
Sets the map of localized description.- Parameters:
descriptionMap- the map of localized description.- Since:
- jcms-5.7.0
-
getWfId
Returns the workflow ID this role belongs to.- Returns:
- the workflow ID this role belongs to.
- Since:
- jcms-9.0.0
-
setWfId
Sets the workflow ID this role belongs to.- Parameters:
wfId- the workflow ID- Since:
- jcms-9.0.0
-
getXmlElt
public org.jdom.Element getXmlElt()Returns the XML Element of this role.- Returns:
- the XML Element of this role.
- Since:
- jcms-9.0.0
-
setXmlElt
public void setXmlElt(org.jdom.Element xmlElt) Sets the XML Element of this role.- Parameters:
xmlElt- XML Element of this role.- Since:
- jcms-9.0.0
-
equals
-