blackboard.data.user
Class UserRole

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.user.UserRole

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class UserRole
extends BbObject

The UserRole class provides user secondary institution role information for extending objects. It is the association of a secondary institution role to the user, and multiple secondary institution roles are allowed per user.

Since:

Bb 6.3

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

UserRole()
Creates an instance of UserRole with default property values.

Method Summary

DataType	getDataType() Returns the DataType identifier for this object.
Id	getPortalRoleId() Returns the portal role Id associated with this UserRole .
User	getUser() Returns the User object of this UserRole object
Id	getUserId() Returns the user Id associated with this UserRole .
void	setPortalRoleId(Id id) Sets the portal role Id value for this UserRole.
void	setUser(User user) Sets the User object of this UserRole object
void	setUserId(Id iUserId) Sets the user Id value for this UserRole.
void	validate() Validates the contents of this UserRole.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

Constructor Detail

UserRole

public UserRole()

Creates an instance of UserRole with default property values.

Method Detail

getUserId

public Id getUserId()

Returns the user Id associated with this UserRole .

Returns:

user Id value for this user role

setUserId

public void setUserId(Id iUserId)

Sets the user Id value for this UserRole.

Parameters:

iUserId - the user Id value to use for this user role

getPortalRoleId

public Id getPortalRoleId()

Returns the portal role Id associated with this UserRole .

Returns:

portal role value for this user role

setPortalRoleId

public void setPortalRoleId(Id id)

Sets the portal role Id value for this UserRole.

Parameters:

portal - role value to use for this user role

getUser

public User getUser()

Returns the User object of this UserRole object

Returns:

a User representing the user of this user role

setUser

public void setUser(User user)

Sets the User object of this UserRole object

Parameters:

user - a User representing the user of this user role

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

validate

public void validate()
              throws ValidationException

Validates the contents of this UserRole. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails