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

A

addCollaborators(CollaboratorsRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorsResource

Add new collaborators, or update the permission levels of existing collaborators.

addCollaborators(String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorsResource

Add new collaborators, or update the permission levels of existing collaborators.

C

CollaboratorRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for CollaboratorRepresentation complex type.

CollaboratorRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

CollaboratorResource - Interface in org.phenotips.data.permissions.rest

Resource for working with entity record collaborators, one at a time.

collaborators - Variable in class org.phenotips.data.permissions.rest.model.CollaboratorsRepresentation

collaborators - Variable in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

CollaboratorsRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for CollaboratorsCollection complex type.

CollaboratorsRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.CollaboratorsRepresentation

CollaboratorsResource - Interface in org.phenotips.data.permissions.rest

Resource for working with entity record collaborators, in bulk, where entities are identified by entity record's internal PhenoTips identifier.

createCollaboratorRepresentation(Collaborator) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for summary of a Collaborator instance, starting from a PrimaryEntity and Collaborator instances.

createCollaboratorRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of CollaboratorRepresentation

createCollaboratorsRepresentation(PrimaryEntity, UriInfo) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for a list of Collaborators, starting from a PrimaryEntity instance.

createCollaboratorsRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of CollaboratorsRepresentation

createOwnerRepresentation(PrimaryEntity) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for a Owner's summary, starting from a PrimaryEntity instance.

createOwnerRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of OwnerRepresentation

createPermissionsRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of PermissionsRepresentation

createPrincipalRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of PrincipalRepresentation

createPrincipalsRepresentation(PrimaryEntity, String, UriInfo) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for a list of principals that have access to the PrimaryEntity.

createPrincipalsRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of PrincipalsRepresentation

createUserSummary() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of UserSummary

createVisibilityOptionsRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of VisibilityOptionsRepresentation

createVisibilityRepresentation(PrimaryEntity) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for a Visibility's summary, starting from a PrimaryEntity instance.

createVisibilityRepresentation(Visibility) - Method in interface org.phenotips.data.permissions.rest.DomainObjectFactory

Create the REST representation for a Visibility's summary, starting from a Visibility instance.

createVisibilityRepresentation() - Method in class org.phenotips.data.permissions.rest.model.ObjectFactory

Create an instance of VisibilityRepresentation

D

deleteAllCollaborators(String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorsResource

Delete all collaborators.

deleteCollaborator(String, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorResource

Remove a particular collaborator from an entity record.

description - Variable in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

DomainObjectFactory - Interface in org.phenotips.data.permissions.rest

Factory class for generating REST representations of various types of entities, used within the permissions module.

E

email - Variable in class org.phenotips.data.permissions.rest.model.UserSummary

G

getCollaborator(String, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorResource

Retrieve information about a particular collaborator.

getCollaborators(String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorsResource

Retrieve information about the collaborators.

getCollaborators() - Method in class org.phenotips.data.permissions.rest.model.CollaboratorsRepresentation

Gets the value of the collaborators property.

getCollaborators() - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Gets the value of the collaborators property.

getDescription() - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Gets the value of the description property.

getEmail() - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Gets the value of the email property.

getGroup() - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Gets the value of the group property.

getId() - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Gets the value of the id property.

getLabel() - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Gets the value of the label property.

getLevel() - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

Gets the value of the level property.

getLevel() - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Gets the value of the level property.

getName() - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Gets the value of the name property.

getOwner() - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Gets the value of the owner property.

getOwner(String, String) - Method in interface org.phenotips.data.permissions.rest.OwnerResource

Retrieves the owner of an entity record - which is found by the passed in entity identifier - if the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to view the target entity record, an error is returned.

getPermissions(String, String) - Method in interface org.phenotips.data.permissions.rest.PermissionsResource

Retrieves all permissions: owner, collaborators, visibility.

getPrincipals() - Method in class org.phenotips.data.permissions.rest.model.PrincipalsRepresentation

Gets the value of the principals property.

getPrincipals(String, String) - Method in interface org.phenotips.data.permissions.rest.PrincipalsResource

Retrieve information about users or groups that have any access to the entity record.

getRole() - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Gets the value of the role property.

getType() - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Gets the value of the type property.

getUrl() - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Gets the value of the url property.

getVisibilities() - Method in class org.phenotips.data.permissions.rest.model.VisibilityOptionsRepresentation

Gets the value of the visibilities property.

getVisibility() - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Gets the value of the visibility property.

getVisibility(String, String) - Method in interface org.phenotips.data.permissions.rest.VisibilityResource

Retrieve the Visibility of an entity identified by `entityId`.

getVisibilityOptions() - Method in interface org.phenotips.data.permissions.rest.VisibilityOptionsResource

The system has several predefined options of visibility levels.

group - Variable in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

I

id - Variable in class org.phenotips.data.permissions.rest.model.UserSummary

L

label - Variable in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

level - Variable in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

level - Variable in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

N

name - Variable in class org.phenotips.data.permissions.rest.model.UserSummary

O

ObjectFactory - Class in org.phenotips.data.permissions.rest.model

This object contains factory methods for each Java content interface and Java element interface generated in the org.phenotips.data.permissions.rest.model package.

ObjectFactory() - Constructor for class org.phenotips.data.permissions.rest.model.ObjectFactory

Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: org.phenotips.data.permissions.rest.model

org.phenotips.data.permissions.rest - package org.phenotips.data.permissions.rest

org.phenotips.data.permissions.rest.model - package org.phenotips.data.permissions.rest.model

owner - Variable in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

OwnerRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for OwnerSummary complex type.

OwnerRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.OwnerRepresentation

OwnerResource - Interface in org.phenotips.data.permissions.rest

Resource for working with entity record's owners, identified by entity record's internal PhenoTips identifier.

P

PermissionsRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for PermissionsSummary complex type.

PermissionsRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

PermissionsResource - Interface in org.phenotips.data.permissions.rest

Resource for working with entity record's owners, visibility and collaborators.

PrincipalRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for PrincipalSummary complex type.

PrincipalRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

principals - Variable in class org.phenotips.data.permissions.rest.model.PrincipalsRepresentation

PrincipalsRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for PrincipalsCollection complex type.

PrincipalsRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.PrincipalsRepresentation

PrincipalsResource - Interface in org.phenotips.data.permissions.rest

Resource for retrieving information about principals that have access to the entity record, in bulk, where entity is identified by entity record's internal PhenoTips identifier.

R

role - Variable in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

S

setCollaborators(CollaboratorsRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorsResource

Update all collaborators, replacing all previous collaborators.

setCollaborators(CollaboratorsRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Sets the value of the collaborators property.

setDescription(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Sets the value of the description property.

setEmail(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Sets the value of the email property.

setGroup(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Sets the value of the group property.

setId(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Sets the value of the id property.

setLabel(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Sets the value of the label property.

setLevel(CollaboratorRepresentation, String, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorResource

Update the access level of a collaborator.

setLevel(String, String, String) - Method in interface org.phenotips.data.permissions.rest.CollaboratorResource

Update the access level of a collaborator.

setLevel(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

Sets the value of the level property.

setLevel(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

Sets the value of the level property.

setName(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Sets the value of the name property.

setOwner(OwnerRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Sets the value of the owner property.

setOwner(OwnerRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.OwnerResource

Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON.

setOwner(String, String) - Method in interface org.phenotips.data.permissions.rest.OwnerResource

Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON.

setPermissions(PermissionsRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.PermissionsResource

Overwrites all permissions: owner, collaborators, visibility.

setRole(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Sets the value of the role property.

setType(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

Sets the value of the type property.

setUrl(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

Sets the value of the url property.

setVisibility(VisibilityRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

Sets the value of the visibility property.

setVisibility(VisibilityRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.VisibilityResource

Update the visibility of an entity.

setVisibility(String, String) - Method in interface org.phenotips.data.permissions.rest.VisibilityResource

Update the visibility of an entity.

T

type - Variable in class org.phenotips.data.permissions.rest.model.UserSummary

U

updatePermissions(PermissionsRepresentation, String, String) - Method in interface org.phenotips.data.permissions.rest.PermissionsResource

Update permissions: owner, collaborators, visibility.

url - Variable in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

UserSummary - Class in org.phenotips.data.permissions.rest.model

Java class for UserSummary complex type.

UserSummary() - Constructor for class org.phenotips.data.permissions.rest.model.UserSummary

V

visibilities - Variable in class org.phenotips.data.permissions.rest.model.VisibilityOptionsRepresentation

visibility - Variable in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

VisibilityOptionsRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for VisibilityOptions complex type.

VisibilityOptionsRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.VisibilityOptionsRepresentation

VisibilityOptionsResource - Interface in org.phenotips.data.permissions.rest

Resource for working with patient independent features of Visibility.

VisibilityRepresentation - Class in org.phenotips.data.permissions.rest.model

Java class for VisibilitySummary complex type.

VisibilityRepresentation() - Constructor for class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

VisibilityResource - Interface in org.phenotips.data.permissions.rest

Resource for working with visibility of entity records, where the entity record is identified by its internal identifier.

W

withCollaborators(CollaboratorRepresentation...) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorsRepresentation

withCollaborators(Collection<CollaboratorRepresentation>) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorsRepresentation

withCollaborators(CollaboratorsRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

withDescription(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

withEmail(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

withEmail(String) - Method in class org.phenotips.data.permissions.rest.model.OwnerRepresentation

withEmail(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withEmail(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

withGroup(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withId(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

withId(String) - Method in class org.phenotips.data.permissions.rest.model.OwnerRepresentation

withId(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withId(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

withLabel(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

withLevel(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

withLevel(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withLevel(String) - Method in class org.phenotips.data.permissions.rest.model.VisibilityRepresentation

withName(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

withName(String) - Method in class org.phenotips.data.permissions.rest.model.OwnerRepresentation

withName(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withName(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

withOwner(OwnerRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

withPrincipals(PrincipalRepresentation...) - Method in class org.phenotips.data.permissions.rest.model.PrincipalsRepresentation

withPrincipals(Collection<PrincipalRepresentation>) - Method in class org.phenotips.data.permissions.rest.model.PrincipalsRepresentation

withRole(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withType(String) - Method in class org.phenotips.data.permissions.rest.model.CollaboratorRepresentation

withType(String) - Method in class org.phenotips.data.permissions.rest.model.OwnerRepresentation

withType(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withType(String) - Method in class org.phenotips.data.permissions.rest.model.UserSummary

withUrl(String) - Method in class org.phenotips.data.permissions.rest.model.PrincipalRepresentation

withVisibilities(VisibilityRepresentation...) - Method in class org.phenotips.data.permissions.rest.model.VisibilityOptionsRepresentation

withVisibilities(Collection<VisibilityRepresentation>) - Method in class org.phenotips.data.permissions.rest.model.VisibilityOptionsRepresentation

withVisibility(VisibilityRepresentation) - Method in class org.phenotips.data.permissions.rest.model.PermissionsRepresentation

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