1 /**
2 * Copyright 2011-2013 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.mobility.admin.service;
17
18 import java.util.List;
19 import javax.jws.WebService;
20
21 import org.kuali.mobility.admin.entity.HomeScreen;
22 import org.kuali.mobility.admin.entity.Tool;
23
24 /**
25 * Interface for a contract for administrative tasks
26 * @author Kuali Mobility Team (mobility.dev@kuali.org)
27 */
28 @WebService
29 public interface AdminService {
30
31 /**
32 * @return all defined home screens
33 */
34 public List<HomeScreen> getAllHomeScreens();
35 /**
36 * @param layoutId the id of the home screen to retrieve
37 * @return the home screen matching the id
38 */
39 public HomeScreen getHomeScreenById(long layoutId);
40 /**
41 * @param alias the alias of the home screen to retrieve
42 * @return the home screen matching the alias
43 */
44 public HomeScreen getHomeScreenByAlias(String alias);
45 /**
46 * @param homeScreen the HomeScreen to save
47 * @return the id of the saved HomeScreen
48 */
49 public Long saveHomeScreen(HomeScreen homeScreen);
50 /**
51 * @param layoutId the id of the HomeScreen to delete
52 */
53 public void deleteHomeScreenById(long layoutId);
54
55 /**
56 * @return all defined Tool objects
57 */
58 public List<Tool> getAllTools();
59 /**
60 * @param tool the Tool to save
61 * @return the id of the saved Tool
62 */
63 public Long saveTool(Tool tool);
64 /**
65 * @param toolId the id of the tool to retrieve
66 * @return the Tool matching the id
67 */
68 public Tool getToolById(long toolId);
69 /**
70 * @param toolId the id of the Tool to delete
71 */
72 public void deleteToolById(long toolId);
73
74 }