| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AdminService |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2011 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 | ||
| 20 | import org.kuali.mobility.admin.entity.HomeScreen; | |
| 21 | import org.kuali.mobility.admin.entity.Tool; | |
| 22 | ||
| 23 | /** | |
| 24 | * Interface for a contract for administrative tasks | |
| 25 | * @author Kuali Mobility Team (moblitiy.collab@kuali.org) | |
| 26 | */ | |
| 27 | public interface AdminService { | |
| 28 | ||
| 29 | /** | |
| 30 | * @param alias | |
| 31 | * @return the home screen matching the alias from cache | |
| 32 | */ | |
| 33 | public HomeScreen getCachedHomeScreenByAlias(String alias); | |
| 34 | ||
| 35 | /** | |
| 36 | * @return all defined home screens | |
| 37 | */ | |
| 38 | public List<HomeScreen> getAllHomeScreens(); | |
| 39 | /** | |
| 40 | * @param layoutId the id of the home screen to retrieve | |
| 41 | * @return the home screen matching the id | |
| 42 | */ | |
| 43 | public HomeScreen getHomeScreenById(long layoutId); | |
| 44 | /** | |
| 45 | * @param alias the alias of the home screen to retrieve | |
| 46 | * @return the home screen matching the alias | |
| 47 | */ | |
| 48 | public HomeScreen getHomeScreenByAlias(String alias); | |
| 49 | /** | |
| 50 | * @param homeScreen the HomeScreen to save | |
| 51 | * @return the id of the saved HomeScreen | |
| 52 | */ | |
| 53 | public Long saveHomeScreen(HomeScreen homeScreen); | |
| 54 | /** | |
| 55 | * @param layoutId the id of the HomeScreen to delete | |
| 56 | */ | |
| 57 | public void deleteHomeScreenById(long layoutId); | |
| 58 | ||
| 59 | /** | |
| 60 | * @return all defined Tool objects | |
| 61 | */ | |
| 62 | public List<Tool> getAllTools(); | |
| 63 | /** | |
| 64 | * @param tool the Tool to save | |
| 65 | * @return the id of the saved Tool | |
| 66 | */ | |
| 67 | public Long saveTool(Tool tool); | |
| 68 | /** | |
| 69 | * @param toolId the id of the tool to retrieve | |
| 70 | * @return the Tool matching the id | |
| 71 | */ | |
| 72 | public Tool getToolById(long toolId); | |
| 73 | /** | |
| 74 | * @param toolId the id of the Tool to delete | |
| 75 | */ | |
| 76 | public void deleteToolById(long toolId); | |
| 77 | ||
| 78 | /** | |
| 79 | * Start the cache for HomeScreen and Tool objects | |
| 80 | */ | |
| 81 | public void stopCache(); | |
| 82 | /** | |
| 83 | * Stop the cache for HomeScreen and Tool objects | |
| 84 | */ | |
| 85 | public void startCache(); | |
| 86 | } |