| Package | Description |
|---|---|
| uk.ac.cam.ucs.ibis.methods |
Contains auto-generated classes which contain all the available methods
in the Lookup/Ibis web service API.
|
| Modifier and Type | Method and Description |
|---|---|
IbisAttribute |
InstitutionMethods.addAttribute(String instid,
IbisAttribute attr,
int position,
boolean allowDuplicates,
String commitComment)
Add an attribute to an institution.
|
IbisAttribute |
PersonMethods.addAttribute(String scheme,
String identifier,
IbisAttribute attr,
int position,
boolean allowDuplicates,
String commitComment)
Add an attribute to a person.
|
List<IbisAttributeScheme> |
PersonMethods.allAttributeSchemes()
Return a list of all the person attribute schemes available.
|
List<IbisAttributeScheme> |
InstitutionMethods.allAttributeSchemes()
Return a list of all the institution attribute schemes available.
|
List<IbisGroup> |
GroupMethods.allGroups(boolean includeCancelled,
String fetch)
Return a list of all groups.
|
List<IbisInstitution> |
InstitutionMethods.allInsts(boolean includeCancelled,
String fetch)
Return a list of all institutions.
|
List<IbisPerson> |
PersonMethods.allPeople(boolean includeCancelled,
String identifier,
int limit,
String fetch)
Return a list of all people (in batches).
|
IbisGroup |
InstitutionMethods.createGroup(String instid,
String name,
String title,
String description,
String managedBy,
String commitComment)
Create a group owned by an institution.
|
boolean |
InstitutionMethods.deleteAttribute(String instid,
Long attrid,
String commitComment)
Delete an attribute of an institution.
|
boolean |
PersonMethods.deleteAttribute(String scheme,
String identifier,
Long attrid,
String commitComment)
Delete an attribute of a person.
|
IbisAttribute |
InstitutionMethods.getAttribute(String instid,
Long attrid)
Get a specific attribute of an institution.
|
IbisAttribute |
PersonMethods.getAttribute(String scheme,
String identifier,
Long attrid)
Get a specific attribute of a person.
|
List<IbisAttribute> |
InstitutionMethods.getAttributes(String instid,
String attrs)
Get one or more (possibly multi-valued) attributes of an institution.
|
List<IbisAttribute> |
PersonMethods.getAttributes(String scheme,
String identifier,
String attrs)
Get one or more (possibly multi-valued) attributes of a person.
|
List<IbisPerson> |
InstitutionMethods.getCancelledMembers(String instid,
String fetch)
Get all the cancelled members of the specified institution.
|
List<IbisPerson> |
GroupMethods.getCancelledMembers(String groupid,
String fetch)
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.
|
List<IbisContactRow> |
InstitutionMethods.getContactRows(String instid,
String fetch)
Get all the contact rows of the specified institution.
|
List<IbisPerson> |
GroupMethods.getDirectMembers(String groupid,
String fetch)
Get the direct members of the specified group, not including members
included via groups included by the group.
|
IbisGroup |
GroupMethods.getGroup(String groupid,
String fetch)
Get the group with the specified ID or name.
|
List<IbisGroup> |
PersonMethods.getGroups(String scheme,
String identifier,
String fetch)
Get all the groups to which the specified person belongs, including
indirect group memberships, via groups that include other groups.
|
IbisInstitution |
InstitutionMethods.getInst(String instid,
String fetch)
Get the institution with the specified ID.
|
List<IbisInstitution> |
PersonMethods.getInsts(String scheme,
String identifier,
String fetch)
Get all the institutions to which the specified person belongs.
|
long |
IbisMethods.getLastTransactionId()
Get the ID of the last (most recent) transaction.
|
List<IbisGroup> |
PersonMethods.getManagedGroups(String scheme,
String identifier,
String fetch)
Get all the groups that the specified person has persmission to edit.
|
List<IbisInstitution> |
PersonMethods.getManagedInsts(String scheme,
String identifier,
String fetch)
Get all the institutions that the specified person has permission to
edit.
|
List<IbisPerson> |
InstitutionMethods.getMembers(String instid,
String fetch)
Get all the members of the specified institution.
|
List<IbisPerson> |
GroupMethods.getMembers(String groupid,
String fetch)
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.
|
IbisPerson |
PersonMethods.getPerson(String scheme,
String identifier,
String fetch)
Get the person with the specified identifier.
|
String |
GroupMethods.getToken(String groupid,
String aud)
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.
|
String |
IbisMethods.getVersion()
Get the current API version number.
|
boolean |
PersonMethods.isMemberOfGroup(String scheme,
String identifier,
String groupid)
Test if the specified person is a member of the specified group.
|
boolean |
PersonMethods.isMemberOfInst(String scheme,
String identifier,
String instid)
Test if the specified person is a member of the specified institution.
|
List<IbisGroup> |
GroupMethods.listGroups(String groupids,
String fetch)
Get the groups with the specified IDs or names.
|
List<IbisInstitution> |
InstitutionMethods.listInsts(String instids,
String fetch)
Get the institutions with the specified IDs.
|
List<IbisPerson> |
PersonMethods.listPeople(String crsids,
String fetch)
Get the people with the specified identifiers (typically CRSids).
|
List<IbisGroup> |
GroupMethods.modifiedGroups(long minTxId,
long maxTxId,
String groupids,
boolean includeCancelled,
boolean membershipChanges,
String fetch)
Find all groups modified between the specified pair of transactions.
|
List<IbisInstitution> |
InstitutionMethods.modifiedInsts(long minTxId,
long maxTxId,
String instids,
boolean includeCancelled,
boolean contactRowChanges,
boolean membershipChanges,
String fetch)
Find all institutions modified between the specified pair of
transactions.
|
List<IbisPerson> |
PersonMethods.modifiedPeople(long minTxId,
long maxTxId,
String crsids,
boolean includeCancelled,
boolean membershipChanges,
boolean instNameChanges,
String fetch)
Find all people modified between the specified pair of transactions.
|
List<IbisGroup> |
GroupMethods.search(String query,
boolean approxMatches,
boolean includeCancelled,
int offset,
int limit,
String orderBy,
String fetch)
Search for groups using a free text query string.
|
List<IbisInstitution> |
InstitutionMethods.search(String query,
boolean approxMatches,
boolean includeCancelled,
String attributes,
int offset,
int limit,
String orderBy,
String fetch)
Search for institutions using a free text query string.
|
List<IbisPerson> |
PersonMethods.search(String query,
boolean approxMatches,
boolean includeCancelled,
String misStatus,
String attributes,
int offset,
int limit,
String orderBy,
String fetch)
Search for people using a free text query string.
|
int |
GroupMethods.searchCount(String query,
boolean approxMatches,
boolean includeCancelled)
Count the number of groups that would be returned by a search using
a free text query string.
|
int |
InstitutionMethods.searchCount(String query,
boolean approxMatches,
boolean includeCancelled,
String attributes)
Count the number of institutions that would be returned by a search
using a free text query string.
|
int |
PersonMethods.searchCount(String query,
boolean approxMatches,
boolean includeCancelled,
String misStatus,
String attributes)
Count the number of people that would be returned by a search using
a free text query string.
|
IbisAttribute |
InstitutionMethods.updateAttribute(String instid,
Long attrid,
IbisAttribute attr,
String commitComment)
Update an attribute of an institution.
|
IbisAttribute |
PersonMethods.updateAttribute(String scheme,
String identifier,
Long attrid,
IbisAttribute attr,
String commitComment)
Update an attribute of a person.
|
List<IbisPerson> |
GroupMethods.updateDirectMembers(String groupid,
String addIds,
String removeIds,
String commitComment)
Update the list of people who are direct members of the group.
|