org.phenotips.data.permissions.rest

Interface OwnerResource

@Role
 @Relation(value="https://phenotips.org/rel/owner")
 @ParentResource(value=PermissionsResource.class)
 @RelatedResources(value=org.phenotips.data.rest.PatientResource.class)
public interface OwnerResource

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

Since:

1.3M2

Version:

$Id: 1fdf7da4aec6cee7629454d289b41b1858b9b61c $

Method Summary

Modifier and Type	Method and Description
OwnerRepresentation	getOwner(String entityId, String entityType) 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.
javax.ws.rs.core.Response	setOwner(OwnerRepresentation owner, String entityId, String entityType) Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON.
javax.ws.rs.core.Response	setOwner(String entityId, String entityType) Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON.

Method Detail

getOwner

OwnerRepresentation getOwner(String entityId,
                             String entityType)

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.

Parameters:

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

REST representation of an owner of an entity record

setOwner

javax.ws.rs.core.Response setOwner(OwnerRepresentation owner,
                                   String entityId,
                                   String entityType)

Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, no change is performed and an error is returned.

Parameters:

owner - an owner representation, only the id property is required, with a value of either a fully qualified username or a plain username (eg. xwiki:XWiki.username or username)

entityId - identifier of the entity whose owner should be changed

entityType - the type of entity (either "patients" or "families")

Returns:

a status message

setOwner

javax.ws.rs.core.Response setOwner(String entityId,
                                   String entityType)

Updates the owner of an entity record - identified by `entityId` - with the owner specified in JSON. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, no change is performed and an error is returned. The request must contain an "owner" field.

Parameters:

entityId - identifier of the entity, whose owner should be changed

entityType - the type of entity (either "patients" or "families")

Returns:

a status message