View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.common.ui.client.service;
17  
18  import java.util.List;
19  
20  import org.kuali.student.core.dictionary.old.dto.ObjectStructure;
21  import org.kuali.student.core.search.dto.SearchCriteriaTypeInfo;
22  import org.kuali.student.core.search.dto.SearchRequest;
23  import org.kuali.student.core.search.dto.SearchResult;
24  import org.kuali.student.core.search.dto.SearchResultTypeInfo;
25  import org.kuali.student.core.search.dto.SearchTypeInfo;
26  
27  import com.google.gwt.user.client.rpc.RemoteService;
28  
29  /**
30   *  A base RPC service interface that exposes dictionary and search interfaces
31   *  of a service endpoint interface SEI
32   * 
33   * @author Kuali Student Team
34   *
35   */
36  public interface BaseRpcService extends RemoteService{
37  
38      /* Dictionary Operations */
39      
40      public List<String> getObjectTypes();
41  
42      public ObjectStructure getObjectStructure(String objectTypeKey);    
43      
44      /* Search Operations */
45      public List<SearchTypeInfo> getSearchTypes();
46  
47      public SearchTypeInfo getSearchType(String searchTypeKey);
48  
49      public List<SearchTypeInfo> getSearchTypesByResult(String searchResultTypeKey);
50  
51      public List<SearchTypeInfo> getSearchTypesByCriteria(String searchCriteriaTypeKey);
52  
53      public List<SearchResultTypeInfo> getSearchResultTypes();
54  
55      public SearchResultTypeInfo getSearchResultType(String searchResultTypeKey);
56  
57      public List<SearchCriteriaTypeInfo> getSearchCriteriaTypes();
58  
59      public SearchCriteriaTypeInfo getSearchCriteriaType(String searchCriteriaTypeKey);
60  
61      public SearchResult search(SearchRequest searchRequest);
62  
63  }