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.impl.group;
017    
018    import org.kuali.rice.kim.impl.group.GroupBo;
019    
020    import java.util.List;
021    
022    
023    /**
024     * Provides internal notification services for the GroupServiceImpl.  It
025     * specifically allows GroupServiceImpl to notify interested parties that
026     * a group's membership has changed.  
027     * 
028     * @author Kuali Rice Team (rice.collab@kuali.org)
029     *
030     */
031    public interface GroupInternalService {
032            /**
033             * Save the GroupBo, being careful to reset the action document
034             * assignments based on any membership changes.
035             * 
036             * @param group
037             */
038        public GroupBo saveWorkgroup(GroupBo group);
039    
040        /**
041         * Updates KEW for workgroup members according to membership differences between the
042         * two workgroups.  Since the changeset of such an operation could potentially be quite large,
043         * this method should schedule the changes to occur asynchronously to mitigate transaction
044         * and concurrent document modification issues.
045         */
046        public void updateForWorkgroupChange( String groupId,
047                    List<String> oldPrincipalIds, List<String> newPrincipalIds);
048    
049        /**
050         * Updates KEW for a the given document for a user who was added to a Group.  This method will generate
051         * new action items for the requests on the document which are for the Group.  This method will also verify that
052         * the user is, in fact, still a member of the Group at the time of the invocation of this method before
053         * generating the action items.
054         */
055        public void updateForUserAddedToGroup(String principalId, String groupId);
056    
057        /**
058         * Updates KEW for a the given document for a user who was removed from a Group.  This will delete
059         * any action items for the given user on the document which were sent to that user because they were a
060         * member of the Group.  This method will also verify that the user is still no longer a member of the Group
061         * at the time of the method invocation before removing the action items.
062         */
063        public void updateForUserRemovedFromGroup(String principalId, String groupId);
064    }