org.oscelot.webct.dao
Class UserRole

java.lang.Object
  org.oscelot.webct.dao.UserRole

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class.

The UserRole class represents a Vista user role (SIND, SSTU, etc...).

Based on com.webct.platform.sdkext.authmoduledata.UserRole

public class UserRole

extends java.lang.Object

Version:

2.5 (31-Oct-11)

Author:

Stephen P Vickers

Field Summary

static UserRole	AUDITOR_ROLE Deprecated.
static UserRole	COURSE_DESIGNER_ROLE Deprecated.
static UserRole	COURSE_INSTRUCTOR_ROLE Deprecated.
static UserRole	DESIGNER_INSTRUCTOR_ROLE Deprecated.
static UserRole	DOMAIN_ADMIN_ROLE Deprecated.
static UserRole	DOMAIN_DESIGNER_ROLE Deprecated.
static UserRole	GROUP_ADMIN_ROLE Deprecated.
static UserRole	GROUP_DESIGNER_ROLE Deprecated.
static UserRole	INSTITUTIONAL_ADMIN_ROLE Deprecated.
static UserRole	INSTITUTIONAL_DESIGNER_ROLE Deprecated.
static UserRole	MENTOR_ROLE Deprecated.
static UserRole	SECTION_DESIGNER_ROLE Deprecated.
static UserRole	SECTION_INSTRUCTOR_ROLE Deprecated.
static UserRole	SERVER_ADMIN_ROLE Deprecated.
static UserRole	STUDENT_ROLE Deprecated.
static UserRole	TA_ROLE Deprecated.

Constructor Summary

UserRole(java.lang.String name, int value)
Deprecated. This class has been replaced with a set of string constants defined in the UserVO class

Public constructor to create a UserRole.

Method Summary

boolean	equals(java.lang.Object obj) Deprecated. This class has been replaced with a set of string constants defined in the UserVO class; use the equals() method of the String class instead Returns the name of the user role.
static UserRole	forName(java.lang.String name) Deprecated. This class has been replaced with a set of string constants defined in the UserVO class This public method returns a UserRole object for a given role name. Supported user role names include: Auditor - SAUD Course Designer - CDES Course Instructor - CINS Designer Instructor - SIND Domain Admin - DADM Domain Designer - DDES Group Admin - KADM Group Designer - KDES Institutional Admin - IADM Institutional Designer - IDES Section Designer - SDES Section Instructor - SINS Server Admin - VADM Student - SSTU TA - STEA Mentor - SMEN
int	getValue() Deprecated. This class has been replaced with a set of string constants defined in the UserVO class; the integer value of a user role served no apparent useful purpose Returns the integer value of the user role.
int	hashCode() Deprecated.
java.lang.String	toString() Deprecated. This class has been replaced with a set of string constants defined in the UserVO class making this method redundant as the role is already expressed as a String Returns the name of the user role.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERVER_ADMIN_ROLE

public static final UserRole SERVER_ADMIN_ROLE

Deprecated.

DOMAIN_ADMIN_ROLE

public static final UserRole DOMAIN_ADMIN_ROLE

Deprecated.

DOMAIN_DESIGNER_ROLE

public static final UserRole DOMAIN_DESIGNER_ROLE

Deprecated.

INSTITUTIONAL_ADMIN_ROLE

public static final UserRole INSTITUTIONAL_ADMIN_ROLE

Deprecated.

INSTITUTIONAL_DESIGNER_ROLE

public static final UserRole INSTITUTIONAL_DESIGNER_ROLE

Deprecated.

GROUP_ADMIN_ROLE

public static final UserRole GROUP_ADMIN_ROLE

Deprecated.

GROUP_DESIGNER_ROLE

public static final UserRole GROUP_DESIGNER_ROLE

Deprecated.

COURSE_DESIGNER_ROLE

public static final UserRole COURSE_DESIGNER_ROLE

Deprecated.

COURSE_INSTRUCTOR_ROLE

public static final UserRole COURSE_INSTRUCTOR_ROLE

Deprecated.

SECTION_DESIGNER_ROLE

public static final UserRole SECTION_DESIGNER_ROLE

Deprecated.

SECTION_INSTRUCTOR_ROLE

public static final UserRole SECTION_INSTRUCTOR_ROLE

Deprecated.

TA_ROLE

public static final UserRole TA_ROLE

Deprecated.

STUDENT_ROLE

public static final UserRole STUDENT_ROLE

Deprecated.

AUDITOR_ROLE

public static final UserRole AUDITOR_ROLE

Deprecated.

DESIGNER_INSTRUCTOR_ROLE

public static final UserRole DESIGNER_INSTRUCTOR_ROLE

Deprecated.

MENTOR_ROLE

public static final UserRole MENTOR_ROLE

Deprecated.

Constructor Detail

UserRole

public UserRole(java.lang.String name,
                int value)

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class

Public constructor to create a UserRole.

Parameters:

name - user role name

value - user role value

Method Detail

forName

public static UserRole forName(java.lang.String name)

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class

This public method returns a UserRole object for a given role name. Supported user role names include:

• Auditor - SAUD
• Course Designer - CDES
• Course Instructor - CINS
• Designer Instructor - SIND
• Domain Admin - DADM
• Domain Designer - DDES
• Group Admin - KADM
• Group Designer - KDES
• Institutional Admin - IADM
• Institutional Designer - IDES
• Section Designer - SDES
• Section Instructor - SINS
• Server Admin - VADM
• Student - SSTU
• TA - STEA
• Mentor - SMEN

Parameters:

name - user role name

Returns:

the UserRole object

equals

public boolean equals(java.lang.Object obj)

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class; use the equals() method of the String class instead

Returns the name of the user role.

Returns:

true if obj represents the same role

hashCode

public int hashCode()

Deprecated.

getValue

public int getValue()

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class; the integer value of a user role served no apparent useful purpose

Returns the integer value of the user role.

Returns:

value user role value

toString

public java.lang.String toString()

Deprecated. This class has been replaced with a set of string constants defined in the UserVO class making this method redundant as the role is already expressed as a String

Returns the name of the user role.

Returns:

user role name