001/**
002 * Copyright 2005-2016 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.data.provider.annotation;
017
018import com.google.common.annotations.Beta;
019
020/**
021 * BETA: Defines the type of the {@link UifDisplayHint}.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025@Beta
026public enum UifDisplayHintType {
027        /**
028         * Does nothing. Just a placeholder so defaults can be defined.
029         */
030        NONE,
031        /**
032         * Tells the defaulter to hide this field and not generate an input field for it.
033         */
034        HIDDEN,
035        /**
036         * Tells the defaulter to exclude this field and not generate an attribute definition at all.
037         */
038        EXCLUDE,
039        /**
040         * If a values finder is present for the field, generate as a Drop-down list.
041         */
042        DROPDOWN,
043        /**
044         * If a values finder is present for the field, generate as a set of radio buttons.
045         */
046        RADIO,
047        /**
048         * Indicates that this hint tells that the attribute should be put in a specific section.
049         */
050        SECTION,
051        /**
052         * Don't include this attribute in the inquiry page.
053         */
054        NO_INQUIRY,
055        /**
056         * Don't include this attribute in the lookup criteria.
057         */
058        NO_LOOKUP_CRITERIA,
059        /**
060         * Don't include this attribute in the lookup results.
061         */
062        NO_LOOKUP_RESULT;
063}