uk.ac.cam.ucs.ibis.dto

Class IbisGroup

java.lang.Object

uk.ac.cam.ucs.ibis.dto.IbisGroup

public class IbisGroup
extends Object

Class representing a group returned by the web service API.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	cancelled Flag indicating if the group is cancelled.
String	description The more detailed description of the group.
List<IbisPerson>	directMembers A list of the group's direct members, not including any members included via groups included by this group.
String	email The group's email address.
String	groupid The group's numeric ID (actually a string e.g., "100656").
String	id An ID that can uniquely identify this group within the returned XML/JSON document.
List<IbisGroup>	includedByGroups A list of the groups that directly include this group.
List<IbisGroup>	includesGroups A list of the groups directly included in this group.
List<IbisGroup>	managedByGroups A list of the groups that manage this group.
List<IbisGroup>	managesGroups A list of the groups managed by this group.
List<IbisInstitution>	managesInsts A list of the institutions managed by this group.
List<IbisPerson>	members A list of the group's members, including (recursively) any members of any included groups.
IbisInstitution	membersOfInst The details of the institution for which this group forms all or part of the membership.
String	name The group's unique name (e.g., "cs-editors").
List<IbisInstitution>	owningInsts A list of the institutions to which this group belongs.
List<IbisGroup>	readByGroups A list of the groups that have privileged access to this group.
List<IbisGroup>	readsGroups A list of the groups that this group has privileged access to.
String	ref A reference (by id) to a group element in the XML/JSON document.
String	title The group's title.

Constructor Summary

Constructors

Constructor and Description
IbisGroup()

Method Summary

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

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

groupid

public String groupid

The group's numeric ID (actually a string e.g., "100656").

name

public String name

The group's unique name (e.g., "cs-editors").

title

public String title

The group's title.

description

public String description

The more detailed description of the group.

email

public String email

The group's email address.

membersOfInst

public IbisInstitution membersOfInst

The details of the institution for which this group forms all or part of the membership. This will only be set for groups that are membership groups of institutions if the fetch parameter includes the "members_of_inst" option.

members

public List<IbisPerson> members

A list of the group's members, including (recursively) any members of any included groups. This will only be populated if the fetch parameter includes the "all_members" option.

directMembers

public List<IbisPerson> directMembers

A list of the group's direct members, not including any members included via groups included by this group. This will only be populated if the fetch parameter includes the "direct_members" option.

owningInsts

public List<IbisInstitution> owningInsts

A list of the institutions to which this group belongs. This will only be populated if the fetch parameter includes the "owning_insts" option.

managesInsts

public List<IbisInstitution> managesInsts

A list of the institutions managed by this group. This will only be populated if the fetch parameter includes the "manages_insts" option.

managesGroups

public List<IbisGroup> managesGroups

A list of the groups managed by this group. This will only be populated if the fetch parameter includes the "manages_groups" option.

managedByGroups

public List<IbisGroup> managedByGroups

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

readsGroups

public List<IbisGroup> readsGroups

A list of the groups that this group has privileged access to. Members of this group will be able to read the members of any of those groups, regardless of the membership visibilities. This will only be populated if the fetch parameter includes the "reads_groups" option.

readByGroups

public List<IbisGroup> readByGroups

A list of the groups that have privileged access to this group. Members of those groups will be able to read the members of this group, regardless of the membership visibilities. This will only be populated if the fetch parameter includes the "read_by_groups" option.

includesGroups

public List<IbisGroup> includesGroups

A list of the groups directly included in this group. Any members of the included groups (and recursively any groups that they include) will automatically be included in this group. This will only be populated if the fetch parameter includes the "includes_groups" option.

includedByGroups

public List<IbisGroup> includedByGroups

A list of the groups that directly include this group. Any members of this group will automatically be included in those groups (and recursively in any groups that include those groups). This will only be populated if the fetch parameter includes the "included_by_groups" option.

id

public String id

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

Constructor Detail

IbisGroup

public IbisGroup()

Method Detail

id

public String id()

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

ref

public IbisGroup ref()

Return a new IbisGroup that refers to this group.