org.kuali.rice.kew.api.extension

Class ExtensionDefinition.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelBuilder, ExtensionDefinitionContract

Enclosing class:

ExtensionDefinition

public static final class ExtensionDefinition.Builder
extends Object
implements Serializable, ModelBuilder, ExtensionDefinitionContract

A builder which can be used to construct ExtensionDefinition instances. Enforces the constraints of the ExtensionDefinitionContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionDefinition	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static ExtensionDefinition.Builder	create(ExtensionDefinitionContract contract)
static ExtensionDefinition.Builder	create(String name, String type, String resourceDescriptor)
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.
void	setApplicationId(String applicationId)
void	setConfiguration(Map<String,String> configuration)
void	setDescription(String description)
void	setId(String id)
void	setLabel(String label)
void	setName(String name)
void	setResourceDescriptor(String resourceDescriptor)
void	setType(String type)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ExtensionDefinition.Builder create(String name,
                                 String type,
                                 String resourceDescriptor)

create

public static ExtensionDefinition.Builder create(ExtensionDefinitionContract contract)

build

public ExtensionDefinition build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

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

setId

public void setId(String id)

setName

public void setName(String name)

setApplicationId

public void setApplicationId(String applicationId)

setLabel

public void setLabel(String label)

setDescription

public void setDescription(String description)

setType

public void setType(String type)

setResourceDescriptor

public void setResourceDescriptor(String resourceDescriptor)

setConfiguration

public void setConfiguration(Map<String,String> configuration)

setVersionNumber

public void setVersionNumber(Long versionNumber)