org.phenotips.data.permissions.rest

Interface DomainObjectFactory

@Unstable
 @Role
public interface DomainObjectFactory

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

Since:

1.3M2

Version:

$Id: c8adde82a0b6c7063a0d795bb113b190de691fed $

Method Summary

Modifier and Type	Method and Description
CollaboratorRepresentation	createCollaboratorRepresentation(Collaborator collaborator) Create the REST representation for summary of a Collaborator instance, starting from a PrimaryEntity and Collaborator instances.
CollaboratorsRepresentation	createCollaboratorsRepresentation(PrimaryEntity entity, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a list of Collaborators, starting from a PrimaryEntity instance.
OwnerRepresentation	createOwnerRepresentation(PrimaryEntity entity) Create the REST representation for a Owner's summary, starting from a PrimaryEntity instance.
PrincipalsRepresentation	createPrincipalsRepresentation(PrimaryEntity entity, String entityType, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a list of principals that have access to the PrimaryEntity.
VisibilityRepresentation	createVisibilityRepresentation(PrimaryEntity entity) Create the REST representation for a Visibility's summary, starting from a PrimaryEntity instance.
VisibilityRepresentation	createVisibilityRepresentation(Visibility visibility) Create the REST representation for a Visibility's summary, starting from a Visibility instance.

Method Detail

createOwnerRepresentation

OwnerRepresentation createOwnerRepresentation(PrimaryEntity entity)

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

Parameters:

entity - the owner of this entity will be serialized

Returns:

a summary of the entity record's owner, or null if the current user doesn't have access to the entity or accessing the entity data fails

createVisibilityRepresentation

VisibilityRepresentation createVisibilityRepresentation(PrimaryEntity entity)

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

Parameters:

entity - whose visibility is of interest

Returns:

a summary of the entity record's visibility, or null if the current user doesn't have access to the entity or accessing the entity data fails

createVisibilityRepresentation

VisibilityRepresentation createVisibilityRepresentation(Visibility visibility)

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

Parameters:

visibility - of interest

Returns:

a summary of the visibility, or null if the visibility is null

createCollaboratorsRepresentation

CollaboratorsRepresentation createCollaboratorsRepresentation(PrimaryEntity entity,
                                                              javax.ws.rs.core.UriInfo uriInfo)

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

Parameters:

entity - to whom the the (list of) collaborators that are attached

uriInfo - the URI information for the rest system and the current request

Returns:

a summary of each collaborator on the entity record, or null if the current user doesn't have access to the entity or accessing the entity data fails.

createCollaboratorRepresentation

CollaboratorRepresentation createCollaboratorRepresentation(Collaborator collaborator)

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

Parameters:

collaborator - that is to be represented

Returns:

a summary of the collaborator, or null if the current user doesn't have access to the entity or accessing the entity data fails.

createPrincipalsRepresentation

PrincipalsRepresentation createPrincipalsRepresentation(PrimaryEntity entity,
                                                        String entityType,
                                                        javax.ws.rs.core.UriInfo uriInfo)

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

Parameters:

entity - whose accessers are of interest

entityType - the type of entity

uriInfo - the URI information for the rest system and the current request

Returns:

a summary of each principal that has access to the patient record, or null if the current user doesn't have access to the patient or accessing the patient data fails.