org.eurekaclinical.useragreement.service.resource

Class UserAgreementStatusResource

java.lang.Object

org.eurekaclinical.useragreement.service.resource.UserAgreementStatusResource

public class UserAgreementStatusResource
extends Object

RESTful end-point for UserAgreementStatusEntity related methods.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
UserAgreementStatusResource(UserAgreementStatusDao inUserAgreementStatusDao, UserAgreementDao inUserAgreementDao) Creates the user agreement REST endpoint.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(org.eurekaclinical.useragreement.client.comm.UserAgreementStatus inUserAgreement, javax.servlet.http.HttpServletRequest req) Creates a user agreement record for the current user.
List<org.eurekaclinical.useragreement.client.comm.UserAgreementStatus>	getAll() Get a list of all users in the system.
org.eurekaclinical.useragreement.client.comm.UserAgreementStatus	getById(Long inId, javax.servlet.http.HttpServletRequest req) Get a user by the user's identification number.
org.eurekaclinical.useragreement.client.comm.UserAgreementStatus	getMine(org.eurekaclinical.useragreement.client.comm.Status status, javax.servlet.http.HttpServletRequest req) Get the current user's identification number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserAgreementStatusResource

@Inject
public UserAgreementStatusResource(UserAgreementStatusDao inUserAgreementStatusDao,
                                           UserAgreementDao inUserAgreementDao)

Creates the user agreement REST endpoint.

Parameters:

inUserAgreementStatusDao - DAO used to access UserAgreementStatusEntity related functionality.

inUserAgreementDao - DAO used to access user agreements.

Method Detail

getAll

@RolesAllowed(value="admin")
public List<org.eurekaclinical.useragreement.client.comm.UserAgreementStatus> getAll()

Get a list of all users in the system.

Returns:

a list of UserAgreement objects.

getById

public org.eurekaclinical.useragreement.client.comm.UserAgreementStatus getById(Long inId,
                                                                                @Context
                                                                                javax.servlet.http.HttpServletRequest req)

Get a user by the user's identification number.

Parameters:

inId - the identification number for the user agreement record to fetch. Cannot be null.

req - the request object. Cannot be null.

Returns:

The user agreement record referenced by the identification number.

Throws:

org.eurekaclinical.standardapis.exception.HttpStatusException - with a 404 status code if there is no user agreement record with that identification number.

getMine

public org.eurekaclinical.useragreement.client.comm.UserAgreementStatus getMine(org.eurekaclinical.useragreement.client.comm.Status status,
                                                                                @Context
                                                                                javax.servlet.http.HttpServletRequest req)

Get the current user's identification number.

Parameters:

status - optional status filter query parameter, which if specified, will cause only a user agreement status with the specified status value to be returned.

req - the request object. Cannot be null.

Returns:

The current user's user agreement record. Cannot be null.

Throws:

org.eurekaclinical.standardapis.exception.HttpStatusException - with a 404 status code if the current user has no user agreement record.

create

public javax.ws.rs.core.Response create(org.eurekaclinical.useragreement.client.comm.UserAgreementStatus inUserAgreement,
                                        @Context
                                        javax.servlet.http.HttpServletRequest req)

Creates a user agreement record for the current user.

Parameters:

inUserAgreement - the new user agreement record, must have the username of the current user. Cannot be null.

req - the request object. Cannot be null.

Returns:

a response object with a 201 status code (created) and the URI for the created record.

Throws:

org.eurekaclinical.standardapis.exception.HttpStatusException - if an error occurred. If the fields of the user agreement record are invalid, the exception will have a 400 status code (bad request). If the current user already has a user agreement record, the exception will have a 409 status code (conflict).