org.kuali.rice.krms.impl.repository
Interface TermBoService

All Superinterfaces:

TermRepositoryService

All Known Implementing Classes:

TermBoServiceImpl

public interface TermBoService
extends TermRepositoryService

BO service for terms and related entities

Author:

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

Method Summary

TermDefinition	createTerm(TermDefinition termDef) Create a TermDefinition
TermResolverDefinition	createTermResolver(TermResolverDefinition termResolver) Creates the TermResolverDefinition.
TermSpecificationDefinition	createTermSpecification(TermSpecificationDefinition termSpec) Creates a TermSpecificationDefinition
List<TermResolverDefinition>	findTermResolversByNamespace(String namespace) Retrieves all TermResolverDefinitions for the given namespace.
List<TermResolverDefinition>	findTermResolversByOutputId(String id, String namespace) Get the TermResolverDefinitions for any term resolvers in the specified namespace that have the given term specification as their output.
TermDefinition	getTerm(String id) Retrieves the TermDefinition with the given termId.
TermResolverDefinition	getTermResolverById(String id) Retrieves the TermResolverDefinition with the given id.
TermSpecificationDefinition	getTermSpecificationById(String id) Retrieves the TermSpecificationDefinition with the given TermSpecificationId.

Methods inherited from interface org.kuali.rice.krms.api.repository.term.TermRepositoryService

deleteTerm, deleteTermResolver, deleteTermSpecification, getTermResolverByNameAndNamespace, getTermSpecificationByNameAndNamespace, updateTerm, updateTermResolver, updateTermSpecification

Method Detail

getTermSpecificationById

@Cacheable(value="http://rice.kuali.org/krms/v2_0/TermSpecificationType",
           key="\'id=\' + #p0")
TermSpecificationDefinition getTermSpecificationById(String id)

Description copied from interface: TermRepositoryService

Retrieves the TermSpecificationDefinition with the given TermSpecificationId.

Specified by:

getTermSpecificationById in interface TermRepositoryService

Parameters:

id - the identifier of the term specification to retrieve.

Returns:

the TermSpecificationDefinition with the given id. May be null if there is no term specification with the given id in the repository.

createTermSpecification

@CacheEvict(value={"http://rice.kuali.org/krms/v2_0/TermSpecificationType","http://rice.kuali.org/krms/v2_0/termDefinitionType"},
            allEntries=true)
TermSpecificationDefinition createTermSpecification(TermSpecificationDefinition termSpec)

Description copied from interface: TermRepositoryService

Creates a TermSpecificationDefinition

Specified by:

createTermSpecification in interface TermRepositoryService

Parameters:

termSpec - the term specification to be created

Returns:

the TermSpecificationDefinition after it has been created in the repository.

getTerm

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

Description copied from interface: TermRepositoryService

Retrieves the TermDefinition with the given termId.

Specified by:

getTerm in interface TermRepositoryService

Parameters:

id - 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.

createTerm

@CacheEvict(value="http://rice.kuali.org/krms/v2_0/termDefinitionType",
            allEntries=true)
TermDefinition createTerm(TermDefinition termDef)

Description copied from interface: TermRepositoryService

Create a TermDefinition

Specified by:

createTerm in interface TermRepositoryService

Parameters:

termDef - to be created

Returns:

the TermDefinition term definition after it has been created in the repository.

getTermResolverById

@Cacheable(value="http://rice.kuali.org/krms/v2_0/termResolverDefinitionType",
           key="\'id=\' + #p0")
TermResolverDefinition getTermResolverById(String id)

Description copied from interface: TermRepositoryService

Retrieves the TermResolverDefinition with the given id.

Specified by:

getTermResolverById in interface TermRepositoryService

Parameters:

id - the identifier of the term to retrieve.

Returns:

the TermResolverDefinition with the given id. May be null if there is no term with the given id in the repository.

findTermResolversByOutputId

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

Get the TermResolverDefinitions for any term resolvers in the specified namespace that have the given term specification as their output.

Specified by:

findTermResolversByOutputId in interface TermRepositoryService

Parameters:

id - the id for the term specification

namespace - the namespace to search

Returns:

the List of term resolvers found. If none are found, an empty list will be returned.

findTermResolversByNamespace

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

Description copied from interface: TermRepositoryService

Retrieves all TermResolverDefinitions for the given namespace.

Specified by:

findTermResolversByNamespace in interface TermRepositoryService

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.

createTermResolver

@CacheEvict(value={"http://rice.kuali.org/krms/v2_0/termResolverDefinitionType","http://rice.kuali.org/krms/v2_0/termDefinitionType"},
            allEntries=true)
TermResolverDefinition createTermResolver(TermResolverDefinition termResolver)

Description copied from interface: TermRepositoryService

Creates the TermResolverDefinition.

Specified by:

createTermResolver in interface TermRepositoryService

Parameters:

termResolver - to be created

Returns:

the TermResolver after it has been created in the repository.