|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.content.StaffInfo
public class StaffInfo
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.
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 |
Methods inherited from class blackboard.data.BbObject |
---|
clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final DataType DATA_TYPE
public static final DataType STAFF_INFO_DATA_TYPE
DATA_TYPE
insteadpublic static final java.lang.String RESOURCE_BUNDLE
Constructor Detail |
---|
public StaffInfo()
StaffInfo
with default property values.
Method Detail |
---|
public java.lang.String getSirTitle()
StaffInfo
object. This is the
salutation (Mr., Mrs., etc.)
String
representing the sirtitle of this StaffInfo
public void setSirTitle(java.lang.String strSirTitle)
StaffInfo
object.
strSirTitle
- a String
with the sirtitle for this StaffInfo
. This attribute should not exceed 100 characters.public boolean getIsAvailable()
getIsAvailable
in interface Available
public void setIsAvailable(boolean avail)
setIsAvailable
in interface Available
avail
- value to set attributepublic boolean getIsFolder()
StaffInfoFolder
.
public void setIsFolder(boolean isFolder)
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.
isFolder
- indicate whether to treat this object as a folder.public int getPosition()
getPosition
in interface Positionable
public void setPosition(int pos)
StaffInfoFolder.addChild()
setPosition
in interface Positionable
pos
- position to setpublic java.lang.String getTitleColor()
public void setTitleColor(java.lang.String color)
color
- String in HTML RGB form. This value should not exceed 7 characters.public java.lang.String getTitle()
StaffInfoFolder
objects.
StaffInfo
as a String
public java.lang.String getPersistentTitle()
StaffInfoFolder
objects.
StaffInfo
as a String
public void setTitle(java.lang.String title)
StaffInfoFolder
objects.
title
- Title for this object. This value should not exceed 255 characters.public java.lang.String getGivenName()
StaffInfo
object.
String
representing the given name of this StaffInfo
public void setGivenName(java.lang.String strGivenName)
StaffInfo
object.
strGivenName
- a String
with the given name for this
StaffInfo
. This value should not exceed 100 characters.public java.lang.String getFamilyName()
StaffInfo
object.
String
representing the family name of this StaffInfo
public void setFamilyName(java.lang.String strFamilyName)
StaffInfo
object.
strFamilyName
- a String
with the family name for this
StaffInfo
. This value should not exceed 100 characters.public java.lang.String getPhone()
StaffInfo
object.
String
representing the phone of this StaffInfo
public void setPhone(java.lang.String strPhone)
StaffInfo
object
strPhone
- a String
with the phone for this StaffInfo
. No formatting is required, but this value should not exceed
50 characters.public java.lang.String getEmail()
StaffInfo
object.
String
representing the email of this StaffInfo
public void setEmail(java.lang.String strEmail)
StaffInfo
object.
strEmail
- a String
with the email for this StaffInfo
. No formatting is required, but this value should not exceed
100 characters.public java.lang.String getOfficeHours()
StaffInfo
object.
String
representing the office hours of this StaffInfo
public void setOfficeHours(java.lang.String strOfficeHours)
StaffInfo
object.
strOfficeHours
- a String
with the office hours for this
StaffInfo
. This value cannot exceed 255 characters.public java.lang.String getOfficeAddress()
StaffInfo
object.
String
representing the office address of this
StaffInfo
public void setOfficeAddress(java.lang.String strOfficeAddress)
StaffInfo
object.
strOfficeAddress
- a String
with the office address for this
StaffInfo
. This value cannot exceed 255 characters.public BbFile getImageFile()
StaffInfo
object.
BbFile
representing the image file of this StaffInfo
. This is a bare file name, with no path information included.public void setImageFile(BbFile imageFile)
StaffInfo
object
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.public java.lang.String getHomePageUrl()
StaffInfo
object.
String
representing the home page of this StaffInfo
public void setHomePageUrl(java.lang.String strHomePageUrl)
StaffInfo
object.
strHomePageUrl
- a String
with the home page for this
StaffInfo
. URL syntax is not enforced, though this field cannot
exeed 255 characters.public FormattedText getBiography()
StaffInfo
.
public void setBiography(FormattedText bio)
StaffInfo
.
bio
- A FormattedText
containing the biography of this staff
info. This field may be of any length.public Id getParentId()
StaffInfoFolder
that contains this object.
public void setParentId(Id parentId) throws java.lang.IllegalArgumentException
Id
should be
the id of a StaffInfoFolder
object, since only folders can contain
other objects.
parentId
- Id of the parent folder.
java.lang.IllegalArgumentException
public Id getCourseId()
StaffInfo
object.
public void setCourseId(Id courseId)
StaffInfo
object. This
property is typically only set by the containing folder.
courseId
- course id to associatepublic DataType getDataType()
DataType
identifier for this object. Can be used to
uniquely identify the "type" of this data object.
getDataType
in interface IBbObject
getDataType
in class BbObject
DataType
for this object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |