Enum EPluginStoreItemInstallScope

java.lang.Object

java.lang.Enum<EPluginStoreItemInstallScope>

de.xima.fc.pluginstore.EPluginStoreItemInstallScope

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<EPluginStoreItemInstallScope>

public enum EPluginStoreItemInstallScope
extends Enum<EPluginStoreItemInstallScope>
implements INamedUiElement

Enumeration of the possible scope of a plugin store item, indicating also if the client overloads a plugin installed also in system scope.

Since:

8.0.2

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	The plugin is installed in client scope.
OVERLOADED	The plugin is installed in system AND client scope.
SYSTEM	The plugin is installed in system scope.

Field Summary

Fields inherited from interface INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
String	getDisplayName(Locale locale)	The display name of this element in the given locale.
String	getDisplayNameDescription(Locale locale)
String	getDisplayNameShort(Locale locale)
static EPluginStoreItemInstallScope	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EPluginStoreItemInstallScope[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYSTEM

public static final EPluginStoreItemInstallScope SYSTEM

The plugin is installed in system scope.

CLIENT

public static final EPluginStoreItemInstallScope CLIENT

The plugin is installed in client scope.

OVERLOADED

public static final EPluginStoreItemInstallScope OVERLOADED

The plugin is installed in system AND client scope.

Method Details

values

public static EPluginStoreItemInstallScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EPluginStoreItemInstallScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName(Locale locale)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

locale - The locale to get the display name for.

Returns:

The display name of this element in the given locale.

getDisplayNameDescription

public String getDisplayNameDescription(Locale locale)

Parameters:

locale - Locale for which to obtain the description.

Returns:

A longer description of this item.

getDisplayNameShort

public String getDisplayNameShort(Locale locale)

Parameters:

locale - Locale for which to obtain the short name.

Returns:

A short localized name of this item.