com.stormpath.sdk.schema.Field 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 2016 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.schema;

import com.stormpath.sdk.resource.Deletable;
import com.stormpath.sdk.resource.Resource;
import com.stormpath.sdk.resource.Saveable;

/**
 * A Field represents the configuration of an {@link com.stormpath.sdk.account.Account} field, it determines if its required or not.
 *
 * @since 1.2.0
 */
public interface Field extends Resource, Saveable, Deletable {

    /**
     * Returns the name of the field
     *
     * @return the field's name
     */
    String getName();

    /**
     * Returns true if the given field is required or false otherwise
     *
     * @return the field's required value
     */
    boolean isRequired();

    /**
     * Sets the field as required or not
     * After calling this method, you must call {@link #save()} to propagate the change to the Stormpath
     * servers.
     *
     * @param required true if the field is required, false otherwise
     * @return the Field itself
     */
    Field setRequired(boolean required);

    /**
     * Returns the schema this field belongs to.
     *
     * @return the parent {@link Schema}
     */
    Schema getSchema();

}