Package ca.corefacility.bioinformatics.irida.model.enums

Enum ProjectRole

java.lang.Object

java.lang.Enum<ProjectRole>

ca.corefacility.bioinformatics.irida.model.enums.ProjectRole

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProjectRole>

public enum ProjectRole
extends java.lang.Enum<ProjectRole>

Roles for users accessing projects.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROJECT_OWNER
PROJECT_USER

Method Summary

Modifier and Type	Method	Description
static ProjectRole	fromString(java.lang.String code)	Get a role from the given string code
int	getLevel()
static ProjectRole	getMaxRoleForProjectsAndGroups(ProjectUserJoin projectUserJoin, java.util.Collection<UserGroupProjectJoin> userGroupProjectJoins)	Compares and returns the highest level ProjectRole from a ProjectUserJoin and a collection of UserGroupProjectJoins.
java.lang.String	toString()
static ProjectRole	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ProjectRole[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROJECT_USER

public static final ProjectRole PROJECT_USER

PROJECT_OWNER

public static final ProjectRole PROJECT_OWNER

Method Detail

values

public static ProjectRole[] 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 (ProjectRole c : ProjectRole.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProjectRole valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ProjectRole>

fromString

public static ProjectRole fromString(java.lang.String code)

Get a role from the given string code

Parameters:

code - the string to get a role for

Returns:

The requested ProjectRole

getLevel

public int getLevel()

getMaxRoleForProjectsAndGroups

public static ProjectRole getMaxRoleForProjectsAndGroups(ProjectUserJoin projectUserJoin,
                                                         java.util.Collection<UserGroupProjectJoin> userGroupProjectJoins)

Compares and returns the highest level ProjectRole from a ProjectUserJoin and a collection of UserGroupProjectJoins.

Parameters:

projectUserJoin - a user's ProjectUserJoin

userGroupProjectJoins - a collection of UserGroupProjectJoin

Returns:

the max ProjectRole