com.stormpath.sdk.account.AccountLinkCriteria 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!

package com.stormpath.sdk.account;

import com.stormpath.sdk.query.Criteria;

/**
 * An {@link Account}-specific {@link Criteria} class, enabling an Account-specific
 * fluentquery DSL.  AccountCriteria instances can be
 * constructed by using the {@link Accounts} utility class, for example:
 *  * AccountLinks.where(AccountLinks.createdAt().equals("2016-01-01"))
 *     .orderByCreatedAt().descending()
 *     .offsetBy(50)
 *     .limitTo(25));
 * 
 * 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.orderByCreatedAt().descending()...
 *
 * @since 1.1.0
 */
public interface AccountLinkCriteria extends Criteria, AccountLinkOptions {

    /**
     * Ensures that the query results are ordered by createdAt Date {@link AccountLink#getCreatedAt() createdAt}.
     * 
     * Please see the {@link AccountLinkCriteria class-level documentation} for controlling sort order (ascending or
     * descending).
     *
     * @return this instance for method chaining
     */
    AccountLinkCriteria orderByCreatedAt();
}