Coverage Report

Coverage Report - org.kuali.rice.kim.service.GroupInternalService

Classes in this File

 /*
  * Copyright 2007-2009 The Kuali Foundation
  *
  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
  *
  * 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.kuali.rice.kim.service;
 
 import java.util.List;
 
 import org.kuali.rice.kim.bo.impl.GroupImpl;
 
 /**
  * Provides internal notification services for the GroupServiceImpl.  It
  * specifically allows GroupServiceImpl to notify interested parties that
  * a group's membership has changed.  
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  *
  */
 public interface GroupInternalService {
         /**
          * Save the GroupImpl, being careful to reset the action document
          * assignments based on any membership changes.
          * 
          * @param group
          */
     public GroupImpl saveWorkgroup(GroupImpl group);
         
     /**
      * Updates KEW for workgroup members according to membership differences between the
      * two workgroups.  Since the changeset of such an operation could potentially be quite large,
      * this method should schedule the changes to occur asynchronously to mitigate transaction
      * and concurrent document modification issues.
      */
     public void updateForWorkgroupChange( String groupId,
                     List<String> oldPrincipalIds, List<String> newPrincipalIds);
 
     /**
      * Updates KEW for a the given document for a user who was added to a workgroup.  This method will generate
      * new action items for the requests on the document which are for the workgroup.  This method will also verify that
      * the user is, in fact, still a member of the workgroup at the time of the invocation of this method before
      * generating the action items.
      */
     public void updateForUserAddedToGroup(String principalId, String groupId);
 
     /**
      * Updates KEW for a the given document for a user who was removed from a workgroup.  This will delete
      * any action items for the given user on the document which were sent to that user because they were a
      * member of the workgroup.  This method will also verify that the user is still no longer a member of the workgroup
      * at the time of the method invocation before removing the action items.
      */
     public void updateForUserRemovedFromGroup(String principalId, String groupId);
 }

1		/*
2		* Copyright 2007-2009 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.kim.service;
17
18		import java.util.List;
19
20		import org.kuali.rice.kim.bo.impl.GroupImpl;
21
22		/**
23		* Provides internal notification services for the GroupServiceImpl. It
24		* specifically allows GroupServiceImpl to notify interested parties that
25		* a group's membership has changed.
26		*
27		* @author Kuali Rice Team (rice.collab@kuali.org)
28		*
29		*/
30		public interface GroupInternalService {
31		/**
32		* Save the GroupImpl, being careful to reset the action document
33		* assignments based on any membership changes.
34		*
35		* @param group
36		*/
37		public GroupImpl saveWorkgroup(GroupImpl group);
38
39		/**
40		* Updates KEW for workgroup members according to membership differences between the
41		* two workgroups. Since the changeset of such an operation could potentially be quite large,
42		* this method should schedule the changes to occur asynchronously to mitigate transaction
43		* and concurrent document modification issues.
44		*/
45		public void updateForWorkgroupChange( String groupId,
46		List<String> oldPrincipalIds, List<String> newPrincipalIds);
47
48		/**
49		* Updates KEW for a the given document for a user who was added to a workgroup. This method will generate
50		* new action items for the requests on the document which are for the workgroup. This method will also verify that
51		* the user is, in fact, still a member of the workgroup at the time of the invocation of this method before
52		* generating the action items.
53		*/
54		public void updateForUserAddedToGroup(String principalId, String groupId);
55
56		/**
57		* Updates KEW for a the given document for a user who was removed from a workgroup. This will delete
58		* any action items for the given user on the document which were sent to that user because they were a
59		* member of the workgroup. This method will also verify that the user is still no longer a member of the workgroup
60		* at the time of the method invocation before removing the action items.
61		*/
62		public void updateForUserRemovedFromGroup(String principalId, String groupId);
63		}