001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.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/ecl2.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 */
016package org.kuali.rice.krad.datadictionary;
017
018import org.kuali.rice.krad.datadictionary.parse.BeanTag;
019import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
020
021/**
022 * This is a description of what this class does - mpham don't forget to fill this in.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026@BeanTag(name = "searchingAttribute")
027public class SearchingAttribute extends WorkflowAttributeMetadata {
028    private static final long serialVersionUID = -612461988789474893L;
029
030    private String businessObjectClassName;
031    private String attributeName;
032    private boolean showAttributeInSearchCriteria = true;
033    private boolean showAttributeInResultSet = false;
034
035    /**
036     * @return the businessObjectClassName
037     */
038    @BeanTagAttribute(name = "businessObjectClassName")
039    public String getBusinessObjectClassName() {
040        return this.businessObjectClassName;
041    }
042
043    /**
044     * @return the attributeName
045     */
046    @BeanTagAttribute(name = "attributeName")
047    public String getAttributeName() {
048        return this.attributeName;
049    }
050
051    /**
052     * @param businessObjectClassName the businessObjectClassName to set
053     */
054    public void setBusinessObjectClassName(String businessObjectClassName) {
055        this.businessObjectClassName = businessObjectClassName;
056    }
057
058    /**
059     * @param attributeName the attributeName to set
060     */
061    public void setAttributeName(String attributeName) {
062        this.attributeName = attributeName;
063    }
064
065    /**
066     * Returns whether this attribute should appear in the search criteria
067     *
068     * @return the showAttributeInSearchCriteria
069     */
070    @BeanTagAttribute(name = "showAttriubteInSearchCriteria")
071    public boolean isShowAttributeInSearchCriteria() {
072        return this.showAttributeInSearchCriteria;
073    }
074
075    /**
076     * Sets whether this attribute should appear in the search criteria
077     *
078     * @param showAttributeInSearchCriteria the showAttributeInSearchCriteria to set
079     */
080    public void setShowAttributeInSearchCriteria(boolean showAttributeInSearchCriteria) {
081        this.showAttributeInSearchCriteria = showAttributeInSearchCriteria;
082    }
083
084    /**
085     * Returns whether this attribute should appear in the result set
086     *
087     * @return the showAttributeInResultSet
088     */
089    @BeanTagAttribute(name = "ShowAttributeInResultSet")
090    public boolean isShowAttributeInResultSet() {
091        return this.showAttributeInResultSet;
092    }
093
094    /**
095     * Sets whether this attribute should appear in the result set
096     *
097     * @param showAttributeInResultSet the showAttributeInResultSet to set
098     */
099    public void setShowAttributeInResultSet(boolean showAttributeInResultSet) {
100        this.showAttributeInResultSet = showAttributeInResultSet;
101    }
102}