com.stormpath.sdk.account.AccountLinkOptions 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.Options;

/**
 * AccountLink-specific options that may be specified when retrieving {@link AccountLink} resources.
 *
 * @since 1.1.0
 */
public interface AccountLinkOptions extends Options {

    /**
     * Ensures that when retrieving an AccountLink, the Account's {@link AccountLink#getLeftAccount() leftAccount} is also
     * retrieved in the same request. This enhances performance by leveraging a single request to retrieve multiple
     * related resources you know you will use.
     *
     * @return this instance for method chaining.
     */
    T withLeftAccount();

    /**
     * Ensures that when retrieving an Account, the Account's parent {@link AccountLink#getRightAccount() rightAccount} is also
     * retrieved in the same request.  This enhances performance by leveraging a single request to retrieve multiple
     * related resources you know you will use.
     *
     * @return this instance for method chaining.
     */
    T withRightAccount();

}