1 /**
2 * Copyright 2005-2011 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.opensource.org/licenses/ecl2.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.krad.uif.service;
17
18 import org.kuali.rice.krad.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 - class for the inquiry data object
36 * @param viewName - name of the inquiry view, can be blank in which case the
37 * 'default' name will be used
38 * @return Inquirable<?> configured inquirable for the view, or null if view
39 * is not found
40 */
41 public Inquirable getInquirable(Class<?> dataObjectClass, String viewName);
42
43 /**
44 * Indicates whether the given data object class has an associated
45 * <code>InquiryView</code> configured and thus can have inquiry links built
46 *
47 * @param dataObjectClass - object class to get inquiry view for
48 * @return boolean true if the class has an inquiry view, false if no
49 * inquiry view exists for the class
50 */
51 public boolean isInquirable(Class<?> dataObjectClass);
52
53 /**
54 * Indicates whether the given data object class has an associated
55 * <code>LookupView</code> configured and thus can have quickfinders
56 * associated with the class
57 *
58 * @param dataObjectClass - object class to get lookup view for
59 * @return boolean true if the class has an lookup view, false if no lookup
60 * view exists for the class
61 */
62 public boolean isLookupable(Class<?> dataObjectClass);
63
64 /**
65 * Indicates whether the given data object class has an associated
66 * <code>MaintenanceView</code> configured
67 *
68 * @param dataObjectClass - object class to get maintenance view for
69 * @return boolean true if the class has an maintenance view, false if no
70 * maintenance view exists for the class
71 */
72 public boolean isMaintainable(Class<?> dataObjectClass);
73
74 /**
75 * Attempts to find an associated <code>LookupView</code> for the
76 * given data object class and if found returns the configured result
77 * set limit, if multiple lookup views are found the default is used
78 *
79 * @param dataObjectClass - object class to get lookup view for
80 * @return Integer configured result set limit for lookup, or null if not found (note
81 * property could also be null on the view itself)
82 */
83 public Integer getResultSetLimitForLookup(Class<?> dataObjectClass);
84 }