com.hpe.adm.nga.sdk.model.FieldMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-src Show documentation
The newest version!
/*
 * Copyright 2016-2023 Open Text.
 *
 * The only warranties for products and services of Open Text and
 * its affiliates and licensors (“Open Text”) are as may be set forth
 * in the express warranty statements accompanying such products and services.
 * Nothing herein should be construed as constituting an additional warranty.
 * Open Text shall not be liable for technical or editorial errors or
 * omissions contained herein. The information contained herein is subject
 * to change without notice.
 *
 * Except as specifically indicated otherwise, this document contains
 * confidential information and a valid license is required for possession,
 * use or copying. If this work is provided to the U.S. Government,
 * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
 * Computer Software Documentation, and Technical Data for Commercial Items are
 * licensed to the U.S. Government under vendor's standard commercial license.
 *
 * 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.hpe.adm.nga.sdk.model;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Adds useful metadata information to the method such as whether the field is required or sortable
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface FieldMetadata {
    /**
     * Is the field required
     * @return required
     */
    boolean required() default false;
    /**
     * Is the field filterable
     * @return filterable
     */
    boolean filterable() default true;
    /**
     * Is the field sortable
     * @return sortable
     */
    boolean sortable() default true;
    /**
     * The minimum value for the field (where relevant)
     * @return minvalue
     */
    long minValue() default Long.MIN_VALUE;
    /**
     * The maximum value for the field (where relevant)
     * @return maxvalue
     */
    long maxValue() default Long.MAX_VALUE;

    /**
     * The maximum length for the string field (where relevant)
     * @return max length
     */
    long maxLength() default Integer.MAX_VALUE;
}