org.mule.runtime.api.metadata

Interface MetadataKey

All Superinterfaces:

MetadataEnrichableModel

All Known Implementing Classes:

DefaultMetadataKey

public interface MetadataKey
extends MetadataEnrichableModel

A key, that with the given ID, represents a MetadataType. This key can be contributed with a display name and user defined properties.

Also this MetadataKey can be composed by other MetadataKeys to form a composed key.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Set<MetadataKey>	getChilds()
String	getDisplayName()
String	getId()
String	getPartName()

Methods inherited from interface org.mule.runtime.api.metadata.MetadataEnrichableModel

getMetadataProperty, getProperties

Method Detail

getId

String getId()

Returns:

identifier for the current key

getDisplayName

String getDisplayName()

Returns:

human readable name to use when displaying the key

getChilds

Set<MetadataKey> getChilds()

Returns:

the child MetadataKeys that form a composed MetadataKey.

getPartName

String getPartName()

Returns:

the name of the part which this MetadataKey is from