[isis] 02/03: ISIS-3020: adds @MultivariateParameterSupport annot.

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 3cc79855c535c216e2053d7126360a1fc8fcff83
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Apr 27 07:41:03 2022 +0200

    ISIS-3020: adds @MultivariateParameterSupport annot.
---
 .../annotation/MultivariateParameterSupport.java   | 57 ++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MultivariateParameterSupport.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MultivariateParameterSupport.java
new file mode 100644
index 0000000000..3cf178176b
--- /dev/null
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MultivariateParameterSupport.java
@@ -0,0 +1,57 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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 org.apache.isis.applib.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Indicates that a method is supporting an <i>Action</i> parameter,
+ * while allowing for one or more than one arguments to be passed in.
+ * <p>
+ * Following method templates are supported to receive a {@link MultivariateParameterSupport} annotation:
+ * <ul><li>hideNXxx</li><li>disableNXxx</li><li>choicesNXxx</li><li>autoCompleteNXxx</li><li>validateNXxx</li></ul>
+ * <p>
+ * By placing the {@link MultivariateParameterSupport} annotation on a method,
+ * a contract with the meta-model is enforced,
+ * such that this method must be recognized by the meta-model and cannot be ignored.
+ * <p>
+ * It was introduced to allow compatibility with the <i>Apache Isis v1</i> programming model
+ * and is likely going to be phased out with later releases.
+ *
+ * @since 2.0 {@index}
+ * @see MemberSupport
+ * @see ObjectSupport
+ * @see ObjectLifecycle
+ * @see Programmatic
+ * @deprecated likely to be phased out with later releases, while there is yet no definitive schedule
+ */
+@Deprecated(since = "2.0.0-RC1")
+@Inherited
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@Domain.Include // meta annotation, in support of meta-model validation
+public @interface MultivariateParameterSupport {
+
+}
+
+