org.sagebionetworks.bridge.rest.model

Enum Role

java.lang.Object

java.lang.Enum<Role>

org.sagebionetworks.bridge.rest.model.Role

All Implemented Interfaces:

Serializable, Comparable<Role>

public enum Role
extends Enum<Role>

The roles assigned to this user. Only administrative accounts are assigned roles, which break down into two main categories: app-scoped permissions (developer, researcher) and study-scoped permissions conferred by organization membership (study coordinator, study designer). |Role|Description| |---|---| |developer|An administrative account that can configure an entire Bridge app (often the role assigned to developers of the mobile app itself). Many APIs that involve participants are accessible to developers as long as they are operating on test accounts.| |researcher|An administrator who can see all the participants in all studies in an app. Less used now in favor of study coordinators.| |study_coordinator|A researcher who manages and coordinates research with participants in a specific set of studies, defined by the coordinator’s membership in an organization and the organization’s sponsorship of one or more studies.| |study_designer|An individual tasked with modeling the portions of a scientific protocol in one or more studies (consents, studies, protocols, schedules), defined by the designer’s membership in an organization and the organization’s sponsorship of one or more studies.| |org_admin|An administrator who can manage an organization and the member accounts of that organization. The organization in turn grants access to the studies that are sponsored by the organization.| |admin|An administrator of a Bridge application. An administrator can call any API accessible to a developer, researcher, study coordinator, study designer, or organization admin.| |worker|A Sage Bionetworks worker process (internal to Bridge).| |superadmin|A Sage Bionetworks administrator (internal to Sage Bionetworks).|

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Role.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN
DEVELOPER
ORG_ADMIN
RESEARCHER
STUDY_COORDINATOR
STUDY_DESIGNER
SUPERADMIN
WORKER

Method Summary

Modifier and Type	Method and Description
static Role	fromValue(String text)
String	getValue()
String	toString()
static Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static Role[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEVELOPER

public static final Role DEVELOPER

RESEARCHER

public static final Role RESEARCHER

STUDY_COORDINATOR

public static final Role STUDY_COORDINATOR

STUDY_DESIGNER

public static final Role STUDY_DESIGNER

ADMIN

public static final Role ADMIN

ORG_ADMIN

public static final Role ORG_ADMIN

WORKER

public static final Role WORKER

SUPERADMIN

public static final Role SUPERADMIN

Method Detail

values

public static Role[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Role c : Role.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Role valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<Role>

fromValue

public static Role fromValue(String text)