View Javadoc

1   /**
2    * Copyright 2005-2014 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.datadictionary;
17  
18  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
19  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
20  
21  /**
22   * This is a description of what this class does - mpham don't forget to fill this in.
23   *
24   * @author Kuali Rice Team (rice.collab@kuali.org)
25   */
26  @BeanTag(name = "searchingAttribute-bean")
27  public class SearchingAttribute extends WorkflowAttributeMetadata {
28      private static final long serialVersionUID = -612461988789474893L;
29  
30      private String businessObjectClassName;
31      private String attributeName;
32      private boolean showAttributeInSearchCriteria = true;
33      private boolean showAttributeInResultSet = false;
34  
35      /**
36       * @return the businessObjectClassName
37       */
38      @BeanTagAttribute(name = "businessObjectClassName")
39      public String getBusinessObjectClassName() {
40          return this.businessObjectClassName;
41      }
42  
43      /**
44       * @return the attributeName
45       */
46      @BeanTagAttribute(name = "attributeName")
47      public String getAttributeName() {
48          return this.attributeName;
49      }
50  
51      /**
52       * @param businessObjectClassName the businessObjectClassName to set
53       */
54      public void setBusinessObjectClassName(String businessObjectClassName) {
55          this.businessObjectClassName = businessObjectClassName;
56      }
57  
58      /**
59       * @param attributeName the attributeName to set
60       */
61      public void setAttributeName(String attributeName) {
62          this.attributeName = attributeName;
63      }
64  
65      /**
66       * Returns whether this attribute should appear in the search criteria
67       *
68       * @return the showAttributeInSearchCriteria
69       */
70      @BeanTagAttribute(name = "showAttriubteInSearchCriteria")
71      public boolean isShowAttributeInSearchCriteria() {
72          return this.showAttributeInSearchCriteria;
73      }
74  
75      /**
76       * Sets whether this attribute should appear in the search criteria
77       *
78       * @param showAttributeInSearchCriteria the showAttributeInSearchCriteria to set
79       */
80      public void setShowAttributeInSearchCriteria(boolean showAttributeInSearchCriteria) {
81          this.showAttributeInSearchCriteria = showAttributeInSearchCriteria;
82      }
83  
84      /**
85       * Returns whether this attribute should appear in the result set
86       *
87       * @return the showAttributeInResultSet
88       */
89      @BeanTagAttribute(name = "ShowAttributeInResultSet")
90      public boolean isShowAttributeInResultSet() {
91          return this.showAttributeInResultSet;
92      }
93  
94      /**
95       * Sets whether this attribute should appear in the result set
96       *
97       * @param showAttributeInResultSet the showAttributeInResultSet to set
98       */
99      public void setShowAttributeInResultSet(boolean showAttributeInResultSet) {
100         this.showAttributeInResultSet = showAttributeInResultSet;
101     }
102 }