ObjectAssociationContainer.java

/*
 *  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.core.metamodel.spec.feature;

import java.util.List;

import org.apache.isis.applib.filter.Filter;
import org.apache.isis.applib.filter.Filters;
import org.apache.isis.core.metamodel.spec.ObjectSpecificationException;

public interface ObjectAssociationContainer {

    /**
     * Get the field object representing the field with the specified field
     * identifier.
     * 
     * Throw a {@link ObjectSpecificationException} if no such association
     * exists.
     */
    ObjectAssociation getAssociation(String id);

    /**
     * Return all the fields that exist in an object of this specification,
     * although they need not all be accessible or visible.
     */
    List<ObjectAssociation> getAssociations(Contributed contributed);

    /**
     * Returns all {@link ObjectAssociation} ({@link Contributed#INCLUDED including contributed actions})
     * that match the supplied filter.
     */
    @Deprecated
    List<ObjectAssociation> getAssociations(Filter<ObjectAssociation> filter);

    /**
     * Return all {@link ObjectAssociation}s matching the supplied filter.
     * 
     * To get the statically visible fields (where any invisible and
     * unauthorised fields have been removed) use
     * <tt>ObjectAssociationFilters#staticallyVisible(...)</tt>
     * 
     * @see Filters
     */
    List<ObjectAssociation> getAssociations(Contributed contributed, Filter<ObjectAssociation> filter);

    /**
     * All {@link ObjectAssociation association}s that represent
     * {@link OneToOneAssociation properties}.
     */
    List<OneToOneAssociation> getProperties(Contributed contributed);

    /**
     * All {@link ObjectAssociation association}s that represents
     * {@link OneToManyAssociation collections}.
     * 
     * @return
     */
    List<OneToManyAssociation> getCollections(Contributed contributed);

}