org.kuali.rice.kew.api.extension

Interface ExtensionRepositoryService

All Known Implementing Classes:

ExtensionRepositoryServiceImpl

public interface ExtensionRepositoryService

A service which is used for retrieving information about extensions to various pieces of Kuali Enterprise Workflow.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionDefinition	getExtensionById(String id) Returns the ExtensionDefinition of the RuleAttribute for the given id.
ExtensionDefinition	getExtensionByName(String name) Returns the ExtensionDefinition of the RuleAttribute for the given name.
List<ExtensionDefinition>	getExtensionsByResourceDescriptor(String resourceDescriptor) Returns the ExtensionDefinition of the RuleAttribute for the given resourceDescriptor.

Method Detail

getExtensionById

@Cacheable(value="http://rice.kuali.org/kew/v2_0/ExtensionDefinitionType",
           key="\'id=\' + #p0")
ExtensionDefinition getExtensionById(String id)
                                     throws RiceIllegalArgumentException

Returns the ExtensionDefinition of the RuleAttribute for the given id.

Parameters:

id - the id to search by.

Returns:

the extension definition found for the matching rule attribute service

Throws:

RiceIllegalArgumentException - if id is null or blank

getExtensionByName

@Cacheable(value="http://rice.kuali.org/kew/v2_0/ExtensionDefinitionType",
           key="\'name=\' + #p0")
ExtensionDefinition getExtensionByName(String name)
                                       throws RiceIllegalArgumentException

Returns the ExtensionDefinition of the RuleAttribute for the given name.

Parameters:

name - the name to search by.

Returns:

the extension definition found for the matching rule attribute service

Throws:

RiceIllegalArgumentException - if name is null or blank

getExtensionsByResourceDescriptor

@Cacheable(value="http://rice.kuali.org/kew/v2_0/ExtensionDefinitionType",
           key="\'resourceDescriptor=\' + #p0")
List<ExtensionDefinition> getExtensionsByResourceDescriptor(String resourceDescriptor)
                                                            throws RiceIllegalArgumentException

Returns the ExtensionDefinition of the RuleAttribute for the given resourceDescriptor.

Parameters:

resourceDescriptor - the resourceDescriptor to search by.

Returns:

the extension definition found for the matching rule attribute service

Throws:

RiceIllegalArgumentException - if resourceDescriptor is null or blank