001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/profile/tags/sakai_2-4-1/profile-api/src/java/org/sakaiproject/api/app/profile/Profile.java $
003: * $Id: Profile.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.app.profile;
021:
022: import org.sakaiproject.api.common.edu.person.SakaiPerson;
023:
024: /**
025: * @author rshastri <a href="mailto:rshastri@iupui.edu ">Rashmi Shastri</a>
026: */
027: public interface Profile {
028: /**
029: * @return
030: */
031:
032: // public Long getId();
033: /**
034: * @return
035: */
036: public String getUserId();
037:
038: /**
039: * @param userID
040: */
041: public void setUserID(String userID);
042:
043: /**
044: * @return
045: */
046:
047: // public Integer getVersion();
048: /**
049: * @return
050: */
051: public String getDepartment();
052:
053: /**
054: * @param department
055: */
056: public void setDepartment(String department);
057:
058: /**
059: * @return
060: */
061: public String getEmail();
062:
063: /**
064: * @param email
065: */
066: public void setEmail(String email);
067:
068: /**
069: * @return
070: */
071: public String getFirstName();
072:
073: /**
074: * @param firstName
075: */
076: public void setFirstName(String firstName);
077:
078: /**
079: * @return
080: */
081: public String getNickName();
082:
083: /**
084: * @param firstName
085: */
086: public void setNickName(String nickName);
087:
088: /**
089: * @return
090: */
091: public String getHomePhone();
092:
093: /**
094: * @param homePhone
095: */
096: public void setHomePhone(String homePhone);
097:
098: /**
099: * @return
100: */
101: public String getHomepage();
102:
103: /**
104: * @param homepage
105: */
106: public void setHomepage(String homepage);
107:
108: /**
109: * @return
110: */
111: public String getLastName();
112:
113: /**
114: * @param lastName
115: */
116: public void setLastName(String lastName);
117:
118: /**
119: * @return
120: */
121: public String getOtherInformation();
122:
123: /**
124: * @param otherInformation
125: */
126: public void setOtherInformation(String otherInformation);
127:
128: /**
129: * @return
130: */
131: public String getPictureUrl();
132:
133: /**
134: * @param pictureUrl
135: */
136: public void setPictureUrl(String pictureUrl);
137:
138: /**
139: * @return
140: */
141: public String getPosition();
142:
143: /**
144: * @param position
145: */
146: public void setPosition(String position);
147:
148: /**
149: * @return
150: */
151: public String getRoom();
152:
153: /**
154: * @param room
155: */
156: public void setRoom(String room);
157:
158: /**
159: * @return
160: */
161: public String getSchool();
162:
163: /**
164: * @param school
165: */
166: public void setSchool(String school);
167:
168: /**
169: * @return
170: */
171: public String getWorkPhone();
172:
173: /**
174: * @param workPhone
175: */
176: public void setWorkPhone(String workPhone);
177:
178: /**
179: * @return
180: */
181: public Boolean isInstitutionalPictureIdPreferred();
182:
183: /**
184: * @param institutionalPictureIdPreferred
185: */
186: public void setInstitutionalPictureIdPreferred(
187: Boolean institutionalPictureIdPreferred);
188:
189: /**
190: * @return
191: */
192: public byte[] getInstitutionalPicture();
193:
194: /**
195: * @param institutionalPicture
196: */
197: // Can not allow users to set institutiona picture.
198: // public void setInstitutionalPicture(byte[] institutionalPicture);
199: /**
200: * @return
201: */
202: public SakaiPerson getSakaiPerson();
203:
204: /**
205: * @param sakaiPerson
206: */
207: public void setSakaiPerson(SakaiPerson sakaiPerson);
208:
209: /**
210: * @return
211: */
212: public Boolean getHidePrivateInfo();
213:
214: /**
215: * Person's preference to allow read access to private information
216: *
217: * @param hidePrivateInfo
218: */
219: public void setHidePrivateInfo(Boolean hidePrivateInfo);
220:
221: /**
222: * Person's preference to allow read access to public information
223: *
224: * @return
225: */
226: public Boolean getHidePublicInfo();
227:
228: /**
229: * Person's preference to allow read access to public information
230: *
231: * @param hidePublicInfo
232: */
233: public void setHidePublicInfo(Boolean hidePublicInfo);
234: }
|