core/api/src/main/java/org/apache/zest/api/association/AssociationStateHolder.java

/*
 * Copyright (c) 2008-2013, Niclas Hedhman. All Rights Reserved.
 * Copyright (c) 2014, Paul Merlin. All Rights Reserved.
 *
 * Licensed  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.zest.api.association;

import java.lang.reflect.AccessibleObject;
import org.apache.zest.api.property.StateHolder;

/**
 * This represents the state of a entity (properties+associations).
 */
public interface AssociationStateHolder
    extends StateHolder
{
    /**
     * Get an association for a specific accessor method
     *
     * @param associationMethod for the association
     *
     * @return the association
     */
    <T> Association<T> associationFor( AccessibleObject associationMethod );

    /**
     * Get all associations
     *
     * @return iterable of associations
     */
    Iterable<? extends Association<?>> allAssociations();

    /**
     * Get a many-association for a specific accessor method
     *
     * @param manyassociationMethod for the many-association
     *
     * @return the association
     */
    <T> ManyAssociation<T> manyAssociationFor( AccessibleObject manyassociationMethod );

    /**
     * Get all ManyAssociations
     *
     * @return iterable of many-associations
     */
    Iterable<? extends ManyAssociation<?>> allManyAssociations();

    /**
     * Get a named-association for a specific accessor method
     *
     * @param namedassociationMethod for the named-association
     *
     * @return the association
     */
    <T> NamedAssociation<T> namedAssociationFor( AccessibleObject namedassociationMethod );

    /**
     * Get all NmaedAssociations
     *
     * @return iterable of named-associations
     */
    Iterable<? extends NamedAssociation<?>> allNamedAssociations();
}