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.krad.service;
17  
18  import java.util.Collection;
19  import java.util.Map;
20  
21  /**
22   * Defines business logic methods that support the Lookup framework
23   * 
24   * @author Kuali Rice Team (rice.collab@kuali.org)
25   */
26  public interface LookupService {
27  
28      /**
29       * Returns a collection of objects based on the given search parameters.
30       * Will not limit results, so the returned Collection could be huge.
31       *                                                         o
32       * @param example
33       * @param formProps
34       * @return
35       */
36      public <T extends Object> Collection<T> findCollectionBySearchUnbounded(Class<T> example,
37              Map<String, String> formProps);
38  
39      /**
40       * Returns a collection of objects based on the given search parameters.
41       * 
42       * @return Collection returned from the search
43       */
44      public <T extends Object> Collection<T> findCollectionBySearch(Class<T> example, Map<String, String> formProps);
45  
46      public <T extends Object> Collection<T> findCollectionBySearchHelper(Class<T> example,
47              Map<String, String> formProperties, boolean unbounded);
48  
49      /**
50       * Retrieves a Object based on the search criteria, which should uniquely
51       * identify a record.
52       * 
53       * @return Object returned from the search
54       */
55      public <T extends Object> T findObjectBySearch(Class<T> example, Map<String, String> formProps);
56  
57      public boolean allPrimaryKeyValuesPresentAndNotWildcard(Class<?> boClass, Map<String, String> formProps);
58  }