com.stormpath.sdk.organization.OrganizationCriteria Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-api Show documentation

The Stormpath Java SDK API .jar provides a Java API that your code can use to make calls to the Stormpath API. This .jar is the only compile-time dependency within the Stormpath SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

The newest version!

/*
* Copyright 2015 Stormpath, Inc.
*
* 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 com.stormpath.sdk.organization;

import com.stormpath.sdk.query.Criteria;

/**
 * An {@link Organization}-specific {@link com.stormpath.sdk.query.Criteria} class, enabling a Organization-specific
 * fluent query DSL. OrganizationCriteria instances can be
 * constructed by using the {@link Organization} utility class, for example:
 *  * Organization.where(Organization.name().containsIgnoreCase("Roster"))
 *     .and(Organization.status().eq(OrganizationStatus.ENABLED))
 *     .orderByName()
 *     .limitTo(10));
 * 
 * Sort Order
 * 
 * All of the {@code orderBy*} methods append an {@code orderBy} clause to the query, ensuring the query results reflect
 * a particular sort order.
 * 

 * The default sort order is always {@code ascending}, but can be changed to {@code descending} by calling the
 * {@link #descending()} method immediately after the {@code orderBy} method call.  For example:
 * 
 * ...criteria.orderByName().descending()...
 * 
 * Multiple Order Statements
 * You may specify multiple {@code orderBy} clauses and the query results will be ordered, reflecting {@code orderBy}
 * statements in the order they are declared.  For example, to order the results first by name (ascending)
 * and then further by status (descending), you would chain {@code orderBy} statements:
 *  * ...criteria
 *     .orderByName()
 *     .orderByStatus().descending()
 *     ...
 * 
 *
 * @since 1.0.RC7
 */
public interface OrganizationCriteria extends Criteria, OrganizationOptions {

    /**
     * Ensures that the query results are ordered by organization {@link Organization#getName() name}.
     * 
     * Please see the {@link OrganizationCriteria class-level documentation} for controlling sort order (ascending or
     * descending) and chaining multiple {@code orderBy} clauses.
     *
     * @return this instance for method chaining
     */
    OrganizationCriteria orderByName();

    /**
     * Ensures that the query results are ordered by organization {@link Organization#getDescription() description}.
     * 

     * Please see the {@link OrganizationCriteria class-level documentation} for controlling sort order (ascending or
     * descending) and chaining multiple {@code orderBy} clauses.
     *
     * @return this instance for method chaining
     */
    OrganizationCriteria orderByDescription();

    /**
     * Ensures that the query results are ordered by organization {@link Organization#getStatus() status}.
     * 
     * Please see the {@link OrganizationCriteria class-level documentation} for controlling sort order (ascending or
     * descending) and chaining multiple {@code orderBy} clauses.
     *
     * @return this instance for method chaining
     */
    OrganizationCriteria orderByStatus();
}