001    /**
002     * Copyright 2005-2013 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.kim.api.common.attribute;
017    
018    import org.kuali.rice.core.api.mo.common.GloballyUnique;
019    import org.kuali.rice.core.api.mo.common.Identifiable;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    import org.kuali.rice.kim.api.type.KimTypeContract;
022    
023    /**
024     * This is the contract for a KimDataAttribute.  A KimDataAttribute
025     * associates a value with a kim attribute.
026     */
027    public interface KimAttributeDataContract extends Identifiable, Versioned, GloballyUnique {
028    
029        /**
030         * The id of the object this AttributeData is associated with.  For
031         * example:  this could be a permissionId, roleId, groupId, or
032         * responsibilityId.
033         *
034         * @return the id
035         */
036        String getAssignedToId();
037    
038        /**
039         * The attribute value.  This can be null or blank.
040         *
041         * @return the attribute value.
042         */
043            String getAttributeValue();
044    
045        /**
046         * The kim attribute associated with the kim attribute data.  This can be null if no KimAttributes are associated.
047         *
048         * @return the kim attribute
049         */
050            KimAttributeContract getKimAttribute();
051    
052    
053        /**
054         * The kim type id associated with the kim attribute data.  This can be null if no kim types are associated.
055         *
056         * @return the kim type id
057         */
058        String getKimTypeId();
059    
060        /**
061         * The kim type associated with the kim attribute data.  This can be null if no kim types are associated.
062         *
063         * @return the kim type
064         */
065        KimTypeContract getKimType();
066    }