org.mbs.services.metatype
Interface ObjectClassDefinitionEx

All Superinterfaces:

ObjectClassDefinition

public interface ObjectClassDefinitionEx
extends ObjectClassDefinition

This interface extends ObjectClassDefinition in order to provide nesting of object class definitions, not defined by standard metatype API.

Since:

$Date: 2006/02/22 08:41:36 $

Author:

Stoyan Zoubev

Field Summary

static int	INPUT Argument for getAttributeDefinitions(int).
static int	OUTPUT Argument for getAttributeDefinitions(int).
static java.lang.String	SUPER Constant for attribute definition id.

Fields inherited from interface org.osgi.service.metatype.ObjectClassDefinition

ALL, OPTIONAL, REQUIRED

Method Summary

AttributeDefinition	getAttributeDefinition(java.lang.String id) Return an attribute definition with the given id.
java.lang.String	getModifier(java.lang.String key) Returns the value of the given modifier.
java.lang.String[]	getModifierKeys() Returns a set of keys for modifiers for this object definition.
DesignateObject	getObject()
ObjectClassDefinition	getObjectClassDefinition(java.lang.String id) Returns nested object class definition with the given id.
ObjectClassDefinition[]	getObjectClassDefinitions() Returns a set of nested object class definitions.
java.lang.String	getPID()

Methods inherited from interface org.osgi.service.metatype.ObjectClassDefinition

getAttributeDefinitions, getDescription, getIcon, getID, getName

Field Detail

INPUT

static final int INPUT

Argument for getAttributeDefinitions(int). INPUT indicates that only definitions that may be used as input data are returned. The value is 3.

See Also:

Constant Field Values

OUTPUT

static final int OUTPUT

Argument for getAttributeDefinitions(int). OUTPUT indicates that only definitions that may be used as output data are returned. The value is 4.

See Also:

Constant Field Values

SUPER

static final java.lang.String SUPER

Constant for attribute definition id. If the object class definition has such attribute, then it is an extension to another object class definition. The type of the attribute is STRING, cardinality is 0 and its default value (returned by AttributeDefinition.getDefaultValue()) indicated the pid of the extended object class definition.

See Also:

Constant Field Values

Method Detail

getAttributeDefinition

AttributeDefinition getAttributeDefinition(java.lang.String id)

Return an attribute definition with the given id.

Parameters:

id - The id of the requested attribute definition.

Returns:

the requested attribute definition or null if no such attribute is available

getModifierKeys

java.lang.String[] getModifierKeys()

Returns a set of keys for modifiers for this object definition. Modifiers are Prosyst extensions of the ObjectClassDefinition interface and are used for the needs of the ConfigurationAdmin Service.

Returns:

modifier keys as an array of Strings.

See Also:

MetaTypeProviderExtern.getConfigurationObjects(java.lang.String)

getModifier

java.lang.String getModifier(java.lang.String key)

Returns the value of the given modifier.

Parameters:

key - The name of the modifier.

Returns:

the value associated to the key. When not present null is returned.

See Also:

getModifierKeys()

getObjectClassDefinition

ObjectClassDefinition getObjectClassDefinition(java.lang.String id)

Returns nested object class definition with the given id.

Parameters:

id - The id of the object class definition

Returns:

the requested nested object class definition or null if object with the given id is not available.

getObjectClassDefinitions

ObjectClassDefinition[] getObjectClassDefinitions()

Returns a set of nested object class definitions.

Returns:

the array of the nested object class definitions or null if not available.

getObject

DesignateObject getObject()

getPID

java.lang.String getPID()