com.stormpath.sdk.organization.CreateOrganizationRequestBuilder 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;

/**
 *
 * A Builder to construct {@link CreateOrganizationRequest}s.
 *
 * @see com.stormpath.sdk.organization.Organizations#newCreateRequestFor(Organization)

 * @since 1.0.RC7
 */
public interface CreateOrganizationRequestBuilder {

    /**
     * Directive indicating that a new Directory shall be created along with this new Organization. The new Directory
     * will automatically be assigned as the Organization's default Groups and Accounts store.
     * 
     * The directory will be automatically named based on heuristics to ensure a guaranteed unique name based on the
     * organization.  If you want to specify the Directory's name, use the {@link #createDirectoryNamed(String)} method.
     *
     * @return the builder instance for method chaining.
     * @see #createDirectoryNamed(String)
     */
    CreateOrganizationRequestBuilder createDirectory();

    /**
     * Directive indicating that a new Directory shall be created along with this new Organization. The new Directory will automatically
     * be assigned as the Organization's default Groups and Accounts store.
     * 
     * If you don't care about the new Directory's name and want a reasonable default assigned automatically, don't
     * call this method - call {@link #createDirectory()} instead.
     *
     * @return the builder instance for method chaining.
     * @see #createDirectory()
     */
    CreateOrganizationRequestBuilder createDirectoryNamed(String name);

    /**
     * Creates a new {@code CreateOrganizationRequest} instance based on the current builder state.
     *
     * @return a new {@code CreateOrganizationRequest} instance based on the current builder state.
     */
    CreateOrganizationRequest build();
}