com.stormpath.sdk.tenant.TenantOptions Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 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.tenant;

import com.stormpath.sdk.query.Options;

/**
 * @since 0.8
 */
public interface TenantOptions extends Options {

    T withApplications();

    T withApplications(int limit);

    T withApplications(int limit, int offset);

    T withDirectories();

    T withDirectories(int limit);

    T withDirectories(int limit, int offset);

    /**
     * Ensures that when retrieving a Tenant, the Tenant's {@link Tenant#getCustomData() customData} 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.
     * @since 1.0.0
     */
    T withCustomData();

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getAccounts() accounts} are also retrieved in the same request.
     * 
     * If you wish to control pagination parameters (offset and limit) for the returned accounts, see the
     * {@link #withAccounts(int) withAccounts(limit)} or
     * {@link #withAccounts(int, int) withAccounts(limit,offset)} methods.
     *
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withAccounts();

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getAccounts() accounts} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withAccounts(int limit);

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getAccounts() accounts} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @param offset the zero-based starting index in the entire collection of the first item to return. Default is 0
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withAccounts(int limit, int offset);

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getGroups() groups} are also retrieved in the same request.
     * 

     * If you wish to control pagination parameters (offset and limit) for the returned groups, see the
     * {@link #withGroups(int) withGroups(limit)} or
     * {@link #withGroups(int, int) withGroups(limit,offset)} methods.
     *
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withGroups();

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getGroups() groups} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withGroups(int limit);

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getGroups() groups} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @param offset the zero-based starting index in the entire collection of the first item to return. Default is 0
     * @return this instance for method chaining.
     * @since 1.0.RC4.6
     */
    T withGroups(int limit, int offset);

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getOrganizations() organizations} are also retrieved in the same request.
     * 
     * If you wish to control pagination parameters (offset and limit) for the returned groups, see the
     * {@link #withOrganizations(int) withOrganizations(limit)} or
     * {@link #withOrganizations(int, int) withOrganizations(limit,offset)} methods.
     *
     * @return this instance for method chaining.
     * @since 1.0.RC5
     */
    T withOrganizations();

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getOrganizations() organizations} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @return this instance for method chaining.
     * @since 1.0.RC5
     */
    T withOrganizations(int limit);

    /**
     * Ensures that when retrieving a Tenant, the associated {@link Tenant#getOrganizations() organizations} are also retrieved in the same request.
     *
     * @param limit defines the maximum quantity of items to be retrieved when expanding this Collection Resource. Min:1, Max: 100. The default value is 25.
     * @param offset the zero-based starting index in the entire collection of the first item to return. Default is 0
     * @return this instance for method chaining.
     * @since 1.0.RC5
     */
    T withOrganizations(int limit, int offset);
}