oracle.ide.extension

Class RoleManager

java.lang.Object

oracle.ide.extension.RoleManager

public abstract class RoleManager
extends java.lang.Object

The role manager is responsible for co-ordinating the selection of the current role.

This class is not intended for subclassing by extension writers. Retrieve an instance of the RoleManager using ExtensionRegistry.getRoleManager().

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
static Role	NO_ROLE The special predefined role that indicates no role is active.

Constructor Summary

Constructors

Constructor and Description
RoleManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canSwitchRoles() Indicates whether or not the product supports switching roles.
abstract Role	getActiveRole() Gets the active role.
boolean	isDefaultRoleActive() Returns true if the default role is active.
void	switchToRole(java.lang.String roleId, Context context, boolean force) Invokes an action that switches to the Role identified by the supplied role id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_ROLE

public static final Role NO_ROLE

The special predefined role that indicates no role is active.

Constructor Detail

RoleManager

public RoleManager()

Method Detail

getActiveRole

public abstract Role getActiveRole()

Gets the active role.

Returns:

the currently active role. This will never be null, it may be the predefined NO_ROLE instance.

canSwitchRoles

public abstract boolean canSwitchRoles()

Indicates whether or not the product supports switching roles.

isDefaultRoleActive

public final boolean isDefaultRoleActive()

Returns true if the default role is active. This is a shortcut for getActiveRole() == NO_ROLE.

Returns:

true if the default role is active.

switchToRole

public void switchToRole(java.lang.String roleId,
                         Context context,
                         boolean force)

Invokes an action that switches to the Role identified by the supplied role id. The role id must identify a valid Role. If force is true, JDeveloper will exit/restart immediately and without any prompt, otherwise the user will be required to confirm exit/restart with a standard prompt.

Parameters:

roleId - a valid role id, must not be null

context - the active context

force - indicates whether to show a cofirmation prompt before exit/restart; if true no confirmation dialog is shown and JDeveloper exits immediately

Throws:

java.lang.IllegalArgumentException - if the supplied role id is does not match any available Role