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 org.kuali.rice.krad.data.metadata.SortDirection;
019
020/**
021 * Defines an attribute on which to sort a collection.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public @interface CollectionSortAttribute {
026
027    /**
028     * Gets the attribute name to sort on.
029     *
030     * @return the attribute name to sort on.
031     */
032        String value();
033
034    /**
035     * Gets the direction which to sort.
036     *
037     * @return the direction which to sort.
038     */
039        SortDirection sortDirection() default SortDirection.ASCENDING;
040}