org.kuali.rice.kew.api.extension

Interface ExtensionDefinitionContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

ExtensionDefinition, ExtensionDefinition.Builder, RuleAttribute

public interface ExtensionDefinitionContract
extends Identifiable, Versioned

Defines an extension to some component of Kuali Enterprise Workflow.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationId()
Map<String,String>	getConfiguration() Returns a list of key/value settings that the extension was statically configured with when defined.
String	getDescription()
String	getLabel()
String	getName()
String	getResourceDescriptor() Retrieves the resource descriptor for this extension.
String	getType() The "type" of extension definition.

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Detail

getName

String getName()

getApplicationId

String getApplicationId()

getLabel

String getLabel()

getDescription

String getDescription()

getType

String getType()

The "type" of extension definition. For example, attributes types are defined in: KewApiConstants.RULE_ATTRIBUTE_TYPES

Returns:

the extension definition type

See Also:

KewApiConstants.RULE_ATTRIBUTE_TYPES

getResourceDescriptor

String getResourceDescriptor()

Retrieves the resource descriptor for this extension. This gives the calling code the information it needs to locate and execute the extension resource if it needs to. In practice this is a fully qualified class name.

Returns:

the resource descriptor for this extension, this value should never be blank or null

getConfiguration

Map<String,String> getConfiguration()

Returns a list of key/value settings that the extension was statically configured with when defined.

Returns:

a list of key/value settings that the extension was statically configured with when defined.