| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ViewDictionaryService |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2011 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php | |
| 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.rice.kns.uif.service; | |
| 17 | ||
| 18 | import org.kuali.rice.kns.inquiry.Inquirable; | |
| 19 | ||
| 20 | /** | |
| 21 | * Provides methods to query the dictionary meta-data for view entries and their | |
| 22 | * corresponding component entries | |
| 23 | * | |
| 24 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 25 | */ | |
| 26 | public interface ViewDictionaryService { | |
| 27 | ||
| 28 | /** | |
| 29 | * Queries the dictionary to find the <code>InquiryView</code> configured | |
| 30 | * for the data object class and returns the configured Inquirable for the | |
| 31 | * view. If more than one inquiry view exists for the data object class, the | |
| 32 | * one that matches the given viewName, or the default if viewName is blank | |
| 33 | * is used | |
| 34 | * | |
| 35 | * @param dataObjectClass | |
| 36 | * - class for the inquiry data object | |
| 37 | * @param viewName | |
| 38 | * - name of the inquiry view, can be blank in which case the | |
| 39 | * 'default' name will be used | |
| 40 | * @return Inquirable<?> configured inquirable for the view, or null if view | |
| 41 | * is not found | |
| 42 | */ | |
| 43 | public Inquirable getInquirable(Class<?> dataObjectClass, String viewName); | |
| 44 | ||
| 45 | /** | |
| 46 | * Indicates whether the given data object class has an associated | |
| 47 | * <code>InquiryView</code> configured and thus can have inquiry links built | |
| 48 | * | |
| 49 | * @param dataObjectClass | |
| 50 | * - object class to get inquiry view for | |
| 51 | * @return boolean true if the class has an inquiry view, false if no | |
| 52 | * inquiry view exists for the class | |
| 53 | */ | |
| 54 | public boolean isInquirable(Class<?> dataObjectClass); | |
| 55 | ||
| 56 | /** | |
| 57 | * Indicates whether the given data object class has an associated | |
| 58 | * <code>LookupView</code> configured and thus can have quickfinders | |
| 59 | * associated with the class | |
| 60 | * | |
| 61 | * @param dataObjectClass | |
| 62 | * - object class to get lookup view for | |
| 63 | * @return boolean true if the class has an lookup view, false if no lookup | |
| 64 | * view exists for the class | |
| 65 | */ | |
| 66 | public boolean isLookupable(Class<?> dataObjectClass); | |
| 67 | ||
| 68 | /** | |
| 69 | * Indicates whether the given data object class has an associated | |
| 70 | * <code>MaintenanceView</code> configured | |
| 71 | * | |
| 72 | * @param dataObjectClass | |
| 73 | * - object class to get maintenance view for | |
| 74 | * @return boolean true if the class has an maintenance view, false if no | |
| 75 | * maintenance view exists for the class | |
| 76 | */ | |
| 77 | public boolean isMaintainable(Class<?> dataObjectClass); | |
| 78 | ||
| 79 | } |