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.metadata;
017
018import java.io.Serializable;
019
020/**
021* Represents a single field on which to sort a {@link DataObjectCollection} within a {@link DataObjectMetadata}.
022*
023* <p>
024* The collection may hold multiple of these objects to support sorting by multiple fields.
025* </p>
026*
027* @author Kuali Rice Team (rice.collab@kuali.org)
028*/
029public interface DataObjectCollectionSortAttribute extends Serializable {
030
031    /**
032    * Gets attribute name.
033    *
034    * <p>
035    * The attribute name on which to sort the collection.
036    * </p>
037    *
038    * @return attribute name
039    */
040        String getAttributeName();
041
042    /**
043    * Gets the attribute sort.
044    *
045    * <p>
046    * For this attribute, which way should we sort?.
047    * </p>
048    *
049    * @return attribute sort
050    */
051        SortDirection getSortDirection();
052
053}