blackboard.data.role
Class PortalRole

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.role.PortalRole

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class PortalRole
extends BbObject

The PortalRole class is a representation of an institution role within the Blackboard application. A Blackboard user may have a primary institution role and multiple secondary institution roles assigned to it. Institution roles within the system are then used to control the display of various content to specific users.

Since:

Bb 6.3

Version:

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

Field Summary

static DataType	DATA_TYPE
static java.lang.String	RESOURCE_BUNDLE Resource bundle for this data object

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

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

Method Summary

Id	getDataSourceId() gets the datasource id value for this PortalRole.
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getDescription() gets the description value for this PortalRole.
java.lang.String	getLabel() Deprecated. getRoleName() should now be used.
java.lang.String	getPersistentLabel() Returns the database name String associated with this PortalRole .
java.lang.String	getRoleID() gets the batch uid value for this PortalRole.
java.lang.String	getRoleName() Returns the name String associated with this PortalRole.
boolean	isGuest() gets the isGuest value for this PortalRole.
boolean	isRemovable() gets the isRemovable value for this PortalRole.
boolean	isSelfSelectable() gets the isSelfSelectable value for this PortalRole.
void	setDataSourceId(Id dataSourceId) sets the datasource id value for this PortalRole
void	setDescription(java.lang.String desc) Sets the description String value for this PortalRole.
void	setIsGuest(boolean isGuest) sets the isGuest value for this PortalRole
void	setIsRemovable(boolean isRemovable) sets the isRemovable value for this PortalRole
void	setIsSelfSelectable(boolean isSelfSelect) sets the isSelfSelectable value for this PortalRole
void	setLabel(java.lang.String name) Deprecated. setRoleName(String name) should now be used.
void	setRoleID(java.lang.String roleId) Sets the role Id String value for this PortalRole.
void	setRoleName(java.lang.String name) Sets the name String value for this PortalRole.
void	validate() Validates the contents of this PortalRole.

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

RESOURCE_BUNDLE

public static final java.lang.String RESOURCE_BUNDLE

Resource bundle for this data object

See Also:

Constant Field Values

Constructor Detail

PortalRole

public PortalRole()

Creates an instance of PortalRole with default property values.

Method Detail

getPersistentLabel

public java.lang.String getPersistentLabel()

Returns the database name String associated with this PortalRole .

Returns:

name String value for this PortalRole

getLabel

public java.lang.String getLabel()

Deprecated. getRoleName() should now be used.

Returns the name String associated with this PortalRole .

Returns:

name String value for this PortalRole

setLabel

public void setLabel(java.lang.String name)

Deprecated. setRoleName(String name) should now be used.

Sets the name String value for this PortalRole.

Parameters:

name - String value for this PortalRole

getRoleName

public java.lang.String getRoleName()

Returns the name String associated with this PortalRole. The name is the human readable label for the institution role.

Returns:

name String value for this PortalRole

setRoleName

public void setRoleName(java.lang.String name)

Sets the name String value for this PortalRole. The name is the human readable label for the institution role.

Parameters:

name - String value for this PortalRole

getRoleID

public java.lang.String getRoleID()

gets the batch uid value for this PortalRole.

setRoleID

public void setRoleID(java.lang.String roleId)

Sets the role Id String value for this PortalRole.

Parameters:

roleId - String value for this PortalRole

getDescription

public java.lang.String getDescription()

gets the description value for this PortalRole.

setDescription

public void setDescription(java.lang.String desc)

Sets the description String value for this PortalRole.

Parameters:

description - String value for this PortalRole

getDataSourceId

public Id getDataSourceId()

gets the datasource id value for this PortalRole.

setDataSourceId

public void setDataSourceId(Id dataSourceId)

sets the datasource id value for this PortalRole

Parameters:

String - dataSourceId

isSelfSelectable

public boolean isSelfSelectable()

gets the isSelfSelectable value for this PortalRole.

setIsSelfSelectable

public void setIsSelfSelectable(boolean isSelfSelect)

sets the isSelfSelectable value for this PortalRole

Parameters:

boolean - isSelfSelect>

isRemovable

public boolean isRemovable()

gets the isRemovable value for this PortalRole.

setIsRemovable

public void setIsRemovable(boolean isRemovable)

sets the isRemovable value for this PortalRole

Parameters:

boolean - isRemovable>

isGuest

public boolean isGuest()

gets the isGuest value for this PortalRole.

setIsGuest

public void setIsGuest(boolean isGuest)

sets the isGuest value for this PortalRole

Parameters:

boolean - isRemoveable>

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 PortalRole. 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