com.stormpath.sdk.account.AccountLink 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.resource.Deletable;
import com.stormpath.sdk.resource.Resource;

import java.util.Date;

/**
 * A {@code AccountLink} represents the link between 2 {@link Account}s
 * 
 * {@link #delete() Deleting} this resource will only delete the association - it will not delete
 * the accounts themselves {@code Account}
 *
 * @since 1.1.0
 */
public interface AccountLink extends Resource, Deletable {

    /**
     * Returns the leftAccount {@link Account} resource.
     *
     * @return the leftAccount {@link Account} resource.
     */
    Account getLeftAccount();

    /**
     * Returns the rightAccount {@link Account} resource.
     *
     * @return the rightAccount {@link Account} resource.
     */
    Account getRightAccount();

    /**
     * Returns the rightAccount {@link Account} resource.
     *
     * @return the rightAccount {@link Account} resource.
     */
    Date getCreatedAt();
}