/*
 *  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.applib.annotation;

/**
 * Tells the framework which method or field to use in order to construct a navigable chain of
 * parent domain object instances. The Navigable.PARENT 'flag' can only be used once per class declaration.
 *
 * @since 2.0 {@index}
 */
public enum Navigable {
    NOT_SPECIFIED,
    IGNORE,
    /**
     * When used via {@link PropertyLayout}, identifies a logical parent, that is navigable via the UI.
     */
    PARENT;

    public boolean isParent() { return this == PARENT; }
}
