Coverage Report

Coverage Report - org.kuali.rice.kns.datadictionary.InquiryDefinition

Classes in this File

Line Coverage

Branch Coverage

Complexity

InquiryDefinition

0/37

0/14

1.588

 /**
  * Copyright 2005-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kns.datadictionary;
 
 import org.apache.commons.lang.StringUtils;
 import org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase;
 import org.kuali.rice.krad.inquiry.Inquirable;
 import org.kuali.rice.krad.inquiry.InquiryAuthorizer;
 import org.kuali.rice.krad.inquiry.InquiryPresentationController;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
     The inquiry element is used to specify the fields that will be displayed on the
     inquiry screen for this business object and the order in which they will appear.
 
     JSTL: The inquiry element is a Map which is accessed using
     a key of "inquiry".  This map contains the following keys:
         * title (String)
         * inquiryFields (Map)
  */
 @Deprecated
 public class InquiryDefinition extends DataDictionaryDefinitionBase {
     private static final long serialVersionUID = -2506403061297774668L;
     
         protected String title;
     protected List<InquirySectionDefinition> inquirySections = new ArrayList<InquirySectionDefinition>();
     protected Class<? extends Inquirable> inquirableClass;
     protected Class<? extends InquiryPresentationController> presentationControllerClass;
     protected Class<? extends InquiryAuthorizer> authorizerClass;
     
     protected boolean translateCodes = true;
 
     public InquiryDefinition() {
     }
 
 
     public String getTitle() {
         return title;
     }
 
     /**
                The title element is used specify the title that will appear in the header
                 of an Inquiry or Lookup screen.
      * @throws IllegalArgumentException if the given title is blank
      */
     public void setTitle(String title) {
         if (StringUtils.isBlank(title)) {
             throw new IllegalArgumentException("invalid (blank) title");
         }
 
         this.title = title;
     }
 
     /**
      * @return Collection of all inquiryField FieldDefinitions associated with this InquiryDefinition, in the order in which they
      *         were added
      */
     public List<InquirySectionDefinition> getInquirySections() {
         return inquirySections;
     }
    
     /**
      * Returns the FieldDefinition associated with the field attribute name
      * @param fieldName
      * @return
      */
     public FieldDefinition getFieldDefinition(String fieldName) {
         for (InquirySectionDefinition section : inquirySections ) {
             for (FieldDefinition field : section.getInquiryFields() ) {
                 if (field.getAttributeName().equals(fieldName)) {
                     return field;
                 }
             }
         }
         
         return null;
     }
 
     /**
      * Directly validate simple fields, call completeValidation on Definition fields.
      * 
      * @see org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)
      */
     public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
         for ( InquirySectionDefinition inquirySection : inquirySections ) {
             inquirySection.completeValidation(rootBusinessObjectClass, null);
         }
     }
 
     public InquirySectionDefinition getInquirySection( String sectionTitle ) {
         for ( InquirySectionDefinition inquirySection : inquirySections ) {
             if ( inquirySection.getTitle().equals(sectionTitle) ) {
                 return inquirySection;
             }
         }
         return null;
     }
     
     
     /**
      * @see java.lang.Object#toString()
      */
     public String toString() {
         return "InquiryDefinition '" + getTitle() + "'";
     }
 
 
     public Class<? extends Inquirable> getInquirableClass() {
         return inquirableClass;
     }
 
     /**
 
             inquirableClass is required if a custom inquirable is required which will show
             additional data other than the business object attributes.
 
             Example from Org.xml:
                 <inquirableClass>org.kuali.module.chart.maintenance.OrgInquirable</inquirableClass>
             The custom inquirable is required in this case because the organization hierarchy
             is shown on the inquiry screen.
      */
     public void setInquirableClass(Class<? extends Inquirable> inquirableClass) {
         this.inquirableClass = inquirableClass;
     }
 
     /**
      *                 inquirySections allows inquiry to be presented in sections.
                 Each section can have a different format.
      */
     public void setInquirySections(List<InquirySectionDefinition> inquirySections) {
         this.inquirySections = inquirySections;
     }
 
 
         public Class<? extends InquiryPresentationController> getPresentationControllerClass() {
                 return this.presentationControllerClass;
         }
 
 
         public void setPresentationControllerClass(
                         Class<? extends InquiryPresentationController> presentationControllerClass) {
                 this.presentationControllerClass = presentationControllerClass;
         }
 
 
         public Class<? extends InquiryAuthorizer> getAuthorizerClass() {
                 return this.authorizerClass;
         }
 
 
         public void setAuthorizerClass(
                         Class<? extends InquiryAuthorizer> authorizerClass) {
                 this.authorizerClass = authorizerClass;
         }
 
 
         public boolean isTranslateCodes() {
                 return this.translateCodes;
         }
 
 
         public void setTranslateCodes(boolean translateCodes) {
                 this.translateCodes = translateCodes;
         }
         
 }

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.kns.datadictionary;
17
18		import org.apache.commons.lang.StringUtils;
19		import org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase;
20		import org.kuali.rice.krad.inquiry.Inquirable;
21		import org.kuali.rice.krad.inquiry.InquiryAuthorizer;
22		import org.kuali.rice.krad.inquiry.InquiryPresentationController;
23
24		import java.util.ArrayList;
25		import java.util.List;
26
27		/**
28		The inquiry element is used to specify the fields that will be displayed on the
29		inquiry screen for this business object and the order in which they will appear.
30
31		JSTL: The inquiry element is a Map which is accessed using
32		a key of "inquiry". This map contains the following keys:
33		* title (String)
34		* inquiryFields (Map)
35		*/
36		@Deprecated
37		public class InquiryDefinition extends DataDictionaryDefinitionBase {
38		private static final long serialVersionUID = -2506403061297774668L;
39
40		protected String title;
41	0	protected List<InquirySectionDefinition> inquirySections = new ArrayList<InquirySectionDefinition>();
42		protected Class<? extends Inquirable> inquirableClass;
43		protected Class<? extends InquiryPresentationController> presentationControllerClass;
44		protected Class<? extends InquiryAuthorizer> authorizerClass;
45
46	0	protected boolean translateCodes = true;
47
48	0	public InquiryDefinition() {
49	0	}
50
51
52		public String getTitle() {
53	0	return title;
54		}
55
56		/**
57		The title element is used specify the title that will appear in the header
58		of an Inquiry or Lookup screen.
59		* @throws IllegalArgumentException if the given title is blank
60		*/
61		public void setTitle(String title) {
62	0	if (StringUtils.isBlank(title)) {
63	0	throw new IllegalArgumentException("invalid (blank) title");
64		}
65
66	0	this.title = title;
67	0	}
68
69		/**
70		* @return Collection of all inquiryField FieldDefinitions associated with this InquiryDefinition, in the order in which they
71		* were added
72		*/
73		public List<InquirySectionDefinition> getInquirySections() {
74	0	return inquirySections;
75		}
76
77		/**
78		* Returns the FieldDefinition associated with the field attribute name
79		* @param fieldName
80		* @return
81		*/
82		public FieldDefinition getFieldDefinition(String fieldName) {
83	0	for (InquirySectionDefinition section : inquirySections ) {
84	0	for (FieldDefinition field : section.getInquiryFields() ) {
85	0	if (field.getAttributeName().equals(fieldName)) {
86	0	return field;
87		}
88		}
89		}
90
91	0	return null;
92		}
93
94		/**
95		* Directly validate simple fields, call completeValidation on Definition fields.
96		*
97		* @see org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)
98		*/
99		public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
100	0	for ( InquirySectionDefinition inquirySection : inquirySections ) {
101	0	inquirySection.completeValidation(rootBusinessObjectClass, null);
102		}
103	0	}
104
105		public InquirySectionDefinition getInquirySection( String sectionTitle ) {
106	0	for ( InquirySectionDefinition inquirySection : inquirySections ) {
107	0	if ( inquirySection.getTitle().equals(sectionTitle) ) {
108	0	return inquirySection;
109		}
110		}
111	0	return null;
112		}
113
114
115		/**
116		* @see java.lang.Object#toString()
117		*/
118		public String toString() {
119	0	return "InquiryDefinition '" + getTitle() + "'";
120		}
121
122
123		public Class<? extends Inquirable> getInquirableClass() {
124	0	return inquirableClass;
125		}
126
127		/**
128
129		inquirableClass is required if a custom inquirable is required which will show
130		additional data other than the business object attributes.
131
132		Example from Org.xml:
133		<inquirableClass>org.kuali.module.chart.maintenance.OrgInquirable</inquirableClass>
134		The custom inquirable is required in this case because the organization hierarchy
135		is shown on the inquiry screen.
136		*/
137		public void setInquirableClass(Class<? extends Inquirable> inquirableClass) {
138	0	this.inquirableClass = inquirableClass;
139	0	}
140
141		/**
142		* inquirySections allows inquiry to be presented in sections.
143		Each section can have a different format.
144		*/
145		public void setInquirySections(List<InquirySectionDefinition> inquirySections) {
146	0	this.inquirySections = inquirySections;
147	0	}
148
149
150		public Class<? extends InquiryPresentationController> getPresentationControllerClass() {
151	0	return this.presentationControllerClass;
152		}
153
154
155		public void setPresentationControllerClass(
156		Class<? extends InquiryPresentationController> presentationControllerClass) {
157	0	this.presentationControllerClass = presentationControllerClass;
158	0	}
159
160
161		public Class<? extends InquiryAuthorizer> getAuthorizerClass() {
162	0	return this.authorizerClass;
163		}
164
165
166		public void setAuthorizerClass(
167		Class<? extends InquiryAuthorizer> authorizerClass) {
168	0	this.authorizerClass = authorizerClass;
169	0	}
170
171
172		public boolean isTranslateCodes() {
173	0	return this.translateCodes;
174		}
175
176
177		public void setTranslateCodes(boolean translateCodes) {
178	0	this.translateCodes = translateCodes;
179	0	}
180
181		}