RoleActivator

java.lang.Object
- com.ibm.commerce.telesales.platform.roles.RoleActivator

All Implemented Interfaces:

org.eclipse.ui.activities.IActivityManagerListener
```
public class RoleActivator
extends java.lang.Object
implements org.eclipse.ui.activities.IActivityManagerListener
```
The RoleActivator manages the role framework by activating Eclipse activities listed in the com.ibm.commerce.telesales.roles and com.ibm.commerce.telesales.activitySet extension points.
The default role is Customer Service Representative and can be overridden by using the System Configurator or by providing the command-line argument -clientAdmin.

The following roles are supported:
- Customer Service Representative
- Customer Service Supervisor
- Site Administrator
- Client Administrator

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`ROLE_CLIENT_ADMIN` Default Client Administrator role ID (value `"Client Administrator"`).
`static java.lang.String`	`ROLE_CUSTOMER_SERVICE_REPRESENTATIVE` Default Customer Service Representative role ID (value `"Customer Service Representative"`).
`static java.lang.String`	`ROLE_CUSTOMER_SERVICE_SUPERVISOR` Default Customer Service Supervisor role ID (value `"Customer Service Supervisor"`).
`static java.lang.String`	`ROLE_SITE_ADMIN` Default Site Administrator role ID (value `"Site Administrator"`).

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activityManagerChanged(org.eclipse.ui.activities.ActivityManagerEvent activityManagerEvent)` Notifies that one or more properties of an instance of `IActivityManager` have changed.
`java.lang.String[]`	`getActiveRoles()` Returns the active roles for the workbench.
`static RoleActivator`	`getInstance()` Returns the singleton instance of the service.
`java.lang.String`	`getRoleLabel(java.lang.String roleId)` Returns the given role's displayable label.
`boolean`	`hasRole(java.lang.String roleId)` This method validates whether the given role is defined in the platform.
`void`	`init()` Initializes the role framework for activation.
`boolean`	`isActivityEnabled(java.lang.String activityId)` Returns whether the given activity is enabled.
`void`	`reset()` Resets the workbench to the initial state at startup.
`void`	`setActiveRoles(java.lang.String[] roleIds)` Sets the active roles for the workbench.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - ROLE_CLIENT_ADMIN
```
public static final java.lang.String ROLE_CLIENT_ADMIN
```
    Default Client Administrator role ID (value "Client Administrator").
    
    See Also:
    
    Constant Field Values
  - ROLE_SITE_ADMIN
```
public static final java.lang.String ROLE_SITE_ADMIN
```
    Default Site Administrator role ID (value "Site Administrator").
    
    See Also:
    
    Constant Field Values
  - ROLE_CUSTOMER_SERVICE_REPRESENTATIVE
```
public static final java.lang.String ROLE_CUSTOMER_SERVICE_REPRESENTATIVE
```
    Default Customer Service Representative role ID (value "Customer Service Representative").
    
    See Also:
    
    Constant Field Values
  - ROLE_CUSTOMER_SERVICE_SUPERVISOR
```
public static final java.lang.String ROLE_CUSTOMER_SERVICE_SUPERVISOR
```
    Default Customer Service Supervisor role ID (value "Customer Service Supervisor").
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static RoleActivator getInstance()
```
    Returns the singleton instance of the service.
    
    Returns:
    
    RoleActivator instance
  - init
```
public void init()
```
    Initializes the role framework for activation.
    If the framework has a queue of roles to set, once activated those roles will be activated.
    
    See Also:
    
    setActiveRoles(String[])
  - reset
```
public void reset()
```
    Resets the workbench to the initial state at startup.
    Note: If a "-role" command-line argument was found, the workbench will be reset to the argument's role state.
  - setActiveRoles
```
public void setActiveRoles(java.lang.String[] roleIds)
```
    Sets the active roles for the workbench. The enablement for the roles' activities will be set accordingly.
    If there are conflicting enablement settings (true and false) for the same activity within different roles, then the enablement setting of true is used.
    
    Note: Any activities defined using org.eclipse.ui.activities that are not used by any com.ibm.commerce.telesales.activitySets will be preserved.
    
    Parameters:
    
    roleIds - an array of role IDs that map to the roleId defined in the com.ibm.commerce.telesales.ui.roles extension definitions
    
    See Also:
    
    getActiveRoles()
  - getActiveRoles
```
public java.lang.String[] getActiveRoles()
```
    Returns the active roles for the workbench.
    
    Returns:
    
    an array of role IDs that map to the roleId defined in the com.ibm.commerce.telesales.ui.roles extension definitions
    
    See Also:
    
    setActiveRoles(String[])
  - getRoleLabel
```
public java.lang.String getRoleLabel(java.lang.String roleId)
```
    Returns the given role's displayable label. The returned value corresponds to the label attribute defined in the com.ibm.commerce.telesales.ui.roles extension definitions
    
    Parameters:
    
    roleId - the role ID
    
    Returns:
    
    the role's displayable label
  - isActivityEnabled
```
public boolean isActivityEnabled(java.lang.String activityId)
```
    Returns whether the given activity is enabled. If there are conflicting enablement settings (true and false) for the same activity within different roles, then the enablement setting of true is used.
    
    Parameters:
    
    activityId - the unique identifier of the activity
    
    Returns:
    
    true if the activity is enabled, false otherwise
  - hasRole
```
public boolean hasRole(java.lang.String roleId)
```
    This method validates whether the given role is defined in the platform.
    
    Parameters:
    
    roleId - the role identifier
    
    Returns:
    
    true if the role is found, false otherwise
  - activityManagerChanged
```
public void activityManagerChanged(org.eclipse.ui.activities.ActivityManagerEvent activityManagerEvent)
```
    Notifies that one or more properties of an instance of IActivityManager have changed. Specific details are described in the ActivityManagerEvent.
    
    Specified by:
    
    activityManagerChanged in interface org.eclipse.ui.activities.IActivityManagerListener
    
    Parameters:
    
    activityManagerEvent - the activity manager event. Guaranteed not to be null.
    
    See Also:
    
    IActivityManagerListener.activityManagerChanged(org.eclipse.ui.activities.ActivityManagerEvent)

Class RoleActivator

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

ROLE_CLIENT_ADMIN

ROLE_SITE_ADMIN

ROLE_CUSTOMER_SERVICE_REPRESENTATIVE

ROLE_CUSTOMER_SERVICE_SUPERVISOR

Method Detail

getInstance

init

reset

setActiveRoles

getActiveRoles

getRoleLabel

isActivityEnabled

hasRole

activityManagerChanged