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.kim.api.group;
017    
018    
019    import org.kuali.rice.core.api.membership.MemberType;
020    import org.kuali.rice.core.api.mo.common.GloballyUnique;
021    import org.kuali.rice.core.api.mo.common.Identifiable;
022    import org.kuali.rice.core.api.mo.common.Versioned;
023    import org.kuali.rice.core.api.mo.common.active.InactivatableFromTo;
024    /**
025     *
026     * This is a contract for a GroupMember
027     *
028     * A principal or group is considered to be a "member" of a group if it is either directly assigned to the group or
029     * indirectly assigned (via a nested group membership).
030     *
031     * @author Kuali Rice Team (rice.collab@kuali.org)
032     *
033     */
034    public interface GroupMemberContract extends Versioned, GloballyUnique, InactivatableFromTo, Identifiable {
035    
036        /**
037         * This is the id for the Group.
038         *
039         * <p>
040         * This is a id assigned to a Group.  It defines the group this group member belongs to.
041         * </p>
042         *
043         * @return groupId
044         */
045        String getGroupId();
046    
047        /**
048         * This is the member id for the Group Member.
049         *
050         * <p>
051         * This is a id value that defines the Group Member.  This value is either a Principal Id or Group Id
052         * depending on the type code
053         * </p>
054         *
055         * @return memberId
056         */
057        String getMemberId();
058    
059        /**
060         * This is the type code for the Group Member.
061         *
062         * <p>
063         * This is a value that defines the type of Group Member.  This value determines whether memberId is
064         * either a Principal Id or Group Id
065         * </p>
066         *
067         * @return typeCode
068         */
069        MemberType getType();
070    }