org.kuali.rice.kew.api.extension
Class ExtensionDefinition

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.extension.ExtensionDefinition

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, ExtensionDefinitionContract

public final class ExtensionDefinition
extends AbstractDataTransferObject
implements ExtensionDefinitionContract

Immutable implementation of the ExtensionDefinitionContract. Defines an extension to some component of Kuali Enterprise Workflow.

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class	ExtensionDefinition.Builder A builder which can be used to construct ExtensionDefinition instances.
static class	ExtensionDefinition.Cache

Method Summary

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	getId() The unique identifier for an object.
String	getLabel()
String	getName()
String	getResourceDescriptor() Retrieves the resource descriptor for this extension.
String	getType() The "type" of extension definition.
Long	getVersionNumber() Returns the version number for this object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getName

public String getName()

Specified by:

getName in interface ExtensionDefinitionContract

getApplicationId

public String getApplicationId()

Specified by:

getApplicationId in interface ExtensionDefinitionContract

getLabel

public String getLabel()

Specified by:

getLabel in interface ExtensionDefinitionContract

getDescription

public String getDescription()

Specified by:

getDescription in interface ExtensionDefinitionContract

getType

public String getType()

Description copied from interface: ExtensionDefinitionContract

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

Specified by:

getType in interface ExtensionDefinitionContract

Returns:

the extension definition type

See Also:

KewApiConstants.RULE_ATTRIBUTE_TYPES

getResourceDescriptor

public String getResourceDescriptor()

Description copied from interface: ExtensionDefinitionContract

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.

Specified by:

getResourceDescriptor in interface ExtensionDefinitionContract

Returns:

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

getConfiguration

public Map<String,String> getConfiguration()

Description copied from interface: ExtensionDefinitionContract

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

Specified by:

getConfiguration in interface ExtensionDefinitionContract

Returns:

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

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet