001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/profile/tags/sakai_2-4-1/edu-person-api/src/java/org/sakaiproject/api/common/edu/person/SakaiPerson.java $
003: * $Id: SakaiPerson.java 8424 2006-04-27 20:23:44Z ggolden@umich.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.api.common.edu.person;
021:
022: /**
023: * @author <a href="mailto:lance@indiana.edu">Lance Speelmon </a>
024: */
025:
026: public interface SakaiPerson extends EduPerson {
027: /**
028: * Person's pictureUrl, url to user picture provided.
029: *
030: * @return
031: */
032: public String getPictureUrl();
033:
034: /**
035: * Person's pictureUrl, url to user picture provided.
036: *
037: * @param pictureURL
038: */
039: public void setPictureUrl(String pictureURL);
040:
041: /**
042: * Person's preference to display system picture, if the institution provided picture is preferred for display.
043: *
044: * @return
045: */
046: public Boolean isSystemPicturePreferred();
047:
048: /**
049: * Person's preference to display system picture, if the institution provided picture is preferred for display.
050: *
051: * @return
052: */
053: public void setSystemPicturePreferred(Boolean systemPicturePreferred);
054:
055: /**
056: * Other information provided
057: *
058: * @return
059: */
060: public String getNotes();
061:
062: /**
063: * Other information provided
064: *
065: * @param notes :
066: * set other information provided
067: */
068: public void setNotes(String notes);
069:
070: // TODO verify method with Lance
071: /**
072: * Person's campus
073: *
074: * @return
075: */
076: public String getCampus();
077:
078: // TODO verify method with Lance
079: /**
080: * Person's campus
081: *
082: * @param school
083: */
084: public void setCampus(String school);
085:
086: /**
087: * Person's preference to allow read access to private information
088: *
089: * @return
090: */
091: public Boolean getHidePrivateInfo();
092:
093: /**
094: * Person's preference to allow read access to private information
095: *
096: * @param hidePrivateInfo
097: */
098: public void setHidePrivateInfo(Boolean hidePrivateInfo);
099:
100: /**
101: * Person's preference to allow read access to public information
102: *
103: * @return
104: */
105: public Boolean getHidePublicInfo();
106:
107: /**
108: * Person's preference to allow read access to public information
109: *
110: * @param hidePublicInfo
111: */
112: public void setHidePublicInfo(Boolean hidePublicInfo);
113:
114: /**
115: * Has the user invoked their FERPA rights?
116: *
117: * @return
118: */
119: public Boolean getFerpaEnabled();
120:
121: /**
122: * @param ferpaEnabled
123: * TRUE if FERPA rights have been invoked. If FALSE or NULL no FERPA rights have been invoked.
124: */
125: public void setFerpaEnabled(Boolean ferpaEnabled);
126: }
|