| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AdminDao |
|
| 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.dao; | |
| 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 actions on a data store for administrative tasks | |
| 25 | * @author Kuali Mobility Team (moblitiy.collab@kuali.org) | |
| 26 | */ | |
| 27 | public interface AdminDao { | |
| 28 | /** | |
| 29 | * @return all defined home screens | |
| 30 | */ | |
| 31 | public List<HomeScreen> getAllHomeScreens(); | |
| 32 | /** | |
| 33 | * @param homeScreenId the id of the home screen to retrieve | |
| 34 | * @return the HomeScreen object matching the id | |
| 35 | */ | |
| 36 | public HomeScreen getHomeScreenById(long homeScreenId); | |
| 37 | /** | |
| 38 | * @param alias the alias of the home screen | |
| 39 | * @return the HomeScreen object matching the alias | |
| 40 | */ | |
| 41 | public HomeScreen getHomeScreenByAlias(String alias); | |
| 42 | /** | |
| 43 | * @param homeScreen the HomeScreen to save | |
| 44 | * @return the id of the home screen | |
| 45 | */ | |
| 46 | public Long saveHomeScreen(HomeScreen homeScreen); | |
| 47 | /** | |
| 48 | * @param homeScreenId the id of the home screen to delete | |
| 49 | */ | |
| 50 | public void deleteHomeScreenById(long homeScreenId); | |
| 51 | ||
| 52 | /** | |
| 53 | * @return all defined Tools | |
| 54 | */ | |
| 55 | public List<Tool> getAllTools(); | |
| 56 | /** | |
| 57 | * @param tool the Tool to save | |
| 58 | * @return the id of the saved Tool | |
| 59 | */ | |
| 60 | public Long saveTool(Tool tool); | |
| 61 | /** | |
| 62 | * @param toolId the id of the tool to retrieve | |
| 63 | * @return the Tool object matching the id | |
| 64 | */ | |
| 65 | public Tool getToolById(long toolId); | |
| 66 | /** | |
| 67 | * @param toolId the id of the tool to delete | |
| 68 | */ | |
| 69 | public void deleteToolById(Long toolId); | |
| 70 | ||
| 71 | } |