01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/user/tags/sakai_2-4-1/user-api/api/src/java/org/sakaiproject/user/api/DisplayAdvisorUDP.java $
03: * $Id: DisplayAdvisorUDP.java 10600 2006-06-14 15:00:14Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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: /**
23: * <p>
24: * DisplayAdvisorUDP is an optional interface for a UserDirectoryProvider to indicate that they should be called for User.getDisplayId() and User.getDisplayName().
25: * </p>
26: */
27: public interface DisplayAdvisorUDP {
28: /**
29: * Compute a display id for this user.
30: *
31: * @param user
32: * The User object.
33: * @return a display id for this user, or null if the UDP is not advising on this one.
34: */
35: String getDisplayId(User user);
36:
37: /**
38: * Compute a display name for this user.
39: *
40: * @param user
41: * The User object.
42: * @return a display name for this user, or null if the UDP is not advising on this one.
43: */
44: String getDisplayName(User user);
45: }
|