001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.extensions.markup.html.repeater.data.sort;
018
019import org.apache.wicket.util.io.IClusterable;
020
021/**
022 * Interface used by OrderByLink to interact with any object that keeps track of sorting state
023 * 
024 * @author Igor Vaynberg (ivaynberg)
025 * @param <S>
026 *            the type of the sort property
027 * 
028 */
029public interface ISortState<S> extends IClusterable
030{
031        /**
032         * Sets sort order of the property
033         * 
034         * @param property
035         *            the name of the property to sort on
036         * @param order
037         *            sort order
038         */
039        void setPropertySortOrder(S property, SortOrder order);
040
041        /**
042         * Gets the sort order of a property
043         * 
044         * @param property
045         *            sort property to be checked
046         * @return sort order
047         */
048        SortOrder getPropertySortOrder(S property);
049
050}