001    /**
002     * Copyright 2005-2014 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.krad.data.provider.annotation;
017    
018    import java.lang.annotation.Documented;
019    import java.lang.annotation.ElementType;
020    import java.lang.annotation.Retention;
021    import java.lang.annotation.RetentionPolicy;
022    import java.lang.annotation.Target;
023    
024    /**
025     * Defines a relationship between the current field and a list of foreign key fields.
026     *
027     * @author Kuali Rice Team (rice.collab@kuali.org)
028     */
029    @Target(ElementType.FIELD)
030    @Retention(RetentionPolicy.RUNTIME)
031    @Documented
032    public @interface Relationship {
033    
034        /**
035         * Gets the list of foreign key field property names.
036         *
037         * @return the list of foreign key field property names.
038         */
039            String[] foreignKeyFields();
040    }