blackboard.data.content
Class StaffInfo

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.content.StaffInfo

All Implemented Interfaces:

Available, IBbObject, Identifiable, Positionable, java.lang.Cloneable

Direct Known Subclasses:

StaffInfoFolder

public class StaffInfo
extends BbObject
implements Available, Positionable

The StaffInfo class is a representation of a staff information element within the Blackboard application. StaffInfo objects are used within courses to store information about instructors, TAs, guest lecturers, etc.

Note that StaffInfo no longer inherits from Content. This is due to several changes in the Blackboard 6 content model that made the class hierarchy undergo several semantic changes.

Since:

Bb 5.5

Version:

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

Field Summary

static DataType	DATA_TYPE Standard data object type constant
static java.lang.String	RESOURCE_BUNDLE Resource bundle for this data object
static DataType	STAFF_INFO_DATA_TYPE Deprecated. Use the constant DATA_TYPE instead

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Fields inherited from interface blackboard.data.Positionable

POS_UNDEFINED

Constructor Summary

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

Method Summary

FormattedText	getBiography() Returns the biography of this StaffInfo.
Id	getCourseId() Gets the Id of the course associated with this StaffInfo object.
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getEmail() Returns the email of this StaffInfo object.
java.lang.String	getFamilyName() Returns the family name (last name) of this StaffInfo object.
java.lang.String	getGivenName() Returns the given name (first name) of this StaffInfo object.
java.lang.String	getHomePageUrl() Returns the home page URL value of this StaffInfo object.
BbFile	getImageFile() This method is for INTERNAL USE ONLY.
boolean	getIsAvailable() Returns the value of the availability attribute.
boolean	getIsFolder() Returns the value of the folder attribute.
java.lang.String	getOfficeAddress() Returns the office address of this StaffInfo object.
java.lang.String	getOfficeHours() Returns the office hours of this StaffInfo object.
Id	getParentId() Returns the Id of the StaffInfoFolder that contains this object.
java.lang.String	getPersistentTitle() Returns the title for this object.
java.lang.String	getPhone() Returns the phone of this StaffInfo object.
int	getPosition() Returns the position of this object in the parent folder's collection
java.lang.String	getSirTitle() Returns the sirtitle of this StaffInfo object.
java.lang.String	getTitle() Returns the title for this object.
java.lang.String	getTitleColor() Returns the color used to render the color.
void	setBiography(FormattedText bio) Sets the biography of this StaffInfo.
void	setCourseId(Id courseId) Sets the course id associated with this StaffInfo object.
void	setEmail(java.lang.String strEmail) Sets the email value for this StaffInfo object.
void	setFamilyName(java.lang.String strFamilyName) Sets the family name (last name) value for this StaffInfo object.
void	setGivenName(java.lang.String strGivenName) Sets the given name (first name) value for this StaffInfo object.
void	setHomePageUrl(java.lang.String strHomePageUrl) Sets the home page URL value for this StaffInfo object.
void	setImageFile(BbFile imageFile) This method is for INTERNAL USE ONLY.
void	setIsAvailable(boolean avail) Sets the value of the availability attribute
void	setIsFolder(boolean isFolder) Sets whether this StaffInfo should be treated as a folder of staff information objects, or as an actual staff information object.
void	setOfficeAddress(java.lang.String strOfficeAddress) Sets the office address value for this StaffInfo object.
void	setOfficeHours(java.lang.String strOfficeHours) Sets the office hours value for this StaffInfo object.
void	setParentId(Id parentId) Sets the parent id to the specified id.
void	setPhone(java.lang.String strPhone) Sets the phone value for this StaffInfo object
void	setPosition(int pos) Sets the position of this object in the parent folder.
void	setSirTitle(java.lang.String strSirTitle) Sets the sirtitle value for this StaffInfo object.
void	setTitle(java.lang.String title) Sets the title for this object.
void	setTitleColor(java.lang.String color) Sets the color to render this object's title
void	validate() Validates the contents of this StaffInfo.

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

Standard data object type constant

STAFF_INFO_DATA_TYPE

public static final DataType STAFF_INFO_DATA_TYPE

Deprecated. Use the constant DATA_TYPE instead

RESOURCE_BUNDLE

public static final java.lang.String RESOURCE_BUNDLE

Resource bundle for this data object

See Also:

Constant Field Values

Constructor Detail

StaffInfo

public StaffInfo()

Creates an instance of StaffInfo with default property values.

Method Detail

getSirTitle

public java.lang.String getSirTitle()

Returns the sirtitle of this StaffInfo object. This is the salutation (Mr., Mrs., etc.)

Returns:

a String representing the sirtitle of this StaffInfo

setSirTitle

public void setSirTitle(java.lang.String strSirTitle)

Sets the sirtitle value for this StaffInfo object.

Parameters:

strSirTitle - a String with the sirtitle for this StaffInfo . This attribute should not exceed 100 characters.

getIsAvailable

public boolean getIsAvailable()

Returns the value of the availability attribute.

Specified by:

getIsAvailable in interface Available

Returns:

availability attribute

setIsAvailable

public void setIsAvailable(boolean avail)

Sets the value of the availability attribute

Specified by:

setIsAvailable in interface Available

Parameters:

avail - value to set attribute

getIsFolder

public boolean getIsFolder()

Returns the value of the folder attribute. If this object was loaded from the database and the value returned from this method is true, the underlying object can be cast to StaffInfoFolder.

Returns:

true if this object is a folder.

setIsFolder

public void setIsFolder(boolean isFolder)

Sets whether this StaffInfo should be treated as a folder of staff information objects, or as an actual staff information object. If you wish to create a staff information folder, you should instantiate a an object of type StaffInfoFolder instead. Manually setting this attribute should only be done when the final type of the staff information object is not known when the object is instantiated.

Parameters:

isFolder - indicate whether to treat this object as a folder.

getPosition

public int getPosition()

Returns the position of this object in the parent folder's collection

Specified by:

getPosition in interface Positionable

Returns:

position

setPosition

public void setPosition(int pos)

Sets the position of this object in the parent folder. This is typically only called by StaffInfoFolder.addChild()

Specified by:

setPosition in interface Positionable

Parameters:

pos - position to set

getTitleColor

public java.lang.String getTitleColor()

Returns the color used to render the color.

Returns:

RGB color string.

setTitleColor

public void setTitleColor(java.lang.String color)

Sets the color to render this object's title

Parameters:

color - String in HTML RGB form. This value should not exceed 7 characters.

getTitle

public java.lang.String getTitle()

Returns the title for this object. This is typically only used for StaffInfoFolder objects.

Returns:

the title of this StaffInfo as a String

getPersistentTitle

public java.lang.String getPersistentTitle()

Returns the title for this object. This is typically only used for StaffInfoFolder objects.

Returns:

the title of this StaffInfo as a String

setTitle

public void setTitle(java.lang.String title)

Sets the title for this object. This attribute is typically only set for StaffInfoFolder objects.

Parameters:

title - Title for this object. This value should not exceed 255 characters.

getGivenName

public java.lang.String getGivenName()

Returns the given name (first name) of this StaffInfo object.

Returns:

a String representing the given name of this StaffInfo

setGivenName

public void setGivenName(java.lang.String strGivenName)

Sets the given name (first name) value for this StaffInfo object.

Parameters:

strGivenName - a String with the given name for this StaffInfo. This value should not exceed 100 characters.

getFamilyName

public java.lang.String getFamilyName()

Returns the family name (last name) of this StaffInfo object.

Returns:

a String representing the family name of this StaffInfo

setFamilyName

public void setFamilyName(java.lang.String strFamilyName)

Sets the family name (last name) value for this StaffInfo object.

Parameters:

strFamilyName - a String with the family name for this StaffInfo. This value should not exceed 100 characters.

getPhone

public java.lang.String getPhone()

Returns the phone of this StaffInfo object.

Returns:

a String representing the phone of this StaffInfo

setPhone

public void setPhone(java.lang.String strPhone)

Sets the phone value for this StaffInfo object

Parameters:

strPhone - a String with the phone for this StaffInfo . No formatting is required, but this value should not exceed 50 characters.

getEmail

public java.lang.String getEmail()

Returns the email of this StaffInfo object.

Returns:

a String representing the email of this StaffInfo

setEmail

public void setEmail(java.lang.String strEmail)

Sets the email value for this StaffInfo object.

Parameters:

strEmail - a String with the email for this StaffInfo . No formatting is required, but this value should not exceed 100 characters.

getOfficeHours

public java.lang.String getOfficeHours()

Returns the office hours of this StaffInfo object.

Returns:

a String representing the office hours of this StaffInfo

setOfficeHours

public void setOfficeHours(java.lang.String strOfficeHours)

Sets the office hours value for this StaffInfo object.

Parameters:

strOfficeHours - a String with the office hours for this StaffInfo. This value cannot exceed 255 characters.

getOfficeAddress

public java.lang.String getOfficeAddress()

Returns the office address of this StaffInfo object.

Returns:

a String representing the office address of this StaffInfo

setOfficeAddress

public void setOfficeAddress(java.lang.String strOfficeAddress)

Sets the office address value for this StaffInfo object.

Parameters:

strOfficeAddress - a String with the office address for this StaffInfo. This value cannot exceed 255 characters.

getImageFile

public BbFile getImageFile()

This method is for INTERNAL USE ONLY. Returns the image file of this StaffInfo object.

Returns:

a BbFile representing the image file of this StaffInfo . This is a bare file name, with no path information included.

setImageFile

public void setImageFile(BbFile imageFile)

This method is for INTERNAL USE ONLY. Sets the image file value for this StaffInfo object

Parameters:

imageFile - a BbFile with the image file for this StaffInfo . This value should be a simple file name, and should not exceed 255 characters. The location of the file is evaluated relative to the unique directory for the StaffInfo object.

getHomePageUrl

public java.lang.String getHomePageUrl()

Returns the home page URL value of this StaffInfo object.

Returns:

a String representing the home page of this StaffInfo

setHomePageUrl

public void setHomePageUrl(java.lang.String strHomePageUrl)

Sets the home page URL value for this StaffInfo object.

Parameters:

strHomePageUrl - a String with the home page for this StaffInfo. URL syntax is not enforced, though this field cannot exeed 255 characters.

getBiography

public FormattedText getBiography()

Returns the biography of this StaffInfo.

Returns:

a {FormattedText} representing the biography of this staff info

setBiography

public void setBiography(FormattedText bio)

Sets the biography of this StaffInfo.

Parameters:

bio - A FormattedText containing the biography of this staff info. This field may be of any length.

getParentId

public Id getParentId()

Returns the Id of the StaffInfoFolder that contains this object.

Returns:

Id of parent folder

setParentId

public void setParentId(Id parentId)
                 throws java.lang.IllegalArgumentException

Sets the parent id to the specified id. The provided Id should be the id of a StaffInfoFolder object, since only folders can contain other objects.

Parameters:

parentId - Id of the parent folder.

Throws:

java.lang.IllegalArgumentException

getCourseId

public Id getCourseId()

Gets the Id of the course associated with this StaffInfo object.

Returns:

Id of the associated course

setCourseId

public void setCourseId(Id courseId)

Sets the course id associated with this StaffInfo object. This property is typically only set by the containing folder.

Parameters:

courseId - course id to associate

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 StaffInfo. Internal consistency checks are also performed. CourseID field is required.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails