01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/sections/tags/sakai_2-4-1/sections-api/src/java/org/sakaiproject/section/api/coursemanagement/User.java $
03: * $Id: User.java 18134 2006-11-14 18:59:25Z jholtzman@berkeley.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Regents of the University of California and The Regents of the University of Michigan
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.section.api.coursemanagement;
21:
22: /**
23: * Models a User for use in the Section Awareness API and the Section Manager Tool.
24: *
25: * @author <a href="mailto:jholtzman@berkeley.edu">Josh Holtzman</a>
26: *
27: */
28: public interface User {
29: /**
30: * @return Returns the userUid, the unique ID returned by the authentication facade.
31: */
32: public String getUserUid();
33:
34: /**
35: * @return Returns the sortName, displayed when users are listed in order (for example,
36: * "Paine, Thomas" or "Wong Kar-Wai")
37: */
38: public String getSortName();
39:
40: /**
41: * @return Returns the displayId, AKA "campus ID", a human-meaningful UID for the user (for
42: * example, a student ID number or an institutional email address)
43: */
44: public String getDisplayId();
45:
46: /**
47: * @return Returns the displayName, displayed when only this user is being referred to
48: * (for example, "Thomas Paine" or "Wong Kar-Wai")
49: */
50: public String getDisplayName();
51:
52: }
|