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.uif.util;
017
018import org.kuali.rice.krad.uif.component.ListAware;
019import org.kuali.rice.krad.uif.element.Header;
020
021import java.io.Serializable;
022
023/**
024 * Collection of helper methods that can be exposed to a render engine.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public class UifRenderHelperMethods implements Serializable {
029    private static final long serialVersionUID = 5105182075655826814L;
030
031    /**
032     * Indicates whether the given class is a {@link org.kuali.rice.krad.uif.element.Header}
033     * component class.
034     *
035     * @param componentClass class to check
036     * @return boolean true if class is a header class, false if not
037     */
038    public boolean isHeader(Class<?> componentClass) {
039        return Header.class.isAssignableFrom(componentClass);
040    }
041
042    /**
043     * Indicates whether the given class is a {org.kuali.rice.krad.uif.component.ListAware}
044     * component class.
045     *
046     * @param componentClass class to check
047     * @return boolean true if class is a list aware class, false if not
048     */
049    public boolean isListAware(Class<?> componentClass) {
050        return ListAware.class.isAssignableFrom(componentClass);
051    }
052}