View Javadoc

1   /*
2    * Copyright 2010 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.osedu.org/licenses/ECL-2.0
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.student.contract.model;
17  
18  import java.util.List;
19  
20  /**
21   * Abstration of the spreadsheet that holds the data so we can implement both
22   * google and excel versions as well as caching and expanding ones.
23   * @author nwright
24   */
25  public interface ServiceContractModel {
26  
27      public List<String> getSourceNames();
28  
29      /**
30       * get the service definitions
31       * @return list of services known to the metadata
32       */
33      public List<Service> getServices();
34  
35      /**
36       * Get service methods
37       * @return
38       */
39      public List<ServiceMethod> getServiceMethods();
40  
41      /**
42       * load xml types
43       * @return
44       */
45      public List<XmlType> getXmlTypes();
46  
47      /**
48       * Get Message Structure Definitions
49       * @return
50       */
51      public List<MessageStructure> getMessageStructures();
52  
53      /**
54       * Gets the structure of this object as a String.
55       */
56      public String toString ();
57  }