001/** 002 * Copyright (C) 2006-2018 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 something; @Option String 051 * foo; }} 052 * 053 * This must call doValidate(something, foo). 054 * 055 * Syntax is the following: 056 * 057 * <ul> 058 * <li>.: represents the decorated option (aka "this")</li> 059 * <li>../foo: represents the 060 * 061 * <pre> 062 * foo 063 * </pre> 064 * 065 * option of the parent (if exists) of "."</li> 066 * <li>bar: represents the 067 * 068 * <pre> 069 * bar 070 * </pre> 071 * 072 * sibling option of the decorated field</li> 073 * <li>bar/dummy: represents the 074 * 075 * <pre> 076 * dummy 077 * </pre> 078 * 079 * option of the child bar of the decorated field</li> 080 * </ul> 081 * 082 * This syntax is close to path syntax but the important point is all the parameters are related to the decorated option. 083 * 084 * @return parameters for the validation. 085 */ 086 String[] parameters() default { "." }; 087}