01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/user/tags/sakai_2-4-1/user-api/api/src/java/org/sakaiproject/user/api/UsersShareEmailUDP.java $
03: * $Id: UsersShareEmailUDP.java 7193 2006-03-29 01:02:58Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.user.api;
21:
22: import java.util.Collection;
23:
24: /**
25: * <p>
26: * UsersShareEmailUDP is an optional interface for a UserDirectoryProvider to indicate that they support user records that might share the same email address.
27: * </p>
28: */
29: public interface UsersShareEmailUDP {
30: /**
31: * Find all user objects which have this email address.
32: *
33: * @param email
34: * The email address string.
35: * @param factory
36: * Use this factory's newUser() method to create all the UserEdit objects you populate and return in the return collection.
37: * @return Collection (UserEdit) of user objects that have this email address, or an empty Collection if there are none.
38: */
39: Collection findUsersByEmail(String email, UserFactory factory);
40: }
|