org.kuali.rice.krms.api.repository.term

Interface TermRepositoryService

All Known Subinterfaces:

TermBoService

All Known Implementing Classes:

TermBoServiceImpl

public interface TermRepositoryService

The TermRepositoryService provides the basic access to terms and term resolvers in the repository needed for executing rules.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
List<TermSpecificationDefinition>	findAllTermSpecificationsByContextId(String contextId) Retrieves all the TermSpecificationDefinitions that are valid for the context with the given contextId.
List<TermResolverDefinition>	findTermResolversByNamespace(String namespace) Retrieves all TermResolverDefinitions for the given namespace.
TermDefinition	getTerm(String termId) Retrieves the TermDefinition with the given termId.

Method Detail

findTermResolversByNamespace

@Cacheable(value="http://rice.kuali.org/krms/v2_0/termResolverDefinitionType",
           key="\'namespace=\' + #p0")
List<TermResolverDefinition> findTermResolversByNamespace(String namespace)
                                                          throws RiceIllegalArgumentException

Retrieves all TermResolverDefinitions for the given namespace.

Parameters:

namespace - the namespace for which to get all term resolvers.

Returns:

the List of TermResolverDefinitions for the given namespace. May be empty, but never null.

Throws:

RiceIllegalArgumentException - if the namespace is null or blank.

Since:

2.1.1

getTerm

@Cacheable(value="http://rice.kuali.org/krms/v2_0/termDefinitionType",
           key="\'id=\' + #p0")
TermDefinition getTerm(String termId)
                       throws RiceIllegalArgumentException

Retrieves the TermDefinition with the given termId.

Parameters:

termId - the identifier of the term to retrieve.

Returns:

the TermDefinition with the given termId. May be null if there is no term with the given termId in the repository.

Throws:

RiceIllegalArgumentException - if the termId is null or blank.

Since:

2.1.1

findAllTermSpecificationsByContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/TermSpecificationType",
           key="\'id=\' + #p0")
List<TermSpecificationDefinition> findAllTermSpecificationsByContextId(String contextId)
                                                                       throws RiceIllegalArgumentException

Retrieves all the TermSpecificationDefinitions that are valid for the context with the given contextId.

Parameters:

contextId - the identifier for the context whose valid TermSpecificationDefinitions are to be retrieved.

Returns:

all the TermSpecificationDefinitions that are valid for the context with the given contextId. May be empty but never null

Throws:

RiceIllegalArgumentException - if the contextId is null or blank.

Since:

2.1.4