org.cishell.framework.userprefs
Interface UserPrefsProperty

public interface UserPrefsProperty

A standard set of properties and values to be placed in a service's metadata Dictionary when registering a service with the OSGi service registry for the purpose of publishing and receiving user-adjustable preferences. See the CIShell Specification 1.0 for information on publishing user-adjustable preferences.

Field Summary

static String	BUNDLE_VERSION_KEY A key set in each configuration object which states the Bundle-Version of the service when it was last updated
static String	GLOBAL_PREFS_CONF_SUFFIX The suffix to add to the service's PID for getting the global preferences directly from the ConfigurationAdmin (not recommended)
static String	GLOBAL_PREFS_OCD_SUFFIX The suffix to add to the service's PID for generating a global preferences PID when using the standard naming convention
static String	GLOBAL_PREFS_PID The key for specifying a global preferences PID.
static String	LOCAL_PREFS_CONF_SUFFIX The suffix to add to the service's PID for getting the local preferences directly from the ConfigurationAdmin (not recommended)
static String	LOCAL_PREFS_OCD_SUFFIX The suffix to add to the service's PID for generating a local preferences PID when using the standard naming convention
static String	LOCAL_PREFS_PID The key for specifying a local preferences PID.
static String	PARAM_PREFS_CONF_SUFFIX The suffix to add to the service's PID for getting an Algorithm's user-entered input parameter defaults that have been user-adjusted directly from the ConfigurationAdmin (not recommended)
static String	PARAM_PREFS_OCD_SUFFIX The suffix to add to the service's PID for an Algorithm's user-entered input parameters PID when using the standard naming convention
static String	PREFS_PUBLISHED_KEY The key for specifying what types of preferences are published
static String	PUBLISH_GLOBAL_PREFS_VALUE The value for specifying that global preferences are to be published
static String	PUBLISH_LOCAL_PREFS_VALUE The value for specifying that local preferences are to be published
static String	PUBLISH_PARAM_DEFAULT_PREFS_VALUE The value for specifying that an Algorithm's user-entered input parameter defaults may be adjusted by the user
static String	RECEIVE_PREFS_KEY The key for declaring a need to receive preferences.

Field Detail

LOCAL_PREFS_OCD_SUFFIX

static final String LOCAL_PREFS_OCD_SUFFIX

The suffix to add to the service's PID for generating a local preferences PID when using the standard naming convention

See Also:

Constant Field Values

GLOBAL_PREFS_OCD_SUFFIX

static final String GLOBAL_PREFS_OCD_SUFFIX

The suffix to add to the service's PID for generating a global preferences PID when using the standard naming convention

See Also:

Constant Field Values

PARAM_PREFS_OCD_SUFFIX

static final String PARAM_PREFS_OCD_SUFFIX

The suffix to add to the service's PID for an Algorithm's user-entered input parameters PID when using the standard naming convention

See Also:

Constant Field Values

LOCAL_PREFS_PID

static final String LOCAL_PREFS_PID

The key for specifying a local preferences PID. Only use this when not following the standard naming convention.

See Also:

Constant Field Values

GLOBAL_PREFS_PID

static final String GLOBAL_PREFS_PID

The key for specifying a global preferences PID. Only use this when not following the standard naming convention.

See Also:

Constant Field Values

PREFS_PUBLISHED_KEY

static final String PREFS_PUBLISHED_KEY

The key for specifying what types of preferences are published

See Also:

Constant Field Values

PUBLISH_LOCAL_PREFS_VALUE

static final String PUBLISH_LOCAL_PREFS_VALUE

The value for specifying that local preferences are to be published

See Also:

Constant Field Values

PUBLISH_GLOBAL_PREFS_VALUE

static final String PUBLISH_GLOBAL_PREFS_VALUE

The value for specifying that global preferences are to be published

See Also:

Constant Field Values

PUBLISH_PARAM_DEFAULT_PREFS_VALUE

static final String PUBLISH_PARAM_DEFAULT_PREFS_VALUE

The value for specifying that an Algorithm's user-entered input parameter defaults may be adjusted by the user

See Also:

Constant Field Values

RECEIVE_PREFS_KEY

static final String RECEIVE_PREFS_KEY

The key for declaring a need to receive preferences. "true" and "false" are the possible associated values.

See Also:

Constant Field Values

LOCAL_PREFS_CONF_SUFFIX

static final String LOCAL_PREFS_CONF_SUFFIX

The suffix to add to the service's PID for getting the local preferences directly from the ConfigurationAdmin (not recommended)

See Also:

Constant Field Values

GLOBAL_PREFS_CONF_SUFFIX

static final String GLOBAL_PREFS_CONF_SUFFIX

The suffix to add to the service's PID for getting the global preferences directly from the ConfigurationAdmin (not recommended)

See Also:

Constant Field Values

PARAM_PREFS_CONF_SUFFIX

static final String PARAM_PREFS_CONF_SUFFIX

The suffix to add to the service's PID for getting an Algorithm's user-entered input parameter defaults that have been user-adjusted directly from the ConfigurationAdmin (not recommended)

See Also:

Constant Field Values

BUNDLE_VERSION_KEY

static final String BUNDLE_VERSION_KEY

A key set in each configuration object which states the Bundle-Version of the service when it was last updated

See Also:

Constant Field Values