org.phenotips.data.permissions.rest

Interface VisibilityResource

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

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

Since:

1.3M2

Version:

$Id: 2a1d3ef427129457f7af73a91d5604794948ce79 $

Method Summary

Modifier and Type	Method and Description
VisibilityRepresentation	getVisibility(String entityId, String entityType) Retrieve the Visibility of an entity identified by `entityId`.
javax.ws.rs.core.Response	setVisibility(String entityId, String entityType) Update the visibility of an entity.
javax.ws.rs.core.Response	setVisibility(VisibilityRepresentation visibility, String entityId, String entityType) Update the visibility of an entity.

Method Detail

getVisibility

VisibilityRepresentation getVisibility(String entityId,
                                       String entityType)

Retrieve the Visibility of an entity identified by `entityId`. 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 - identifier of the entity whose visibility to retrieve

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

Returns:

a representation of the visibility of the entity

setVisibility

javax.ws.rs.core.Response setVisibility(VisibilityRepresentation visibility,
                                        String entityId,
                                        String entityType)

Update the visibility of an entity. 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:

visibility - which must contain "level" parameter, with a valid visibility level name as the value

entityId - identifier of the entity whose visibility should be changed

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

Returns:

a status message

setVisibility

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

Update the visibility of an entity. 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 a "visibility" parameter, with a valid visibility level name as the value.

Parameters:

entityId - identifier of the entity whose visibility should be changed

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

Returns:

a status message