001/**
002 * Copyright (C) 2006-2019 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.configuration.action;
017
018import static java.lang.annotation.ElementType.FIELD;
019import static java.lang.annotation.ElementType.PARAMETER;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025import org.talend.sdk.component.api.configuration.action.meta.ActionRef;
026import org.talend.sdk.component.api.meta.Documentation;
027import org.talend.sdk.component.api.service.asyncvalidation.AsyncValidation;
028
029@ActionRef(AsyncValidation.class)
030@Documentation("Mark the decorated field/parameter as supporting dropdown completion. Server expects the client "
031        + "to pass the parameter value as parameter. It can optionally have other parameters but they must match the "
032        + "form/parameter parameter path exactly then to let the client fill them.")
033@Target({ FIELD, PARAMETER })
034@Retention(RUNTIME)
035public @interface Validable {
036
037    /**
038     * @return value of @{@link org.talend.sdk.component.api.service.asyncvalidation.AsyncValidation} value method.
039     */
040    String value();
041
042    /**
043     * This "list" will represent the parameter the caller will send to the validation.
044     * Assuming you have this validation:
045     *
046     * {@code @AsyncValidation("xxx") ValidationResult doValidate(@Option("value") String value, @Option("other") String other)}
047     *
048     * And this model:
049     *
050     * {@code public class MyModel { @Validable(value = "xxx", parameters = {".", "foo"}) @Option String
051     * something; @Option String
052     * foo; }}
053     *
054     * This must call doValidate(something, foo).
055     *
056     * Syntax is the following:
057     *
058     * <ul>
059     * <li>.: represents the decorated option (aka "this")</li>
060     * <li>../foo: represents the
061     * 
062     * <pre>
063     * foo
064     * </pre>
065     * 
066     * option of the parent (if exists) of "."</li>
067     * <li>bar: represents the
068     * 
069     * <pre>
070     * bar
071     * </pre>
072     * 
073     * sibling option of the decorated field</li>
074     * <li>bar/dummy: represents the
075     * 
076     * <pre>
077     * dummy
078     * </pre>
079     * 
080     * option of the child bar of the decorated field</li>
081     * </ul>
082     *
083     * This syntax is close to path syntax but the important point is all the parameters are related to the decorated
084     * option.
085     *
086     * @return parameters for the validation.
087     */
088    String[] parameters() default { "." };
089}