1 /**
2 * Copyright 2005-2016 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.data.metadata;
17
18 import java.io.Serializable;
19
20 /**
21 * Represents a single field on which to sort a {@link DataObjectCollection} within a {@link DataObjectMetadata}.
22 *
23 * <p>
24 * The collection may hold multiple of these objects to support sorting by multiple fields.
25 * </p>
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 public interface DataObjectCollectionSortAttribute extends Serializable {
30
31 /**
32 * Gets attribute name.
33 *
34 * <p>
35 * The attribute name on which to sort the collection.
36 * </p>
37 *
38 * @return attribute name
39 */
40 String getAttributeName();
41
42 /**
43 * Gets the attribute sort.
44 *
45 * <p>
46 * For this attribute, which way should we sort?.
47 * </p>
48 *
49 * @return attribute sort
50 */
51 SortDirection getSortDirection();
52
53 }