/*
 * Copyright 2016 requery.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.requery;

import io.requery.query.Order;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Set the query sort order for relationship attribute (a field or method marked with
 * {@link ManyToMany} or {@link OneToMany}. When the relation is retrieved the specified ordering
 * will be supplied for the generated query.
 */
@Documented
@Target({FIELD, METHOD})
@Retention(RUNTIME)
public @interface OrderBy {

    /**
     * @return required column name to order on
     */
    String value();

    /**
     * @return {@link Order} for the result
     */
    Order order() default Order.ASC;
}