uk.ac.cam.ucs.ibis.dto

Class IbisPerson

java.lang.Object

uk.ac.cam.ucs.ibis.dto.IbisPerson

public class IbisPerson
extends Object

Class representing a person returned by the web service API. Note that the identifier is the person's primary identifier (typically their CRSid), regardless of which identifier was used to query for the person.

Field Summary

Fields

Modifier and Type	Field and Description
List<IbisAttribute>	attributes A list of the person's attributes.
Boolean	cancelled Flag indicating if the person is cancelled.
List<IbisGroup>	directGroups A list of all the groups that the person directly belongs to.
String	displayName The person's display name (if visible).
List<IbisGroup>	groups A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups.
String	id An ID that can uniquely identify this person within the returned XML/JSON document.
IbisIdentifier	identifier The person's primary identifier (typically their CRSid).
List<IbisIdentifier>	identifiers A list of the person's identifiers.
List<IbisInstitution>	institutions A list of all the institution's to which the person belongs.
String	misAffiliation The person's MIS status ("staff", "student", "staff,student" or "").
String	ref A reference (by id) to a person element in the XML/JSON document.
String	registeredName The person's registered name (if visible).
String	surname The person's surname (if visible).
String	visibleName The person's display name if that is visible, otherwise their registered name if that is visible, otherwise their surname if that is visible, otherwise the value of their primary identifier (typically their CRSid) which is always visible.

Constructor Summary

Constructors

Constructor and Description
IbisPerson()

Method Summary

Modifier and Type	Method and Description
String	id() Compute an ID that can uniquely identify this entity in XML/JSON.
boolean	isStaff() Returns true if the person is a member of staff.
boolean	isStudent() Returns true if the person is a student.
IbisPerson	ref() Return a new IbisPerson that refers to this person.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cancelled

public Boolean cancelled

Flag indicating if the person is cancelled.

identifier

public IbisIdentifier identifier

The person's primary identifier (typically their CRSid).

displayName

public String displayName

The person's display name (if visible).

registeredName

public String registeredName

The person's registered name (if visible).

surname

public String surname

The person's surname (if visible).

visibleName

public String visibleName

The person's display name if that is visible, otherwise their registered name if that is visible, otherwise their surname if that is visible, otherwise the value of their primary identifier (typically their CRSid) which is always visible.

misAffiliation

public String misAffiliation

The person's MIS status ("staff", "student", "staff,student" or "").

identifiers

public List<IbisIdentifier> identifiers

A list of the person's identifiers. This will only be populated if the fetch parameter included the "all_identifiers" option.

attributes

public List<IbisAttribute> attributes

A list of the person's attributes. This will only be populated if the fetch parameter includes the "all_attrs" option, or any specific attribute schemes such as "email" or "title", or the special pseudo-attribute scheme "phone_numbers".

institutions

public List<IbisInstitution> institutions

A list of all the institution's to which the person belongs. This will only be populated if the fetch parameter includes the "all_insts" option.

groups

public List<IbisGroup> groups

A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups. This will only be populated if the fetch parameter includes the "all_groups" option.

directGroups

public List<IbisGroup> directGroups

A list of all the groups that the person directly belongs to. This does not include indirect group memberships - i.e., groups that include these groups. This will only be populated if the fetch parameter includes the "direct_groups" option.

id

public String id

An ID that can uniquely identify this person within the returned XML/JSON document. This is only used in the flattened XML/JSON representation (if the "flatten" parameter is specified).

ref

public String ref

A reference (by id) to a person element in the XML/JSON document. This is only used in the flattened XML/JSON representation (if the "flatten" parameter is specified).

Constructor Detail

IbisPerson

public IbisPerson()

Method Detail

isStaff

public boolean isStaff()

Returns true if the person is a member of staff.

Note that this tests for an misAffiliation of "", "staff" or "staff,student" since some members of staff will have a blank misAffiliation.

isStudent

public boolean isStudent()

Returns true if the person is a student.

This tests for an misAffiliation of "student" or "staff,student".

id

public String id()

Compute an ID that can uniquely identify this entity in XML/JSON.

ref

public IbisPerson ref()

Return a new IbisPerson that refers to this person.