View Javadoc

1   /**
2    * Copyright 2005-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krms.impl.repository;
17  
18  import java.util.List;
19  
20  import org.kuali.rice.krms.api.repository.term.TermDefinition;
21  import org.kuali.rice.krms.api.repository.term.TermRepositoryService;
22  import org.kuali.rice.krms.api.repository.term.TermResolverDefinition;
23  import org.kuali.rice.krms.api.repository.term.TermSpecificationDefinition;
24  import org.springframework.cache.annotation.CacheEvict;
25  import org.springframework.cache.annotation.Cacheable;
26  
27  /**
28   * BO service for terms and related entities
29   * 
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   *
32   */
33  public interface TermBoService extends TermRepositoryService {
34  	
35  	// TODO: javadocs
36      @Cacheable(value= TermSpecificationDefinition.Cache.NAME, key="'id=' + #p0")
37  	TermSpecificationDefinition getTermSpecificationById(String id);
38  
39      @CacheEvict(value={TermSpecificationDefinition.Cache.NAME, TermDefinition.Cache.NAME}, allEntries = true)
40  	TermSpecificationDefinition createTermSpecification(TermSpecificationDefinition termSpec);
41  
42      @Cacheable(value= TermDefinition.Cache.NAME, key="'id=' + #p0")
43      TermDefinition getTerm(String id);
44  
45      @CacheEvict(value={TermDefinition.Cache.NAME}, allEntries = true)
46  	TermDefinition createTerm(TermDefinition termDef);
47  
48      @Cacheable(value= TermResolverDefinition.Cache.NAME, key="'id=' + #p0")
49  	TermResolverDefinition getTermResolverById(String id);
50  
51      /**
52       * Get the {@link TermResolverDefinition}s for any term resolvers in the specified namespace that have the given
53       * term specification as their output.
54       *
55       * @param id the id for the term specification
56       * @param namespace the namespace to search
57       * @return the List of term resolvers found.  If none are found, an empty list will be returned.
58       */
59      @Cacheable(value= TermResolverDefinition.Cache.NAME, key="'id=' + #p0 + '|' + 'namespace=' + #p1")
60      List<TermResolverDefinition> findTermResolversByOutputId(String id, String namespace);
61  
62      @Cacheable(value= TermResolverDefinition.Cache.NAME, key="'namespace=' + #p0")
63      List<TermResolverDefinition> findTermResolversByNamespace(String namespace);
64  
65      @CacheEvict(value={TermResolverDefinition.Cache.NAME, TermDefinition.Cache.NAME}, allEntries = true)
66  	TermResolverDefinition createTermResolver(TermResolverDefinition termResolver);
67  }