blackboard.data.content
Class StaffInfoFolder

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

All Implemented Interfaces:

Available, IBbObject, Positionable, java.lang.Cloneable

public class StaffInfoFolder
extends StaffInfo

The StaffInfoFolder class is a representation of a staff information folder within the Blackboard application. A staff information folder provides a means of organizing staff information elements.

Since:

Bb 5.5

Version:

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

Field Summary

static DataType	DATA_TYPE Standard persistence object data type constant
static DataType	STAFF_INFO_FOLDER_DATA_TYPE Deprecated. Use the constant DATA_TYPE instead

Fields inherited from class blackboard.data.content.StaffInfo

RESOURCE_BUNDLE, STAFF_INFO_DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Fields inherited from interface blackboard.data.Positionable

POS_UNDEFINED

Constructor Summary

StaffInfoFolder()
Default constructor.

Method Summary

void	addChild(StaffInfo si) Adds the given piece of Content (must be of type StaffInfo) to the list of children for this Folder.
void	addChild(StaffInfo si, int nPos) Adds the given piece of Content (must be of type StaffInfo) to the list of children for his Folder at the provided position value.
BbList	getChildren() Returns the list of children that presently belong to (was assigned to) this StaffInfoFolder.
DataType	getDataType() Returns the DataType identifier for this object.
boolean	getIsFolder() Overrides the method of the same name in StaffInfo.

Methods inherited from class blackboard.data.content.StaffInfo

getBiography, getCourseId, getEmail, getFamilyName, getGivenName, getHomePageUrl, getImageFile, getIsAvailable, getOfficeAddress, getOfficeHours, getParentId, getPersistentTitle, getPhone, getPosition, getSirTitle, getTitle, getTitleColor, setBiography, setCourseId, setEmail, setFamilyName, setGivenName, setHomePageUrl, setImageFile, setIsAvailable, setIsFolder, setOfficeAddress, setOfficeHours, setParentId, setPhone, setPosition, setSirTitle, setTitle, setTitleColor

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

DATA_TYPE

public static final DataType DATA_TYPE

Standard persistence object data type constant

STAFF_INFO_FOLDER_DATA_TYPE

public static final DataType STAFF_INFO_FOLDER_DATA_TYPE

Deprecated. Use the constant DATA_TYPE instead

Constructor Detail

StaffInfoFolder

public StaffInfoFolder()

Default constructor. Ensures that the appropriate attributes in StaffInfo are over-ridden, including IsFolder.

Method Detail

getIsFolder

public boolean getIsFolder()

Overrides the method of the same name in StaffInfo.

Overrides:

getIsFolder in class StaffInfo

Returns:

true (this object IS a folder)

See Also:

StaffInfo.getIsFolder()

addChild

public void addChild(StaffInfo si)
              throws java.lang.IllegalArgumentException

Adds the given piece of Content (must be of type StaffInfo) to the list of children for this Folder. The piece of content is added at the end of the list of content items.

This method enforces all constraints in the relationship of a folder and a child content item. First, the parent/child relationship between a folder and a piece of content is enforced by calling Content.setParentId(Id), passing in the local content Id value, on the provided Content object prior to adding it to the list of content items. Content items should also be part of the same course as their parent folder so Content.setCourseId(Id) is called passing in the local course Id value.

Parameters:

content - the piece of Content to be added to the list of content being maintained by this folder.

Throws:

java.lang.IllegalArgumentException - thrown if the provided content is not of type StaffInfo.

addChild

public void addChild(StaffInfo si,
                     int nPos)
              throws java.lang.IllegalArgumentException

Adds the given piece of Content (must be of type StaffInfo) to the list of children for his Folder at the provided position value.

This method enforces all constraints in the relationship of a folder and a child content item. First, the parent/child relationship between a folder and a piece of content is enforced by calling Content.setParentId(Id), passing in the local content Id value, on the provided Content object prior to adding it to the list of content items. Content items should also be part of the same course as their parent folder so Content.setCourseId(Id) is called passing in the local course Id value.

Parameters:

content - the piece of Content to be added to the list of content being maintained by this folder.

nPos - the position in the child list at which the given content should be added.

Throws:

java.lang.IllegalArgumentException - thrown if the provided content is not of type StaffInfo.

getChildren

public BbList getChildren()

Returns the list of children that presently belong to (was assigned to) this StaffInfoFolder.

Returns:

a BbList of the children that belong to this folder.

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

Overrides:

getDataType in class StaffInfo

Returns:

the DataType for this object