A B C D E G I L M N O P R S T U V W

A

acronym - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

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

addAttribute(String, IbisAttribute, int, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Add an attribute to an institution.

addAttribute(String, String, IbisAttribute, int, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Add an attribute to a person.

addGroup(IbisGroup) - Method in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

Add a group to the list of groups, creating it if necessary

addInstitution(IbisInstitution) - Method in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

Add an institution to the list of institutions, creating it if necessary

addPerson(IbisPerson) - Method in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

Add a person to the list of people, creating it if necessary

addresses - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

A list of the contact row's addresses.

allAttributeSchemes() - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Return a list of all the institution attribute schemes available.

allAttributeSchemes() - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Return a list of all the person attribute schemes available.

allGroups(boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Return a list of all groups.

allInsts(boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Return a list of all institutions.

allPeople(boolean, String, int, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Return a list of all people (in batches).

attribute - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The person or institution attribute returned by methods that return a single attribute.

attributes - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the institution's attributes.

attributes - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A list of the person's attributes.

attributes - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The list of attributes returned by methods that return lists of person/institution attributes.

attributeSchemes - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The list of attribute schemes returned by methods that return lists of person/institution attribute schemes.

attrid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

The unique internal identifier of the attribute.

B

binaryData - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

The binary data held in the attribute (e.g., a JPEG photo).

bold - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

Flag indicating if the contact row's text is normally displayed in bold.

C

cancelled - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

Flag indicating if the group is cancelled.

cancelled - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

Flag indicating if the institution is cancelled.

cancelled - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

Flag indicating if the person is cancelled.

childInsts - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the institution's child institutions.

ClientConnection - Interface in uk.ac.cam.ucs.ibis.client

Interface representing a connection to the Lookup/Ibis server, capable of invoking methods on the web service API and unmarshalling the results.

ClientConnection.Method - Enum in uk.ac.cam.ucs.ibis.client

Enumeration of supported HTTP methods.

code - Variable in class uk.ac.cam.ucs.ibis.dto.IbisError

A short textual description of the error status code.

comment - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

Any comment associated with the attribute.

comment - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactPhoneNumber

Any comment associated with the phone number.

contactRows - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the institution's contact rows.

createConnection() - Static method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

Create a ClientConnection to the Lookup/Ibis web service API at https://www.lookup.cam.ac.uk/.

createGroup(String, String, String, String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Create a group owned by an institution.

createLocalConnection() - Static method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

Create a ClientConnection to a Lookup/Ibis web service API running locally on https://localhost:8443/ibis/.

createTestConnection() - Static method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

Create a ClientConnection to the Lookup/Ibis test web service API at https://lookup-test.srv.uis.cam.ac.uk/.

D

dataType - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

The attribute scheme's datatype.

deleteAttribute(String, Long, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Delete an attribute of an institution.

deleteAttribute(String, String, Long, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Delete an attribute of a person.

description - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

The contact row's text.

description - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

The more detailed description of the group.

details - Variable in class uk.ac.cam.ucs.ibis.dto.IbisError

The full details of the error (e.g., a Java stack trace).

directGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A list of all the groups that the person directly belongs to.

directMembers - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the group's direct members, not including any members included via groups included by this group.

displayName - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

The display name for labelling attributes in this scheme.

displayName - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

The person's display name (if visible).

E

effectiveFrom - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

For time-limited attributes, the date from which it takes effect.

effectiveTo - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

For time-limited attributes, the date after which it is no longer effective.

email - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

The group's email address.

emails - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

A list of the contact row's email addresses.

encodedString() - Method in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method.

entities - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

In the flattened XML/JSON representation, all the unique entities returned by the method.

Entities() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

error - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

If the method failed, details of the error.

G

getAttribute(String, Long) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get a specific attribute of an institution.

getAttribute(String, String, Long) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get a specific attribute of a person.

getAttributes(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get one or more (possibly multi-valued) attributes of an institution.

getAttributes(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get one or more (possibly multi-valued) attributes of a person.

getCancelledMembers(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get all the cancelled members of the specified group, including cancelled members of groups included by the group, and groups included by those groups, and so on.

getCancelledMembers(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get all the cancelled members of the specified institution.

getContactRows(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get all the contact rows of the specified institution.

getDirectMembers(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get the direct members of the specified group, not including members included via groups included by the group.

getError() - Method in exception uk.ac.cam.ucs.ibis.client.IbisException

Returns the underlying error from the server.

getGroup(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get the group with the specified ID or name.

getGroups(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get all the groups to which the specified person belongs, including indirect group memberships, via groups that include other groups.

getInst(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get the institution with the specified ID.

getInsts(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get all the institutions to which the specified person belongs.

getLastTransactionId() - Method in class uk.ac.cam.ucs.ibis.methods.IbisMethods

Get the ID of the last (most recent) transaction.

getManagedGroups(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get all the groups that the specified person has persmission to edit.

getManagedInsts(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get all the institutions that the specified person has permission to edit.

getMembers(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get all the members of the specified group, including members of groups included by the group, and groups included by those groups, and so on.

getMembers(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get all the members of the specified institution.

getPerson(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get the person with the specified identifier.

getToken(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get a signed JSON Web Token (JWT) with the group as subject and specified audience, only if authorized user/group has permission to edit the group.

getVersion() - Method in class uk.ac.cam.ucs.ibis.methods.IbisMethods

Get the current API version number.

group - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The group returned by methods that return a single group.

groupid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

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

GroupMethods - Class in uk.ac.cam.ucs.ibis.methods

Methods for querying and manipulating groups.

GroupMethods(ClientConnection) - Constructor for class uk.ac.cam.ucs.ibis.methods.GroupMethods

Create a new GroupMethods object.

groups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of all the groups that belong to the institution.

groups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups.

groups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

A list of all the unique groups returned by the method.

groups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The list of groups returned by methods that may return multiple groups.

I

IbisAttribute - Class in uk.ac.cam.ucs.ibis.dto

Class representing an attribute of a person or institution returned by the web service API.

IbisAttribute() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisAttribute

IbisAttributeScheme - Class in uk.ac.cam.ucs.ibis.dto

Class representing an attribute scheme.

IbisAttributeScheme() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

IbisClientConnection - Class in uk.ac.cam.ucs.ibis.client

Default implementation of the ClientConnection interface, to allow methods in the Lookup/Ibis web service API to be invoked.

IbisClientConnection(String, boolean) - Constructor for class uk.ac.cam.ucs.ibis.client.IbisClientConnection

Create a new ClientConnection using the specified URL base, which should be something like "https://www.lookup.cam.ac.uk/".

IbisContactPhoneNumber - Class in uk.ac.cam.ucs.ibis.dto

Class representing a phone number held on an institution contact row, for use by the web service API.

IbisContactPhoneNumber() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisContactPhoneNumber

IbisContactRow - Class in uk.ac.cam.ucs.ibis.dto

Class representing an institution contact row, for use by the web services API.

IbisContactRow() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisContactRow

IbisContactWebPage - Class in uk.ac.cam.ucs.ibis.dto

Class representing a web page referred to by an institution contact row, for use by the web service API.

IbisContactWebPage() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisContactWebPage

IbisError - Class in uk.ac.cam.ucs.ibis.dto

Class representing an error returned by the web service API.

IbisError() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisError

IbisException - Exception in uk.ac.cam.ucs.ibis.client

Exception thrown when a web service API method fails.

IbisException(IbisError) - Constructor for exception uk.ac.cam.ucs.ibis.client.IbisException

Construct a new IbisException wrapping the specified IbisError.

IbisGroup - Class in uk.ac.cam.ucs.ibis.dto

Class representing a group returned by the web service API.

IbisGroup() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisGroup

IbisIdentifier - Class in uk.ac.cam.ucs.ibis.dto

Class representing a person's identifier, for use by the web service API.

IbisIdentifier() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisIdentifier

IbisInstitution - Class in uk.ac.cam.ucs.ibis.dto

Class representing an institution returned by the web service API.

IbisInstitution() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisInstitution

IbisMethods - Class in uk.ac.cam.ucs.ibis.methods

Common methods for searching for objects in the Lookup/Ibis database.

IbisMethods(ClientConnection) - Constructor for class uk.ac.cam.ucs.ibis.methods.IbisMethods

Create a new IbisMethods object.

IbisPerson - Class in uk.ac.cam.ucs.ibis.dto

Class representing a person returned by the web service API.

IbisPerson() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisPerson

IbisResult - Class in uk.ac.cam.ucs.ibis.dto

Class representing the top-level container for all XML and JSON results.

IbisResult() - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisResult

No-arg constructor required by JAXB

IbisResult(String) - Constructor for class uk.ac.cam.ucs.ibis.dto.IbisResult

More useful constructor, for purely textual results

IbisResult.Entities - Class in uk.ac.cam.ucs.ibis.dto

Nested class to hold the full details of all the entities returned in a result.

id - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

An ID that can uniquely identify this group within the returned XML/JSON document.

id() - Method in class uk.ac.cam.ucs.ibis.dto.IbisGroup

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

id - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

An ID that can uniquely identify this institution within the returned XML/JSON document.

id() - Method in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

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

id - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

An ID that can uniquely identify this person within the returned XML/JSON document.

id() - Method in class uk.ac.cam.ucs.ibis.dto.IbisPerson

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

identifier - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

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

identifier - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The identifier returned by methods that return a single identifier.

identifiers - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A list of the person's identifiers.

includedByGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups that directly include this group.

includesGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups directly included in this group.

instid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

For a person attribute, the optional institution that the attribute is associated with.

instid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

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

institution - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The institution returned by methods that return a single institution.

InstitutionMethods - Class in uk.ac.cam.ucs.ibis.methods

Methods for querying and manipulating institutions.

InstitutionMethods(ClientConnection) - Constructor for class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Create a new InstitutionMethods object.

institutions - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A list of all the institution's to which the person belongs.

institutions - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

A list of all the unique institutions returned by the method.

institutions - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The list of institutions returned by methods that may return multiple institutions.

invokeMethod(String, String[], Object[]) - Method in interface uk.ac.cam.ucs.ibis.client.ClientConnection

Invoke a web service GET method.

invokeMethod(ClientConnection.Method, String, String[], Object[], Object[]) - Method in interface uk.ac.cam.ucs.ibis.client.ClientConnection

Invoke a web service GET, POST, PUT or DELETE method.

invokeMethod(String, String[], Object[]) - Method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

invokeMethod(ClientConnection.Method, String, String[], Object[], Object[]) - Method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

isMemberOfGroup(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Test if the specified person is a member of the specified group.

isMemberOfInst(String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Test if the specified person is a member of the specified institution.

isStaff() - Method in class uk.ac.cam.ucs.ibis.dto.IbisPerson

Returns true if the person is a member of staff.

isStudent() - Method in class uk.ac.cam.ucs.ibis.dto.IbisPerson

Returns true if the person is a student.

italic - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

Flag indicating if the contact row's text is normally displayed in italics.

L

label - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactWebPage

The web page's label (link text) if set.

ldapName - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

The name of the attribute scheme in LDAP, if it is exported to LDAP.

listGroups(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Get the groups with the specified IDs or names.

listInsts(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Get the institutions with the specified IDs.

listPeople(String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Get the people with the specified identifiers (typically CRSids).

M

managedByGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups that manage this group.

managedByGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the groups that manage this institution.

managesGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups managed by this group.

managesInsts - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the institutions managed by this group.

members - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the group's members, including (recursively) any members of any included groups.

members - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the institution's members.

membersGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the groups that form the institution's membership.

membersOfInst - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

The details of the institution for which this group forms all or part of the membership.

message - Variable in class uk.ac.cam.ucs.ibis.dto.IbisError

A short textual description of the error message (typically one line).

misAffiliation - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

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

modifiedGroups(long, long, String, boolean, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Find all groups modified between the specified pair of transactions.

modifiedInsts(long, long, String, boolean, boolean, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Find all institutions modified between the specified pair of transactions.

modifiedPeople(long, long, String, boolean, boolean, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Find all people modified between the specified pair of transactions.

multiLined - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

Flag for textual attributes schemes indicating whether they are multi-lined.

multiValued - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

Flag indicating whether attributes in this scheme can be multi-valued.

N

name - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

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

name - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

The institution's name.

number - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactPhoneNumber

The phone number.

O

owningGroupid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

For a person attribute, the ID of the group that owns it (typically the user agent group that created it).

owningInsts - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the institutions to which this group belongs.

P

parentInsts - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A list of the institution's parent institutions.

people - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

A list of the people referred to by the contact row.

people - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult.Entities

A list of all the unique people returned by the method.

people - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The list of people returned by methods that may return multiple people.

person - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The person returned by methods that return a single person.

PersonMethods - Class in uk.ac.cam.ucs.ibis.methods

Methods for querying and manipulating people.

PersonMethods(ClientConnection) - Constructor for class uk.ac.cam.ucs.ibis.methods.PersonMethods

Create a new PersonMethods object.

phoneNumbers - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

A list of the contact row's phone numbers.

phoneType - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactPhoneNumber

The phone number's type.

precedence - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

The attribute scheme's precedence.

R

readByGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups that have privileged access to this group.

readsGroups - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A list of the groups that this group has privileged access to.

ref - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

A reference (by id) to a group element in the XML/JSON document.

ref() - Method in class uk.ac.cam.ucs.ibis.dto.IbisGroup

Return a new IbisGroup that refers to this group.

ref - Variable in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

A reference (by id) to an institution element in the XML/JSON document.

ref() - Method in class uk.ac.cam.ucs.ibis.dto.IbisInstitution

Return a new IbisInstitution that refers to this institution.

ref - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

A reference (by id) to a person element in the XML/JSON document.

ref() - Method in class uk.ac.cam.ucs.ibis.dto.IbisPerson

Return a new IbisPerson that refers to this person.

regexp - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

For textual attributes, an optional regular expression that all attributes in this scheme match.

registeredName - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

The person's registered name (if visible).

S

scheme - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

The attribute's scheme.

scheme - Variable in class uk.ac.cam.ucs.ibis.dto.IbisIdentifier

The identifier's scheme (e.g., "crsid").

schemeid - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

The unique identifier of the attribute scheme.

search(String, boolean, boolean, int, int, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Search for groups using a free text query string.

search(String, boolean, boolean, String, int, int, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Search for institutions using a free text query string.

search(String, boolean, boolean, String, String, int, int, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Search for people using a free text query string.

searchable - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttributeScheme

Flag indicating whether attributes of this scheme are searched by the default search functionality.

searchCount(String, boolean, boolean) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Count the number of groups that would be returned by a search using a free text query string.

searchCount(String, boolean, boolean, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Count the number of institutions that would be returned by a search using a free text query string.

searchCount(String, boolean, boolean, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Count the number of people that would be returned by a search using a free text query string.

setPassword(String) - Method in interface uk.ac.cam.ucs.ibis.client.ClientConnection

Set the password to use when connecting to the Lookup/Ibis web service.

setPassword(String) - Method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

setUsername(String) - Method in interface uk.ac.cam.ucs.ibis.client.ClientConnection

Set the username to use when connecting to the Lookup/Ibis web service.

setUsername(String) - Method in class uk.ac.cam.ucs.ibis.client.IbisClientConnection

status - Variable in class uk.ac.cam.ucs.ibis.dto.IbisError

The HTTP error status code.

StringList - Class in uk.ac.cam.ucs.ibis.client

Utility class to hold a list of strings and convert them to a comma-separated string, as required by various web service API methods.

StringList(int) - Constructor for class uk.ac.cam.ucs.ibis.client.StringList

Constructs an empty string list with the specified initial capacity.

StringList() - Constructor for class uk.ac.cam.ucs.ibis.client.StringList

Constructs an empty string list with an initial capacity of ten.

StringList(Collection<String>) - Constructor for class uk.ac.cam.ucs.ibis.client.StringList

Constructs a string list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

StringList(String...) - Constructor for class uk.ac.cam.ucs.ibis.client.StringList

Constructs a string list from the specified strings.

surname - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

The person's surname (if visible).

T

title - Variable in class uk.ac.cam.ucs.ibis.dto.IbisGroup

The group's title.

toString() - Method in class uk.ac.cam.ucs.ibis.client.StringList

Represents the string list as a comma-separated string, suitable for use as a parameter in various web service API methods.

toString() - Method in class uk.ac.cam.ucs.ibis.dto.IbisIdentifier

toString() - Method in class uk.ac.cam.ucs.ibis.dto.IbisResult

U

uk.ac.cam.ucs.ibis.client - package uk.ac.cam.ucs.ibis.client

Provides the support classes necessary to connect to the Lookup/Ibis web service and invoke API methods.

uk.ac.cam.ucs.ibis.dto - package uk.ac.cam.ucs.ibis.dto

Provides DTO classes for transferring data from the server to client in the web service API.

uk.ac.cam.ucs.ibis.methods - package uk.ac.cam.ucs.ibis.methods

Contains auto-generated classes which contain all the available methods in the Lookup/Ibis web service API.

unflatten() - Method in class uk.ac.cam.ucs.ibis.dto.IbisResult

Unflatten this IbisResult object, resolving any internal ID refs to build a fully fledged object tree.

updateAttribute(String, Long, IbisAttribute, String) - Method in class uk.ac.cam.ucs.ibis.methods.InstitutionMethods

Update an attribute of an institution.

updateAttribute(String, String, Long, IbisAttribute, String) - Method in class uk.ac.cam.ucs.ibis.methods.PersonMethods

Update an attribute of a person.

updateDirectMembers(String, String, String, String) - Method in class uk.ac.cam.ucs.ibis.methods.GroupMethods

Update the list of people who are direct members of the group.

url - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactWebPage

The web page's URL.

V

value - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

The attribute's value (except for binary attributes).

value - Variable in class uk.ac.cam.ucs.ibis.dto.IbisIdentifier

The identifier's value in that scheme (e.g., a specific CRSid value).

value - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The value returned by methods that return a simple textual value.

valueOf(String) - Static method in enum uk.ac.cam.ucs.ibis.client.ClientConnection.Method

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

Create an IbisAttribute from its ASCII encoded string representation.

values() - Static method in enum uk.ac.cam.ucs.ibis.client.ClientConnection.Method

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in class uk.ac.cam.ucs.ibis.dto.IbisResult

The web service API version number.

visibility - Variable in class uk.ac.cam.ucs.ibis.dto.IbisAttribute

For a person attribute, it's visibility ("private", "institution", "university" or "world").

visibleName - Variable in class uk.ac.cam.ucs.ibis.dto.IbisPerson

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.

W

webPages - Variable in class uk.ac.cam.ucs.ibis.dto.IbisContactRow

A list of the contact row's web pages.

A B C D E G I L M N O P R S T U V W