001: /*
002: * Copyright 2005-2007 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.opensource.org/licenses/ecl1.php
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016: package org.kuali.core.web.struts.form;
017:
018: import org.kuali.core.datadictionary.HelpDefinition;
019:
020: /**
021: * Holds help parameters and found text.
022: *
023: *
024: */
025: public class KualiHelpForm extends KualiForm {
026: private static final long serialVersionUID = 1L;
027: private String businessObjectClassName;
028: private String attributeName;
029: private String helpLabel;
030: private String helpSummary;
031: private String helpDescription;
032: private String resourceKey;
033: private String documentTypeName;
034: private String helpDataType;
035: private String helpRequired;
036: private String helpMaxLength;
037: private String helpVPatName;
038: private HelpDefinition helpDefinition;
039: private String helpParameterNamespace;
040: private String helpParameterDetailType;
041: private String helpParameterName;
042: private String pageName;
043:
044: /**
045: * @return Returns the attributeName.
046: */
047: public String getAttributeName() {
048: return attributeName;
049: }
050:
051: /**
052: * @param attributeName The attributeName to set.
053: */
054: public void setAttributeName(String attributeName) {
055: this .attributeName = attributeName;
056: }
057:
058: /**
059: * @return Returns the businessObjectClassName.
060: */
061: public String getBusinessObjectClassName() {
062: return businessObjectClassName;
063: }
064:
065: /**
066: * @param businessObjectClassName The businessObjectClassName to set.
067: */
068: public void setBusinessObjectClassName(
069: String businessObjectClassName) {
070: this .businessObjectClassName = businessObjectClassName;
071: }
072:
073: /**
074: * @return Returns the helpDescription.
075: */
076: public String getHelpDescription() {
077: return helpDescription;
078: }
079:
080: /**
081: * @param helpDescription The helpDescription to set.
082: */
083: public void setHelpDescription(String helpDescription) {
084: this .helpDescription = helpDescription;
085: }
086:
087: /**
088: * @return Returns the helpLabel.
089: */
090: public String getHelpLabel() {
091: return helpLabel;
092: }
093:
094: /**
095: * @param helpLabel The helpLabel to set.
096: */
097: public void setHelpLabel(String helpLabel) {
098: this .helpLabel = helpLabel;
099: }
100:
101: /**
102: * @return Returns the helpSummary.
103: */
104: public String getHelpSummary() {
105: return helpSummary;
106: }
107:
108: /**
109: * @param helpSummary The helpSummary to set.
110: */
111: public void setHelpSummary(String helpSummary) {
112: this .helpSummary = helpSummary;
113: }
114:
115: /**
116: * @return Returns the resourceKey.
117: */
118: public String getResourceKey() {
119: return resourceKey;
120: }
121:
122: /**
123: * @param resourceKey The resourceKey to set.
124: */
125: public void setResourceKey(String resourceKey) {
126: this .resourceKey = resourceKey;
127: }
128:
129: /**
130: * @return Returns the documentTypeName.
131: */
132: public String getDocumentTypeName() {
133: return documentTypeName;
134: }
135:
136: /**
137: * @param documentTypeName The documentTypeName to set.
138: */
139: public void setDocumentTypeName(String documentTypeName) {
140: this .documentTypeName = documentTypeName;
141: }
142:
143: /**
144: * Form field accessor for Required
145: *
146: * @param r
147: */
148: public void setHelpRequired(String r) {
149: helpRequired = r;
150: }
151:
152: /**
153: * Form field accessor for Required
154: *
155: * @return String
156: */
157: public String getHelpRequired() {
158: return helpRequired;
159: }
160:
161: /**
162: * Form field accessor for DataType
163: *
164: * @param s
165: */
166: public void setHelpDataType(String s) {
167: helpDataType = s;
168: }
169:
170: /**
171: * Form field accessor for DataType
172: *
173: * @return String
174: */
175: public String getHelpDataType() {
176: return helpDataType;
177: }
178:
179: /**
180: * Form field accessor for Maximum Length
181: *
182: * @param m
183: */
184: public void setHelpMaxLength(String m) {
185: helpMaxLength = m;
186: }
187:
188: /**
189: * Form field accessor for Maximum Length
190: *
191: * @return String
192: */
193: public String getHelpMaxLength() {
194: return helpMaxLength;
195: }
196:
197: /**
198: * Form field accessor for name of Validation Pattern
199: *
200: * @param v
201: */
202: public void setValidationPatternName(String v) {
203: helpVPatName = v;
204: }
205:
206: /**
207: * Form field accessor for name of Validation Pattern
208: *
209: * @return String
210: */
211: public String getValidationPatternName() {
212: return helpVPatName;
213: }
214:
215: /**
216: * Form field accessor for financial system parameter help.
217: *
218: * @return HelpDefinition
219: */
220: public HelpDefinition getHelpDefinition() {
221: return helpDefinition;
222: }
223:
224: /**
225: * Form field accessor for financial system parameter help.
226: *
227: * @param helpDefinition
228: */
229: public void setHelpDefinition(HelpDefinition helpDefinition) {
230: this .helpDefinition = helpDefinition;
231: }
232:
233: public String getHelpParameterName() {
234: return helpParameterName;
235: }
236:
237: public void setHelpParameterName(String helpParameterName) {
238: this .helpParameterName = helpParameterName;
239: }
240:
241: public String getHelpParameterNamespace() {
242: return helpParameterNamespace;
243: }
244:
245: public void setHelpParameterNamespace(String helpSecurityGroupName) {
246: this .helpParameterNamespace = helpSecurityGroupName;
247: }
248:
249: public String getPageName() {
250: return pageName;
251: }
252:
253: public void setPageName(String pageName) {
254: this .pageName = pageName;
255: }
256:
257: public String getHelpParameterDetailType() {
258: return this .helpParameterDetailType;
259: }
260:
261: public void setHelpParameterDetailType(
262: String helpParameterDetailType) {
263: this.helpParameterDetailType = helpParameterDetailType;
264: }
265: }
|