Project

General

Profile

« Previous | Next » 

Revision c5bf5a2a

Added by Marc Geoffroy about 16 years ago

View differences:

cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/Person.java
103 103
	/** 
104 104
	 * Returns the set of {@link InstitutionalMembership institution memberships} corresponding to this person. 
105 105
	 *
106
	 * @return	the set of institution memberships
107 106
	 * @see     InstitutionalMembership
108 107
	 */
109 108
	@OneToMany
......
157 156
	 * a geographical specialization of this person.
158 157
	 * Keywords are items of a controlled {@link common.TermVocabulary vocabulary}.
159 158
	 *
160
	 * @return	the set of keywords
161 159
	 * @see 	common.Keyword
162 160
	 */
163 161
	@OneToMany
......
194 192

  
195 193

  
196 194

  
195
	/** 
196
	 * Returns the {@link Contact contact} of this person.
197
	 * The contact contains several ways to approach this person.
198
	 *
199
	 * @see 	Contact
200
	 */
197 201
	@ManyToOne
198 202
	@Cascade({CascadeType.SAVE_UPDATE})
199 203
	public Contact getContact(){
200 204
		return this.contact;
201 205
	}
202
	/** 
203
	 * Assigns a {@link Contact contact} to this person.
204
	 *
205
	 * @param  contact  the contact which should be assigned to this person
206
	/**
207
	 * @see  #getContact()
206 208
	 */
207 209
	public void setContact(Contact contact){
208 210
		this.contact = contact;
209 211
	}
210 212

  
211 213
	
214
	/**
215
	 * Returns the string representing the prefix (for instance "Prof.&nbsp;Dr.<!-- -->")
216
	 * to this person's name.
217
	 */
212 218
	public String getPrefix(){
213 219
		return this.prefix;
214 220
	}
215
	/** 
216
	 * Assigns a prefix (for instance "Prof.&nbsp;Dr.<!-- -->") to this person's name.
217
	 *
218
	 * @param  prefix  the string which should be assigned as a prefix to this person's name
221
	/**
222
	 * @see  #getPrefix()
219 223
	 */
220 224
	public void setPrefix(String prefix){
221 225
		this.prefix = prefix;
222 226
	}
223 227

  
224 228

  
225
	public String getFirstname(){
226
		return this.firstname;
227
	}
228
	/** 
229
	 * Assigns a given name or forename (for instance "John") to this person. 
229
	/**
230
	 * Returns the string representing the given name or forename
231
	 * (for instance "John") of this person. 
230 232
	 * This is the part of his name which is not shared with other
231 233
	 * family members. Actually it may be just initials (for instance "G. Jr."),
232 234
	 * all forenames in full or a combination of expanded names and initials. 
233
	 *
234
	 * @param  firstname  the string which should be assigned as a given name to this person
235
	 */
236
	public String getFirstname(){
237
		return this.firstname;
238
	}
239
	/**
240
	 * @see  #getFirstname()
235 241
	 */
236 242
	public void setFirstname(String firstname){
237 243
		this.firstname = firstname;
238 244
	}
239 245

  
240 246
	
247
	/**
248
	 * Returns the string representing the hereditary name (surname or family name)
249
	 * (for instance "Smith") of this person. 
250
	 * This is the part of his name which is common to (all) other
251
	 * members of his family, as distinct from the given name or forename. 
252
	 */
241 253
	public String getLastname(){
242 254
		return this.lastname;
243 255
	}
244
	/** 
245
	 * Assigns a hereditary name (surname or family name)
246
	 * to this person (for instance "Smith").
247
	 * This is the part of his name which is common to (all) other
248
	 * members of his family, as distinct from the given name or forename. 
249
	 *
250
	 * @param  lastname  the string which should be assigned as a hereditary name to this person
256
	/**
257
	 * @see  #getLastname()
251 258
	 */
252 259
	public void setLastname(String lastname){
253 260
		this.lastname = lastname;
254 261
	}
255 262

  
256 263

  
264
	/**
265
	 * Returns the string representing the suffix (for instance "Junior")
266
	 * of this person's name.
267
	 */
257 268
	public String getSuffix(){
258 269
		return this.suffix;
259 270
	}
260
	/** 
261
	 * Assigns a suffix (for instance "Junior") to this person's name.
262
	 *
263
	 * @param  suffix  the string which should be assigned as a suffix to this person's name
271
	/**
272
	 * @see  #getSuffix()
264 273
	 */
265 274
	public void setSuffix(String suffix){
266 275
		this.suffix = suffix;
267 276
	}
268 277

  
269 278

  
279
	/** 
280
	 * Returns the {@link common.TimePeriod period of time}
281
	 * in which this person was alive (life span).
282
	 * The general form is birth date - death date
283
	 * (XXXX - YYYY; XXXX - or - YYYY as appropriate),
284
	 * but a simple flourished date (fl. XXXX) is also possible
285
	 * if that is all what is known.
286
	 *
287
	 * @see 	common.TimePeriod
288
	 */
270 289
	public TimePeriod getLifespan(){
271 290
		return this.lifespan;
272 291
	}
273 292
	/**
274
	 * Assigns to this person a period of time in which he was alive.
275
	 * The form birth date - death date (XXXX - YYYY; XXXX - or - YYYY as appropriate) is
276
	 * preferred, but a simple flourished date (fl. XXXX) may be given
277
	 * if that is all what is known.
278
	 *
279
	 * @param lifespan  the time period to be assigned as life time to this person
280
	 * @see             common.TimePeriod
293
	 * @see  #getLifespan()
281 294
	 */
282 295
	public void setLifespan(TimePeriod lifespan){
283 296
		this.lifespan = lifespan;

Also available in: Unified diff