uk.ac.cam.ucs.ibis.dto

Class IbisInstitution

java.lang.Object

uk.ac.cam.ucs.ibis.dto.IbisInstitution

public class IbisInstitution
extends Object

Class representing an institution returned by the web service API.

Field Summary

Fields

Modifier and Type	Field and Description
String	acronym The institution's acronym, if set (e.g., "UCS").
List<IbisAttribute>	attributes A list of the institution's attributes.
Boolean	cancelled Flag indicating if the institution is cancelled.
List<IbisInstitution>	childInsts A list of the institution's child institutions.
List<IbisContactRow>	contactRows A list of the institution's contact rows.
List<IbisGroup>	groups A list of all the groups that belong to the institution.
String	id An ID that can uniquely identify this institution within the returned XML/JSON document.
String	instid The institution's unique ID (e.g., "CS").
List<IbisGroup>	managedByGroups A list of the groups that manage this institution.
List<IbisPerson>	members A list of the institution's members.
List<IbisGroup>	membersGroups A list of the groups that form the institution's membership.
String	name The institution's name.
List<IbisInstitution>	parentInsts A list of the institution's parent institutions.
String	ref A reference (by id) to an institution element in the XML/JSON document.

Constructor Summary

Constructors

Constructor and Description
IbisInstitution()

Method Summary

Modifier and Type	Method and Description
String	id() Compute an ID that can uniquely identify this entity in XML/JSON.
IbisInstitution	ref() Return a new IbisInstitution that refers to this institution.

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 institution is cancelled.

instid

public String instid

The institution's unique ID (e.g., "CS").

name

public String name

The institution's name.

acronym

public String acronym

The institution's acronym, if set (e.g., "UCS").

attributes

public List<IbisAttribute> attributes

A list of the institution'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 "address", or the special pseudo-attribute scheme "phone_numbers".

contactRows

public List<IbisContactRow> contactRows

A list of the institution's contact rows. This will only be populated if the fetch parameter includes the "contact_rows" option.

members

public List<IbisPerson> members

A list of the institution's members. This will only be populated if the fetch parameter includes the "all_members" option.

parentInsts

public List<IbisInstitution> parentInsts

A list of the institution's parent institutions. This will only be populated if the fetch parameter includes the "parent_insts" option.

NOTE: Currently all institutions have one parent, but in the future institutions may have multiple parents.

childInsts

public List<IbisInstitution> childInsts

A list of the institution's child institutions. This will only be populated if the fetch parameter includes the "child_insts" option.

groups

public List<IbisGroup> groups

A list of all the groups that belong to the institution. This will only be populated if the fetch parameter includes the "inst_groups" option.

membersGroups

public List<IbisGroup> membersGroups

A list of the groups that form the institution's membership. This will only be populated if the fetch parameter includes the "members_groups" option.

managedByGroups

public List<IbisGroup> managedByGroups

A list of the groups that manage this institution. This will only be populated if the fetch parameter includes the "managed_by_groups" option.

id

public String id

An ID that can uniquely identify this institution 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 an institution element in the XML/JSON document. This is only used in the flattened XML/JSON representation (if the "flatten" parameter is specified).

Constructor Detail

IbisInstitution

public IbisInstitution()

Method Detail

id

public String id()

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

ref

public IbisInstitution ref()

Return a new IbisInstitution that refers to this institution.