Interface RoleAddCmd

  • All Superinterfaces:
    AccCommand,,,, ControllerCommand, ECCommand, Protectable,,
    All Known Implementing Classes:

    public interface RoleAddCmd
    extends ControllerCommand
    RoleAdd command creates a role at the site level and assigns it to the Root Organization.

    Roles are stored in the ROLE table.

    Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.

    The parameter roleName is mandatory.


    • Create a role in the ROLE table.
    • Assign this role to Root Organization (orgEntityId=-2001).

    Exception Conditions

    • roleName is null (_ERR_CMD_MISSING_PARAM).
    • The length of roleName equals to 0 (_ERR_CMD_INVALID_PARAM).
    • Same roleName already exists (_ERR_ROLENAME_ALREADY_EXIST).
    • Method Detail

      • getRoleDescription

        java.lang.String getRoleDescription()
        Get the description of the role.
        The description of the role
      • getRoleId

        java.lang.String getRoleId()
        Get the roleId of the role added. Called after the command is execute to get the roleId of the role just added.
        The roleId of the role added
      • getRoleName

        java.lang.String getRoleName()
        Get the name of the role.
        The name of the role
      • reset

        void reset()
        Reset all instance variables of the command to initial state so it can be used again.
        Specified by:
        reset in interface
      • setRoleDescription

        void setRoleDescription(java.lang.String astrRoleDescription)
        Set the description of the role
        astrRoleDescription - The description of the role
      • setRoleName

        void setRoleName(java.lang.String astrRoleName)
        Set the name of the role.
        astrRoleName - The name of the role