content: /*
   *  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.causeway.extensions.secman.applib.tenancy.dom;
  
  import java.lang.annotation.ElementType;
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  import java.lang.annotation.Target;
  
  import org.apache.causeway.applib.annotation.Editing;
  import org.apache.causeway.applib.annotation.Optionality;
  import org.apache.causeway.applib.annotation.Parameter;
  import org.apache.causeway.applib.annotation.Property;
  import org.apache.causeway.extensions.secman.applib.tenancy.spi.ApplicationTenancyEvaluator;
  
  /**
   * Role interface for domain objects to implement, indicating that these are characteristics of the entity that
   * can be used to determine its visibility/editability.
   *
   * <p>
   * Previously the <code>atPath</code> would have corresponded to the unique path of some particular
   * {@link ApplicationTenancy} instance.
   * However, this has now been generalized;
   * the atPath is simply a string whose interpretation is application-specific (in particular by
   * the {@link ApplicationTenancyEvaluator} SPI).
   *
   * <p>
   * For applications that still wish to follow the original more specific design (that the <code>atPath</code>
   * corresponds to a single {@link ApplicationTenancy}), then the path can be interpreted according to the
   * following table:
   * </p>
   * <table border="1">
   *     <tr>
   *         <th>object's tenancy</th><th>user's tenancy</th><th>access</th>
   *     </tr>
   *     <tr>
   *         <td>null</td><td>null</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>null</td><td>non-null</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>/</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>/it</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>/it/car</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>/it/igl</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>/fr</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/</td><td>null</td><td>not visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>/</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>/it</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>/it/car</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>/it/igl</td><td>visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>/fr</td><td>not visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it</td><td>null</td><td>not visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>/</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>/it</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>/it/car</td><td>editable</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>/it/igl</td><td>not visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>/fr</td><td>not visible</td>
   *     </tr>
   *     <tr>
   *         <td>/it/car</td><td>null</td><td>not visible</td>
   *     </tr>
   * </table>
   * <p>any object that is not tenanted (that is, its class does not implement
   * {@link HasAtPath the HasAtPath interface} is accessible by any user
   * (usual permission rules apply).
   * </p>
   *
   * @since 2.0 {@index}
   */
  public interface HasAtPath {
  
      @AtPath
      String getAtPath();
  
      @Property(
              maxLength = AtPath.MAX_LENGTH,
              editing = Editing.DISABLED,
              optionality = Optionality.OPTIONAL
      )
      @Parameter(
              maxLength = AtPath.MAX_LENGTH,
              optionality = Optionality.OPTIONAL
      )
      @Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE })
      @Retention(RetentionPolicy.RUNTIME)
      public @interface AtPath {
          int MAX_LENGTH = 255;
          boolean NULLABLE = true;
          String ALLOWS_NULL = "true";
      }
  
  }
  