Class WFRole

java.lang.Object
com.jalios.jcms.WFRole
All Implemented Interfaces:
Comparable

public class WFRole extends Object implements 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 Details

  • Constructor Details

    • WFRole

      public WFRole()
    • WFRole

      public WFRole(WFRole other)
    • WFRole

      public WFRole(WFRole other, boolean clone)
  • Method Details

    • reloadI18N

      public void reloadI18N()
      Reload all I18N informations for this WFRole. This includes : label and description.
      Since:
      jcms-8.0.2
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • compareTo

      public int compareTo(Object o)
      Must be implemented with the interface Comparable Used in different comparator for sorting
      Specified by:
      compareTo in interface Comparable
    • getName

      public String getName(String lang)
      Returns the localized name of this role according the lang attribute.
      Parameters:
      lang - the language.
      Returns:
      the localized name of this role.
      Since:
      jcms-5.7.0
    • getDescription

      public String getDescription(String lang)
      Returns the localized name of this description according the lang attribute.
      Parameters:
      lang - the language.
      Returns:
      the localized name of this description.
      Since:
      jcms-5.7.0
    • getId

      public String getId()
      Returns the unique id of this role.
      Returns:
      the unique id of this role.
      Since:
      jcms-9.0.0
    • buildRoleUID

      public static String buildRoleUID(String wfId, String roleId)
      Build the unique role ID.
      Parameters:
      wfId - the ID of the workflow of the role
      roleId - the ID of the role.
      Returns:
      the unique role ID.
      Since:
      jcms-9.0.0
    • getRoleId

      public String 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

      public void setRoleId(String roleId)
      Sets the roleId of this role.
      Parameters:
      roleId - the roleId.
      Since:
      jcms-9.0.0
    • getNameMap

      public Map<String,String> getNameMap()
      Returns the map of localized name.
      Returns:
      the map of localized name.
      Since:
      jcms-5.7.0
    • setNameMap

      public void setNameMap(Map<String,String> nameMap)
      Sets the map of localized name.
      Parameters:
      nameMap - the map of localized name.
      Since:
      jcms-5.7.0
    • getDescriptionMap

      public Map<String,String> getDescriptionMap()
      Returns the map of localized description.
      Returns:
      the map of localized description.
      Since:
      jcms-5.7.0
    • setDescriptionMap

      public void setDescriptionMap(Map<String,String> descriptionMap)
      Sets the map of localized description.
      Parameters:
      descriptionMap - the map of localized description.
      Since:
      jcms-5.7.0
    • getWfId

      public String getWfId()
      Returns the workflow ID this role belongs to.
      Returns:
      the workflow ID this role belongs to.
      Since:
      jcms-9.0.0
    • setWfId

      public void setWfId(String wfId)
      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

      public boolean equals(Object obj)
      Overrides:
      equals in class Object