A B C D E F G H I J K L M N O P R S T U V W Z _

A

abort() - Method in interface blackboard.platform.Application
Activates flag denoting request for application shutdown.
ABORTING - Static variable in class blackboard.platform.StatusCode
 
ABSOLUTE_LIMIT - Static variable in interface blackboard.data.course.CourseDef
 
acceptsType(String) - Method in interface blackboard.data.content.Aggregate
Method to determine whether a content type of a given type may be added to this Aggregate.
acceptsType(String) - Method in class blackboard.data.content.ContentFolder
A ContentFolder can accept any type of content except ContentFileRef objects ( "resource/x-bb-file" ).
acceptsType(String) - Method in class blackboard.data.content.Lesson
Returns whether the Lesson may aggregate objects of the specified type.
AccessManagerService - Interface in blackboard.platform.security
Primary point of access control.
ACCOUNT_ADMIN - Static variable in class blackboard.data.user.User.SystemRole
Account administrator role.
ACTION - Static variable in interface blackboard.data.content.ChildFileDef
 
ACTION - Static variable in interface blackboard.data.content.ContentFileDef
 
ADAPTER_PROP - Static variable in interface blackboard.platform.plugin.Constants
 
add(int, Object) - Method in class blackboard.base.BbDeleteTrackingList
Inserts the specified element at the specified position in this list.
add(Object) - Method in class blackboard.base.BbDeleteTrackingList
Appends the specified element to this list.
add(Object) - Method in class blackboard.base.BbList
Overrides add() in parent to enforce type safety of this list.
add(int, Object) - Method in class blackboard.base.BbList
Overrides add() in parent to enforce type safety of this list.
addAll(Collection) - Method in class blackboard.base.BbDeleteTrackingList
Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
addAll(int, Collection) - Method in class blackboard.base.BbDeleteTrackingList
Inserts all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
addBbAttribute(BbAttribute) - Method in class blackboard.data.BbAttributes
Deprecated. use the setType methods instead
addChild(StaffInfo) - Method in class blackboard.data.content.StaffInfoFolder
Adds the given piece of Content (must be of type StaffInfo) to the list of children for this Folder.
addChild(StaffInfo, int) - Method in class blackboard.data.content.StaffInfoFolder
Adds the given piece of Content (must be of type StaffInfo) to the list of children for his Folder at the provided position value.
addChildFile(ChildFile) - Method in class blackboard.data.content.ContentFile
Appends the given ChildFile to the current list of child files defined for this ContentFile.
addCodeSource(CodeSource, PermissionCollection) - Method in class blackboard.platform.security.BbPolicy
Used to set the permissions associated with all code sources used in the application.
addConfigurationBindings(String) - Method in class blackboard.persist.BbPersistenceManager
Adds new persister/loader bindings to this pm's config.
addConfigurationBindings(InputStream) - Method in class blackboard.persist.BbPersistenceManager
Adds new persister/loader bindings to this pm's config.
addContent(Content) - Method in class blackboard.data.content.ContentFolder
Adds the given piece of Content (must not be of type ContentFile) to the list of children for this Folder.
addContent(Content, int) - Method in class blackboard.data.content.ContentFolder
Adds the given piece of Content (must notbe of type ContentFile) to the list of children for this Folder at the provided position value.
addContent(Content) - Method in interface blackboard.data.content.Folder
Adds the given piece of Content to this Folder at the end of the list of content items.
addContent(Content, int) - Method in interface blackboard.data.content.Folder
Adds the given piece of Content to this Folder at the specified position within the list of content items.
addContentFile(ContentFile) - Method in class blackboard.data.content.Content
Adds a the specified ContentFile as an attachment to this object.
addContentFile(Content, File, String, String, ContentFile.Action, Connection) - Method in class blackboard.data.content.ContentWrapper
 
addCustomProperties(String, File, boolean) - Method in interface blackboard.platform.config.ConfigurationService
Provision for implementations of ApplicationLauncher to provide non-relative locations for client manipulated configuration properties.
ADDED - Static variable in class blackboard.data.content.CourseUpload.Status
 
addEntry(CacheEntry) - Method in class blackboard.persist.Cache
 
addFile(String, File) - Method in class blackboard.platform.filesystem.MultipartRequest
adds a File to the list of files provided with the upload.
addFilter(ListFilter) - Method in class blackboard.base.FilteringIterator
Adds the given ListFilter to the list of filters applied to this iterator.
addFilter(ListFilter) - Method in class blackboard.base.ListFilter
Adds a filter to this linked list of filters.
addParameter(Object) - Method in class blackboard.persist.CacheKey
Adds the given parameter to the list for this cache key.
addParameter(String, String) - Method in class blackboard.platform.filesystem.MultipartRequest
Adds a parameter identified by name.
AddressBookEntryDef - Interface in blackboard.data.user
Constant definitions used in attribute persistence.
addWarning(String, String) - Method in exception blackboard.data.ValidationException
Adds a warning to this exception.
addWarning(ValidationWarning) - Method in exception blackboard.data.ValidationException
Adds a warning to this exception.
ADMIN_EMAIL - Static variable in class blackboard.platform.config.BbConfig
 
ADMIN_NAME - Static variable in class blackboard.platform.config.BbConfig
 
Aggregate - Interface in blackboard.data.content
Aggregate extends the notion of Folder by adding methods that allow more explicit visibility and control over the rules of aggregation.
AggregateReviewStatus - Class in blackboard.data.content
The AggregateReviewStatus object wraps the state of a user's interaction with a given piece of content and adaptive release status.
AggregateReviewStatus() - Constructor for class blackboard.data.content.AggregateReviewStatus
Default constructor.
AggregateReviewStatusDbLoader - Interface in blackboard.persist.content
Loader interface for AggregateReviewStatusobjects, which encapsulate a learner's adaptive release status, and review status for associated Contentobjects.
AggregateReviewStatusDbLoader.Default - Class in blackboard.persist.content
Standard convenience accessor to get an instance of this loader.
AggregateReviewStatusDbLoader.Default() - Constructor for class blackboard.persist.content.AggregateReviewStatusDbLoader.Default
 
AggregateReviewStatusDef - Interface in blackboard.data.content
Persistence constants for AggregateReviewStatusDef
ALL - Static variable in class blackboard.data.gradebook.ReportingPeriod
 
ALLOW_ANY_SERVER_IP - Static variable in class blackboard.platform.License
 
ALLOW_GUESTS - Static variable in interface blackboard.data.content.ContentDef
 
ALLOW_GUESTS - Static variable in interface blackboard.data.course.CourseDef
 
ALLOW_OBSERVERS - Static variable in interface blackboard.data.content.ContentDef
 
ALLOW_OBSERVERS - Static variable in interface blackboard.data.course.CourseDef
 
ALLOW_SERVER_IP - Static variable in class blackboard.platform.License.XmlDef
 
ALLOW_SERVER_IP_VALUE_ATTR_ANY - Static variable in class blackboard.platform.License.XmlDef
 
ALUMNI - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
Announcement - Class in blackboard.data.announcement
The Announcement class is a representation of an announcement within the Blackboard application.
Announcement() - Constructor for class blackboard.data.announcement.Announcement
Creates an instance of Announcement with default property values.
ANNOUNCEMENT - Static variable in class blackboard.data.content.Link.ReferrerType
 
Announcement.Type - Class in blackboard.data.announcement
Enumeration for defining the different kinds of announcement that Blackboard supports.
ANNOUNCEMENT_DATA_TYPE - Static variable in class blackboard.data.announcement.Announcement
Deprecated. Use the constant Announcement.DATA_TYPE instead
ANNOUNCEMENT_ID - Static variable in interface blackboard.data.content.LinkDef
 
AnnouncementDbLoader - Interface in blackboard.persist.announcement
This interface describes the set of methods that all database loaders for Announcement objects must implement.
AnnouncementDbLoader.Default - Class in blackboard.persist.announcement
A utility class that provides quick access to the AnnouncementDbLoader instance associated with the default instance of the database BbPersistenceManager.
AnnouncementDbLoader.Default() - Constructor for class blackboard.persist.announcement.AnnouncementDbLoader.Default
 
AnnouncementDbPersister - Interface in blackboard.persist.announcement
This interface describes the set of methods that all database persisters for Announcement objects must implement.
AnnouncementDbPersister.Default - Class in blackboard.persist.announcement
A utility class that provides quick access to the AnnouncementDbPersister instance associated with the default instance of the database BbPersistenceManager.
AnnouncementDbPersister.Default() - Constructor for class blackboard.persist.announcement.AnnouncementDbPersister.Default
 
ANTARGS_DEFAULT_USERS_ADMINISTRATOR_PASSWORD_MD5 - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_USERS_GUEST_PASSWORD_MD5 - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_USERS_INTEGRATION_PASSWORD_MD5 - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_USERS_ROOTADMIN_PASSWORD_MD5 - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_VI_REPORT_USER_NAME - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_VI_REPORT_USER_PASSWORD - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_VI_STATS_DB_NAME - Static variable in class blackboard.platform.config.BbConfig
 
ANTARGS_DEFAULT_VI_STATS_DB_PASSWORD - Static variable in class blackboard.platform.config.BbConfig
 
appendFavoriteLink(BbLink) - Method in class blackboard.data.course.CourseMembership
Appends the given BbLink to the current list of favorite links currently defined for this CourseMembership.
appendSecondaryComparator(Comparator) - Method in class blackboard.base.BaseComparator
Appends the provided Comparator to the end of this linked list of comparators.
APPLICATION - Static variable in class blackboard.data.navigation.CourseToc.Target
Toc is a pointer to an application (built in application or system extension)
Application - Interface in blackboard.platform
Base interface for client side command line invocation of utility classes.
APPLICATION - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
ApplicationLauncher - Class in blackboard.platform
Class designated for managing invocation of underlying command line applications which have dependencies upon the Bb platform.
ApplicationLauncher() - Constructor for class blackboard.platform.ApplicationLauncher
 
APPSERVER_DOMAINNAME - Static variable in class blackboard.platform.config.BbConfig
 
APPSERVER_FULLHOSTNAME - Static variable in class blackboard.platform.config.BbConfig
 
APPSERVER_MACHINENAME - Static variable in class blackboard.platform.config.BbConfig
 
APPSERVER_MAXTHREADS - Static variable in class blackboard.platform.config.BbConfig
 
APPSERVER_MINTHREADS - Static variable in class blackboard.platform.config.BbConfig
 
APPSERVER_PORTNUMBER - Static variable in class blackboard.platform.config.BbConfig
 
AppVersion - Class in blackboard.base
The AppVersion class provides a means of describing (indicating) the properties of an object to be loaded/persisted by the persistence framework.
AppVersion(String, String, String) - Constructor for class blackboard.base.AppVersion
Creates an AppVersion instance with the specified attributes.
ASCENDING - Static variable in class blackboard.base.BaseComparator
ASCENDING constant for use in this class's constructor.
assertHasValidKey() - Method in class blackboard.platform.License
Identical to hasValidKey(), except that a checked exception is thrown if the key is not valid.
assertIsLicensed() - Method in class blackboard.platform.License
Assertion that a valid license exists, including validating expiration and valid IP addresses.
assertIsLicensed(String) - Method in class blackboard.platform.LicenseManager
Similar to isLicensed(), except that exceptions are thrown if the license check fails.
assertIsSet() - Method in class blackboard.persist.Id
Asserts that this Id is "set" -- has a value.
assertMatchesContainer(Container) - Method in class blackboard.persist.Id
Asserts that the Container value associated with this Id matches the provided Container value.
assertMatchesDataType(DataType) - Method in class blackboard.persist.Id
Asserts that the DataType value associated with this Id matches the provided DataType value.
assertRequestAuthenticate() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Wrapper for any assertions that should be made before authentication request.
ASSESSMENT - Static variable in interface blackboard.data.gradebook.ScoreProviderStrings
 
ASSESSMENT_SURVEY_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-asmt-survey-link
ASSESSMENT_TEST_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-asmt-test-link
AssessmentFileManager - Class in blackboard.platform.filesystem
A service that returns File objects representing the path to content files for Blackboard's assessment web application.
AssessmentFileManager() - Constructor for class blackboard.platform.filesystem.AssessmentFileManager
 
ASSIGNMENT - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-assignment
ASSIGNMENT - Static variable in interface blackboard.data.gradebook.ScoreProviderStrings
 
associateSessionWithUser(String) - Method in class blackboard.platform.security.authentication.SessionStub
associateSessionWithUser If the userId is associated with a valid user record in the database, then the current session should be associated with that user record, in the database.
AttributePermission - Class in blackboard.data
Permission encapsulating granular access to data object attributes.
AttributePermission(String, String) - Constructor for class blackboard.data.AttributePermission
Constructor accepting both a name and action list.
AUTH_TYPE - Static variable in class blackboard.platform.config.BbConfig
 
authenticate(String, String, SessionStub, boolean) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Method to support native authentication.
authenticate(String, String, SessionStub, boolean) - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Method to support LDAP-based authentication.
authorizeForCourse(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.plugin.PlugInUtil
Authorizes the user's system and course roles for entering the Course.
authorizeForCourseControlPanel(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.plugin.PlugInUtil
Authorizes the user's system and course roles for using the Instructor Control Panel.
authorizeForCourseControlPanelContent(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.plugin.PlugInUtil
Authorizes the user's system and course roles for modifying content from the Instructor Control Panel.
authorizeForSystemAdmin(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.plugin.PlugInUtil
Authorizes the user's system role for the Administrator Control panel.
AvailabilityFilter - Class in blackboard.data
List Filter used to filter on the availability of an object.
AvailabilityFilter(boolean) - Constructor for class blackboard.data.AvailabilityFilter
Constructs an availability filter than can be used to filter a list of objects based upon a provided availability value.
Available - Interface in blackboard.data
The Available interface specifies a set of methods for determining the availability of an object.
AVAILABLE - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
AVAILABLE - Static variable in interface blackboard.platform.plugin.PlugInDef
 
AVAILABLE_ONLY - Static variable in class blackboard.data.AvailabilityFilter
Can be provided to constructor as targetAvailability value
AWAITING_INIT - Static variable in class blackboard.platform.StatusCode
 

B

BadLicenseKeyException - Exception in blackboard.platform
BadLicenseKeyException
BadLicenseKeyException(String) - Constructor for exception blackboard.platform.BadLicenseKeyException
Constructor
BadLicenseKeyException(Throwable) - Constructor for exception blackboard.platform.BadLicenseKeyException
Constructor
BadLicenseKeyException(String, Throwable) - Constructor for exception blackboard.platform.BadLicenseKeyException
Constructor
BadPackageDefException - Exception in blackboard.platform.plugin
Class to encapsulate errors in a package manifest.
BadPackageDefException() - Constructor for exception blackboard.platform.plugin.BadPackageDefException
Default constructor.
BadPackageDefException(String) - Constructor for exception blackboard.platform.plugin.BadPackageDefException
Constructor that sets the message to display with this exception.
BadPackageDefException(Vector) - Constructor for exception blackboard.platform.plugin.BadPackageDefException
Constructor that sets the warnings to attach to this exception.
BadPackageDefException(String, Vector) - Constructor for exception blackboard.platform.plugin.BadPackageDefException
Constructor that takes all available information about the exception
BANNER_IMAGE_FILE - Static variable in interface blackboard.data.course.CourseDef
 
BASE_SHARED_DIR - Static variable in class blackboard.platform.config.BbConfig
 
BASE_SHARED_DIR_WIN - Static variable in class blackboard.platform.config.BbConfig
 
BaseAuthenticationModule - Class in blackboard.platform.security.authentication
Implementation class for the default authentication provider for Blackboard Learning System, also known as RDBMS Authentication.
BaseAuthenticationModule() - Constructor for class blackboard.platform.security.authentication.BaseAuthenticationModule
Simple default constructor.
BaseComparator - Class in blackboard.base
Base comparator class that implements ascending/descending and chaining.
BaseComparator(boolean) - Constructor for class blackboard.base.BaseComparator
Constructor.
BASEDIR - Static variable in class blackboard.platform.config.BbConfig
 
BASEDIR_WIN - Static variable in class blackboard.platform.config.BbConfig
 
BATCH_UID - Static variable in interface blackboard.data.course.ClassificationDef
 
BATCH_UID - Static variable in interface blackboard.data.course.CourseDef
 
BATCH_UID - Static variable in interface blackboard.data.user.UserDef
 
BB5_APP_NAME - Static variable in class blackboard.base.AppVersion
 
BB6X_CONTAINER - Static variable in class blackboard.persist.RemoteDbContainer
 
BbAttribute - Class in blackboard.data
The BbAttribute class is used to form the basis of the name/value pairs used for IBbObject based object properties.
BbAttribute(String, Integer, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Integer.
BbAttribute(String, Long, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Long.
BbAttribute(String, Float, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Float.
BbAttribute(String, Double, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Double.
BbAttribute(String, Boolean, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Boolean.
BbAttribute(String, String, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with String.
BbAttribute(String, Calendar, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Calendar.
BbAttribute(String, Object, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with generic object.
BbAttribute(String, Id, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with Id.
BbAttribute(String, BbEnum, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with BbEnum.
BbAttribute(String, FormattedText, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with FormattedText.
BbAttribute(String, IBbObject, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with IBbObject.
BbAttribute(BbAttribute.Type, String, Object, BbAttributes) - Constructor for class blackboard.data.BbAttribute
Initialization with generic object but of a specific type.
BbAttribute.Type - Class in blackboard.data
 
BbAttributeException - Exception in blackboard.data
A general exception resulting from a problem with the attributes (BbAttribute) of an object (BbObject).
BbAttributeException() - Constructor for exception blackboard.data.BbAttributeException
Default constructor.
BbAttributeException(String) - Constructor for exception blackboard.data.BbAttributeException
Constructs an BbAttributeException with the given message.
BbAttributes - Class in blackboard.data
The BbAttributes class is used to store a set of BbAttribute objects.
BbAttributes() - Constructor for class blackboard.data.BbAttributes
Default Constructor
BbAuthenticationFailedException - Exception in blackboard.platform.security.authentication
Exception used to indicate that an attempt to authenticate failed.
BbAuthenticationFailedException() - Constructor for exception blackboard.platform.security.authentication.BbAuthenticationFailedException
 
BbAuthenticationFailedException(String) - Constructor for exception blackboard.platform.security.authentication.BbAuthenticationFailedException
 
BbConfig - Class in blackboard.platform.config
 
BbConfig() - Constructor for class blackboard.platform.config.BbConfig
 
BbCredentialsNotFoundException - Exception in blackboard.platform.security.authentication
This exception is thrown to indicate that an authentication request does not contain credentials to perform an authentication
BbCredentialsNotFoundException() - Constructor for exception blackboard.platform.security.authentication.BbCredentialsNotFoundException
 
BbCredentialsNotFoundException(String) - Constructor for exception blackboard.platform.security.authentication.BbCredentialsNotFoundException
 
BbDeleteTrackingList - Class in blackboard.base
An extension of BbList that maintains a tracking set of elements that have been removed through one mechanism or another.
BbDeleteTrackingList() - Constructor for class blackboard.base.BbDeleteTrackingList
Default Constructor.
BbDeleteTrackingList(Class) - Constructor for class blackboard.base.BbDeleteTrackingList
Constructs a BbList designated to only accept objects that are instances of the object represented by the provided Class value for addition to the list.
BbEnum - Class in blackboard.base
Base enumeration class for fixed enumerations.
BbEnum(String) - Constructor for class blackboard.base.BbEnum
Constructor
BBENUM - Static variable in class blackboard.data.BbAttribute.Type
 
BbLabeledEnum - Class in blackboard.base
Base enumeration class for enumerations that are used to supply UI-visible labels.
BbLabeledEnum(String, String) - Constructor for class blackboard.base.BbLabeledEnum
Constructor
BbLink - Class in blackboard.data
Provides a wrapper around URL elements for attaching to data objects within the persistence framework.
BbLink() - Constructor for class blackboard.data.BbLink
Default constructor.
BbLink(String, String, String) - Constructor for class blackboard.data.BbLink
Constructs a BbLink with the given name, URL, and description.
BbList - Class in blackboard.base
Generic list class for a collection of objects.
BbList() - Constructor for class blackboard.base.BbList
Default Constructor.
BbList(Class) - Constructor for class blackboard.base.BbList
Constructs a BbList designated to only accept objects that are instances of the object represented by the provided Class value for addition to the list.
BbList.Iterator - Class in blackboard.base
A custom extension of FilteringIterator that can be retrieved from any BbList object using BbList.getFilteringIterator() or BbList.getFilteringIterator(ListFilter).
BbList.Iterator(Iterator, ListFilter) - Constructor for class blackboard.base.BbList.Iterator
Constructor
BBOBJECT - Static variable in class blackboard.data.BbAttribute.Type
 
BbObject - Class in blackboard.data
The BbObject class is the root of the data class hierarchy.
BbObject() - Constructor for class blackboard.data.BbObject
Default Constructor
BbPersistenceManager - Class in blackboard.persist
The BbPersistenceManager class is the central provider of both loader and persister implementation instances in the persistence framework.
BbPolicy - Class in blackboard.platform.security
Blackboard-specific security policy.
BbPolicy(Policy) - Constructor for class blackboard.platform.security.BbPolicy
 
BbSecurityException - Exception in blackboard.platform.security.authentication
Exception class to semantically differentiate exceptions that happen during the execution of authentication methods.
BbSecurityException() - Constructor for exception blackboard.platform.security.authentication.BbSecurityException
Basic constructor inherited from BbException
BbSecurityException(String) - Constructor for exception blackboard.platform.security.authentication.BbSecurityException
Basic constructor inherited from BbException
BbSecurityException(HttpServletRequest) - Constructor for exception blackboard.platform.security.authentication.BbSecurityException
 
BbSecurityException(String, HttpServletRequest) - Constructor for exception blackboard.platform.security.authentication.BbSecurityException
 
BbSecurityException(String, String) - Constructor for exception blackboard.platform.security.authentication.BbSecurityException
 
BbServiceException - Exception in blackboard.platform
BbServiceException
BbServiceException(String) - Constructor for exception blackboard.platform.BbServiceException
Constructor
BbServiceException(Throwable) - Constructor for exception blackboard.platform.BbServiceException
Constructor
BbServiceException(String, Throwable) - Constructor for exception blackboard.platform.BbServiceException
Constructor
BbServiceManager - Class in blackboard.platform
Central manager and broker for platform services.
BbServiceManager() - Constructor for class blackboard.platform.BbServiceManager
 
BbSession - Interface in blackboard.platform.session
BbSession.
BbSession.Scope - Class in blackboard.platform.session
Deprecated. All attributes are stored in Global scope, since the alternate scopes were never properly implemented
BbSessionManagerService - Interface in blackboard.platform.session
BbSessionManagerService This interface provides utility methods to retrieve the BbSession associated with the user making the request.
BIOGRAPHY - Static variable in interface blackboard.data.content.StaffInfoDef
 
BIRTH_DATE - Static variable in interface blackboard.data.user.UserDef
 
blackboard.base - package blackboard.base
Provides common classes and utility classes used throughout the platform API.
blackboard.data - package blackboard.data
Provides the base classes for the persistence layer of platform API.
blackboard.data.announcement - package blackboard.data.announcement
Provides classes used to store "announcements" in the Blackboard system.
blackboard.data.calendar - package blackboard.data.calendar
Provides classes used to store entries in the course, system, and personal calendars in the Blackboard system.
blackboard.data.content - package blackboard.data.content
Provides the classes used to store course content in Blackboard.
blackboard.data.course - package blackboard.data.course
Provides the classes used to interact with course definitions in Blackboard.
blackboard.data.gradebook - package blackboard.data.gradebook
Provides the public implementation classes for Gradebook subsystem.
blackboard.data.navigation - package blackboard.data.navigation
 
blackboard.data.role - package blackboard.data.role
 
blackboard.data.user - package blackboard.data.user
Provides the classes used to interact with user definitions in Blackboard.
blackboard.persist - package blackboard.persist
 
blackboard.persist.announcement - package blackboard.persist.announcement
 
blackboard.persist.calendar - package blackboard.persist.calendar
 
blackboard.persist.content - package blackboard.persist.content
 
blackboard.persist.course - package blackboard.persist.course
 
blackboard.persist.gradebook - package blackboard.persist.gradebook
 
blackboard.persist.navigation - package blackboard.persist.navigation
 
blackboard.persist.role - package blackboard.persist.role
 
blackboard.persist.user - package blackboard.persist.user
 
blackboard.platform - package blackboard.platform
 
blackboard.platform.config - package blackboard.platform.config
 
blackboard.platform.context - package blackboard.platform.context
 
blackboard.platform.db - package blackboard.platform.db
 
blackboard.platform.filesystem - package blackboard.platform.filesystem
 
blackboard.platform.log - package blackboard.platform.log
 
blackboard.platform.persistence - package blackboard.platform.persistence
 
blackboard.platform.plugin - package blackboard.platform.plugin
 
blackboard.platform.security - package blackboard.platform.security
 
blackboard.platform.security.authentication - package blackboard.platform.security.authentication
Provides the public implementation classes for creating custom authentication modules for Learning System.
blackboard.platform.session - package blackboard.platform.session
 
blackboard.portal.external - package blackboard.portal.external
 
blackboard.util - package blackboard.util
 
BLACKBOARD_LICENSES - Static variable in class blackboard.platform.License.XmlDef
 
BOOLEAN - Static variable in class blackboard.data.BbAttribute.Type
 
BROKEN_IMAGE - Static variable in class blackboard.data.content.ChildFile.Action
 
BROKEN_IMAGE - Static variable in class blackboard.data.content.ContentFile.Action
 
BROKEN_IMAGE - Static variable in class blackboard.data.content.UploadedFile.Action
 
BUILDING_BLOCKS_CATALOG - Variable in class blackboard.platform.plugin.PlugInManager
Download URL for system extensions
buildPermissionObject(String, String, String) - Static method in class blackboard.platform.security.PermissionParser
Creates a permission object given type, name, and actions.
BUSINESS_FAX - Static variable in interface blackboard.data.user.UserInfoDef
 
BUSINESS_PHONE_1 - Static variable in interface blackboard.data.user.UserInfoDef
 
BUSINESS_PHONE_2 - Static variable in interface blackboard.data.user.UserInfoDef
 
BUTTON - Static variable in class blackboard.data.course.Course.NavStyle
Blackboard 5.x style course buttons are used for the navigation menu.
BUTTON_STYLE - Static variable in interface blackboard.data.course.CourseDef
 
BUTTON_STYLE_ID - Static variable in interface blackboard.data.course.CourseDef
 
ButtonStyleDef - Interface in blackboard.data.course
ButtonStyleDef

C

Cache - Class in blackboard.persist
The Cache provides the base model for caching for any object loader defined within the persistence framework.
Cache() - Constructor for class blackboard.persist.Cache
 
CacheEntry - Class in blackboard.persist
The CacheEntry represents an item stored in the cache.
CacheEntry(Object, Object) - Constructor for class blackboard.persist.CacheEntry
 
CacheKey - Class in blackboard.persist
The CacheKey represents a reference to an item stored in the cache.
CacheKey(String, String) - Constructor for class blackboard.persist.CacheKey
 
CachingLoader - Interface in blackboard.persist
The CachingLoader interface provides the base model for any database object loader defined within the persistence framework that wishes to use cacheing.
CALENDAR - Static variable in class blackboard.data.BbAttribute.Type
 
CALENDAR_ENTRY_DATA_TYPE - Static variable in class blackboard.data.calendar.CalendarEntry
Deprecated. Use the constant CalendarEntry.DATA_TYPE instead
CalendarEntry - Class in blackboard.data.calendar
The CalendarEntry class provides a means for defining an event (system, course, or personal) within the Blackboard application.
CalendarEntry() - Constructor for class blackboard.data.calendar.CalendarEntry
Creates an instance of CalendarEntry with default property values.
CalendarEntry.Type - Class in blackboard.data.calendar
Enumeration of the types of calendar events supported by the Blackboard Calendar tool.
CalendarEntryDbLoader - Interface in blackboard.persist.calendar
This interface describes the set of methods that all database loaders for CalendarEntry objects must implement.
CalendarEntryDbLoader.Default - Class in blackboard.persist.calendar
A utility class that provides quick access to the CalendarEntryDbLoader instance associated with the default instance of the database BbPersistenceManager.
CalendarEntryDbLoader.Default() - Constructor for class blackboard.persist.calendar.CalendarEntryDbLoader.Default
 
CalendarEntryDbPersister - Interface in blackboard.persist.calendar
This interface describes the set of methods that all database persisters for CalendarEntry objects must implement.
CalendarEntryDbPersister.Default - Class in blackboard.persist.calendar
A utility class that provides quick access to the CalendarEntryDbPersister instance associated with the default instance of the database BbPersistenceManager.
CalendarEntryDbPersister.Default() - Constructor for class blackboard.persist.calendar.CalendarEntryDbPersister.Default
 
CAN_COPY - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
canCopy(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
CARD_NUMBER - Static variable in interface blackboard.data.user.UserDef
 
CARD_OFFICE_ADMIN - Static variable in class blackboard.data.user.User.SystemRole
Manages the front-end settings (tabs, modules, etc.) for portal-ecommerce functionality
Cartridge - Class in blackboard.data.course
The Cartridge class provides a representation of a cartridge record (as related to a course) within the Blackboard application.
Cartridge() - Constructor for class blackboard.data.course.Cartridge
Creates an instance of Cartridge with default property values.
CARTRIDGE - Static variable in interface blackboard.data.course.CourseDef
 
CARTRIDGE_ID - Static variable in interface blackboard.data.course.CourseDef
 
CartridgeDbLoader - Interface in blackboard.persist.course
This interface describes the set of methods that all database loaders for Cartridge objects must implement.
CartridgeDbLoader.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CartridgeDbLoader instance associated with the default instance of the database BbPersistenceManager.
CartridgeDbLoader.Default() - Constructor for class blackboard.persist.course.CartridgeDbLoader.Default
 
CartridgeDbPersister - Interface in blackboard.persist.course
This interface describes the set of methods that all database persisters for Cartridge objects must implement.
CartridgeDbPersister.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CartridgeDbPersister instance associated with the default instance of the database BbPersistenceManager.
CartridgeDbPersister.Default() - Constructor for class blackboard.persist.course.CartridgeDbPersister.Default
 
CartridgeDef - Interface in blackboard.data.course
CartridgeDef
CD_ROM_DRIVE_MAC - Static variable in interface blackboard.data.user.UserDef
 
CD_ROM_DRIVE_PC - Static variable in interface blackboard.data.user.UserDef
 
CFG_DEPLOY_PLUGINS - Static variable in interface blackboard.platform.plugin.Constants
 
CHAT_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-chatlink
checkAvailability(Content) - Static method in class blackboard.data.content.ContentManager
 
checkPermission(Permission) - Static method in class blackboard.platform.security.SecurityUtil
Performs a check for the specified permission against the installed SecurityManager.
CHILD_FILES - Static variable in interface blackboard.data.content.ContentFileDef
 
ChildFile - Class in blackboard.data.content
The ChildFile class wraps an uploaded file that is the child of a ContentFile.
ChildFile() - Constructor for class blackboard.data.content.ChildFile
Default constructor.
ChildFile.Action - Class in blackboard.data.content
 
ChildFileDef - Interface in blackboard.data.content
ChildFileDef
CITY - Static variable in interface blackboard.data.user.UserInfoDef
 
CLASSIFICATION - Static variable in interface blackboard.data.course.CourseDef
 
CLASSIFICATION_ID - Static variable in interface blackboard.data.course.CourseDef
 
ClassificationDef - Interface in blackboard.data.course
ClassificationDef
clear() - Method in class blackboard.base.BbDeleteTrackingList
Removes all of the elements from this list.
clear(FilterCacheByLoader) - Method in class blackboard.persist.Cache
Removes any element from the cache whose key passes the filter provided.
clearAssessmentId() - Method in class blackboard.data.gradebook.Lineitem
Clears the assessmentId and sets assessmentLocation to UNSET.
clearAttemptId() - Method in class blackboard.data.gradebook.Score
 
CLIENT_ID_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
clone() - Method in class blackboard.data.BbAttributes
This method clones the BbAttributes object, as well as creating new instances of the contained BbAttribute objects.
clone() - Method in class blackboard.data.BbObject
This method clones the BbObject as well as it's contained BbAttributes object.
COLLAB_SESSION - Static variable in class blackboard.data.content.Link.ReferredToType
 
COLLABSERVER_FULLHOSTNAME_DEFAULT - Static variable in class blackboard.platform.config.BbConfig
 
COLLABSERVER_PORTNUMBER_HTTP_DEFAULT - Static variable in class blackboard.platform.config.BbConfig
 
COLLABSERVER_PORTNUMBER_SSL_DEFAULT - Static variable in class blackboard.platform.config.BbConfig
 
COLLABSERVER_PORTNUMBER_TCP_DEFAULT - Static variable in class blackboard.platform.config.BbConfig
 
COMMENTS - Static variable in interface blackboard.data.content.CourseUploadDef
 
COMMUNITY - Static variable in class blackboard.data.course.Course.ServiceLevel
 
COMPANY - Static variable in interface blackboard.data.user.UserInfoDef
 
compare(Object, Object) - Method in class blackboard.base.BaseComparator
Applies the lined list of comparators to resolve the objects relationship.
compare(Object, Object) - Method in class blackboard.platform.plugin.PlugInComparator
Compares its two arguments for order.
compare(Version) - Method in class blackboard.platform.plugin.Version
Method to evaluate two versions.
compareFields(Object, Object) - Method in class blackboard.base.GenericFieldComparator
Compare method allowing explicit support for comparing objects that don't implement Comparable.
compareFields(Object, Object) - Method in class blackboard.base.GenericFieldFilter
Compare method allowing explicit support for comparing objects that don't implement Comparable.
compareTo(Object) - Method in class blackboard.base.BbEnum
The sole method of the Comparable interface.
compareTo(Object) - Method in class blackboard.data.user.User.InstRole
Deprecated.  
compareTo(Object) - Method in class blackboard.persist.Id
The sole method of the Comparable interface.
compareTo(Object) - Method in class blackboard.persist.PkId
The sole method of the Comparable interface.
compareTo(Object) - Method in class blackboard.persist.UnsetId
The sole method of the Comparable interface.
COMPONENT_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
configServiceInit(File, Properties) - Method in interface blackboard.platform.config.ConfigurationService
configServiceInit
ConfigurationService - Interface in blackboard.platform.config
Core platform service that provides access to file-system based configuration information.
configure(HttpAuthModule) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
Public API
Constants - Interface in blackboard.platform.plugin
Constants used in PlugIn management and deployment.
Container - Interface in blackboard.persist
The Container interface provides the basic framework for defining a "data source" against which the persistence framework can operate.
Content - Class in blackboard.data.content
The Content class is the root of the content class hierarchy.
Content() - Constructor for class blackboard.data.content.Content
Default constructor.
CONTENT - Static variable in class blackboard.data.content.CourseDocument.Type
Deprecated.  
CONTENT - Static variable in class blackboard.data.content.Link.ReferredToType
 
CONTENT - Static variable in class blackboard.data.content.Link.ReferrerType
 
CONTENT - Static variable in class blackboard.data.navigation.CourseToc.Target
Toc is a pointer to a content folder defined within the course
Content.RenderType - Class in blackboard.data.content
Class to encapsulate the hints used by the renderers.
CONTENT_AREA_1 - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co1 -- same as CourseDocument.Area.COURSE_INFORMATION
CONTENT_AREA_2 - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co2 -- same as CourseDocument.Area.COURSE_DOCUMENTS
CONTENT_AREA_3 - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co3 -- same as CourseDocument.Area.COURSE_ASSIGNMENTS
CONTENT_AREA_4 - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co4 -- same as CourseDocument.Area.COURSE_BOOKS
CONTENT_COURSE_ALLOWED_ROLES - Static variable in class blackboard.platform.plugin.PlugInUtil
Allowed user roles for editing course content
CONTENT_FILE - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-file
CONTENT_HANDLER - Static variable in interface blackboard.data.content.ContentDef
 
CONTENT_ID - Static variable in interface blackboard.data.content.ContentFileDef
 
CONTENT_ID - Static variable in interface blackboard.data.content.ContentStatusDef
 
CONTENT_SYS_ALLOWED_ROLES - Static variable in class blackboard.platform.plugin.PlugInUtil
Allowed system roles for editing course content
ContentConstants - Interface in blackboard.data.content
Shared constants for content.
ContentDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for Content objects must implement.
ContentDbLoader.Default - Class in blackboard.persist.content
A utility class that provides quick access to the ContentDbLoader instance associated with the default instance of the database BbPersistenceManager.
ContentDbLoader.Default() - Constructor for class blackboard.persist.content.ContentDbLoader.Default
 
ContentDbPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all database persisters for Content objects must implement.
ContentDbPersister.Default - Class in blackboard.persist.content
A utility class that provides quick access to the ContentDbPersister instance associated with the default instance of the database BbPersistenceManager.
ContentDbPersister.Default() - Constructor for class blackboard.persist.content.ContentDbPersister.Default
 
ContentDef - Interface in blackboard.data.content
ContentDef
ContentFile - Class in blackboard.data.content
The ContentFile class wraps a reference to a file that has been uploaded to a content area in a course.
ContentFile() - Constructor for class blackboard.data.content.ContentFile
Default constructor.
ContentFile(BbFile) - Constructor for class blackboard.data.content.ContentFile
Constructor that builds some defaults based on the given BbFile argument.
ContentFile.Action - Class in blackboard.data.content
Type-safe enumeration of possible values for the Action attribute of a file.
ContentFile.StorageType - Class in blackboard.data.content
Type-safe enumeration of possible values for the StorageType attribute of a file.
ContentFileDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for ContentFile objects must implement.
ContentFileDbLoader.Default - Class in blackboard.persist.content
A utility class that provides quick access to the ContentFileDbLoader instance associated with the default instance of the database BbPersistenceManager.
ContentFileDbLoader.Default() - Constructor for class blackboard.persist.content.ContentFileDbLoader.Default
 
ContentFileDbPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all database persisters for Content objects must implement.
ContentFileDbPersister.Default - Class in blackboard.persist.content
A utility class that provides quick access to the ContentDbPersister instance associated with the default instance of the database BbPersistenceManager.
ContentFileDbPersister.Default() - Constructor for class blackboard.persist.content.ContentFileDbPersister.Default
 
ContentFileDef - Interface in blackboard.data.content
ContentFileDef
ContentFileRef - Class in blackboard.data.content
ContentFileRef represents a file reference that can be displayed within a Lesson.
ContentFileRef() - Constructor for class blackboard.data.content.ContentFileRef
Default constructor.
ContentFolder - Class in blackboard.data.content
The ContentFolder class is a representation of a folder within the Bb Course Management System.
ContentFolder() - Constructor for class blackboard.data.content.ContentFolder
Default constructor; ensures that the appropriate attributes in Content are over-ridden, including ContentHandler and IsFolder.
ContentHandlerDbLoader - Interface in blackboard.platform.plugin
Interface for loading Content Handler objects from the database.
ContentHandlerDbLoader.Default - Class in blackboard.platform.plugin
A utility class that provides quick access to the ContentHandlerLoader instance associated with the default instance of the database BbPersistenceManager.
ContentHandlerDbLoader.Default() - Constructor for class blackboard.platform.plugin.ContentHandlerDbLoader.Default
 
ContentHandlerDbPersister - Interface in blackboard.platform.plugin
Interface for storing content handler objects into the database.
ContentHandlerDef - Interface in blackboard.platform.plugin
 
ContentHandlerStrings - Interface in blackboard.data.content
Interface used to define the content handler strings for builtin content types.
ContentHandlerWrapper - Class in blackboard.data.content
 
ContentHandlerXmlLoader - Interface in blackboard.platform.plugin
ContentHandlerXmlLoader
ContentHandlerXmlPersister - Interface in blackboard.platform.plugin
ContentHandlerXmlPersister
ContentManager - Class in blackboard.data.content
 
ContentManager() - Constructor for class blackboard.data.content.ContentManager
 
ContentStatus - Class in blackboard.data.content
The ContentStatus object wraps the state of a user's interaction with a given piece of content and adaptive release status.
ContentStatus() - Constructor for class blackboard.data.content.ContentStatus
Default constructor.
ContentStatusDbLoader - Interface in blackboard.persist.content
Loader interface for ContentStatusobjects, which encapsulate a learner's adaptive release status, and review status for associated Contentobjects.
ContentStatusDbLoader.Default - Class in blackboard.persist.content
Standard convenience accessor to get an instance of this loader.
ContentStatusDbLoader.Default() - Constructor for class blackboard.persist.content.ContentStatusDbLoader.Default
 
ContentStatusDef - Interface in blackboard.data.content
Persistence constants for ContentStatusDef
ContentStatusXmlLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all xml loaders for ContentStatus objects must implement.
ContentStatusXmlPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all xml persisters for ContentStatus objects must implement.
ContentVisitor - Interface in blackboard.data.content
Interface for content visitor (Visitor Pattern).
ContentWrapper - Class in blackboard.data.content
 
ContextManager - Interface in blackboard.platform.context
Service that manages the Context used by service APIs for information about the current user, virtual installation, etc.
CONTINUOUS - Static variable in class blackboard.data.course.Course.Duration
Course is active on an ongoing basis.
convertToBaseComparator(Comparator) - Static method in class blackboard.base.BaseComparator
Wraps any comparator in an instance of BaseComparator that proxies through to the supplied comparator.
COUNTRY - Static variable in interface blackboard.data.user.UserInfoDef
 
COURSE - Static variable in class blackboard.data.announcement.Announcement.Type
The announcement is associated with a course, and viewable from that course's (or organization's) Announcements tool.
COURSE - Static variable in class blackboard.data.calendar.CalendarEntry.Type
The entry is associated with a course, and is viewable from the course's (or organization's) calendar tool.
Course - Class in blackboard.data.course
The Course class provides a representation of a course (course or organization) within the Blackboard application.
Course() - Constructor for class blackboard.data.course.Course
Creates an instance of Course with default property values.
Course.Duration - Class in blackboard.data.course
Specifies the intended length of the course.
Course.Enrollment - Class in blackboard.data.course
 
Course.NavStyle - Class in blackboard.data.course
Defines the navigation style for this course.
Course.Pace - Class in blackboard.data.course
Defines the intended educational pace set for this course.
Course.ServiceLevel - Class in blackboard.data.course
 
COURSE_ASSESSMENT - Static variable in class blackboard.data.content.Link.ReferredToType
 
COURSE_ASSIGNMENTS - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co3
COURSE_BOOKS - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co4
COURSE_BUILDER - Static variable in class blackboard.data.course.CourseMembership.Role
 
COURSE_CONTENT_ID - Static variable in interface blackboard.data.content.LinkDef
 
COURSE_CREATOR - Static variable in class blackboard.data.user.User.SystemRole
Course creator role.
COURSE_DATA_TYPE - Static variable in class blackboard.data.course.Course
Deprecated. Use the constant Course.DATA_TYPE instead
COURSE_DOCUMENT_DATA_TYPE - Static variable in class blackboard.data.content.CourseDocument
Deprecated. Use the constant CourseDocument.DATA_TYPE instead
COURSE_DOCUMENTS - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co2
COURSE_ID - Static variable in interface blackboard.data.content.AggregateReviewStatusDef
 
COURSE_ID - Static variable in interface blackboard.data.content.ContentDef
 
COURSE_ID - Static variable in interface blackboard.data.content.StaffInfoDef
 
COURSE_ID - Static variable in interface blackboard.data.course.CourseDef
 
COURSE_ID - Static variable in interface blackboard.data.course.CourseMembershipDef
 
COURSE_ID - Static variable in interface blackboard.data.course.GroupDef
 
COURSE_INFORMATION - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated. co1
COURSE_MEMBERSHIP_DATA_TYPE - Static variable in class blackboard.data.course.CourseMembership
Deprecated. Use the constant CourseMembership.DATA_TYPE instead
COURSE_MEMBERSHIP_ID - Static variable in interface blackboard.data.content.UploadDef
 
COURSE_MEMBERSHIP_ID - Static variable in interface blackboard.data.course.GroupMembershipDef
 
COURSE_SUPPORT - Static variable in class blackboard.data.user.User.SystemRole
Course support role.
COURSE_TOC - Static variable in class blackboard.data.content.Link.ReferredToType
 
COURSE_TOC - Static variable in class blackboard.data.content.Link.ReferrerType
 
COURSE_TOC_ID - Static variable in interface blackboard.data.content.LinkDef
 
CourseDbLoader - Interface in blackboard.persist.course
This interface describes the set of methods that all database loaders for Course objects must implement.
CourseDbLoader.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CourseDbLoader instance associated with the default instance of the database BbPersistenceManager.
CourseDbLoader.Default() - Constructor for class blackboard.persist.course.CourseDbLoader.Default
 
CourseDbPersister - Interface in blackboard.persist.course
This interface describes the set of methods that all database persisters for Course objects must implement.
CourseDbPersister.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CourseDbPersister instance associated with the default instance of the database BbPersistenceManager.
CourseDbPersister.Default() - Constructor for class blackboard.persist.course.CourseDbPersister.Default
 
CourseDef - Interface in blackboard.data.course
CourseDef
CourseDocument - Class in blackboard.data.content
The CourseDocument class is a representation of a course document within the Bb Course Management System.
CourseDocument() - Constructor for class blackboard.data.content.CourseDocument
Default constructor.
CourseDocument.Area - Class in blackboard.data.content
Deprecated. Content areas are no longer used within the course environment. Instead, CourseToc objects are used, which point to different top level folders
CourseDocument.Type - Class in blackboard.data.content
Deprecated. This enumeration is superceded by Content.RenderType
CourseFileManager - Class in blackboard.platform.filesystem
A service that retrieves the appropiate File object representing the path to a content file for a course in the Blackboard application.
CourseFileManager() - Constructor for class blackboard.platform.filesystem.CourseFileManager
 
COURSELINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-courselink
CourseLink - Class in blackboard.data.content
The CourseLink class is a representation of an intra-course link within the Bb Course Management System.
CourseLink() - Constructor for class blackboard.data.content.CourseLink
Default constructor.
CourseMembership - Class in blackboard.data.course
The CourseMembership class is a representation of a course membership record within the Blackboard application.
CourseMembership() - Constructor for class blackboard.data.course.CourseMembership
Creates an instance of CourseMembership with default property values.
CourseMembership.Role - Class in blackboard.data.course
 
CourseMembershipDbLoader - Interface in blackboard.persist.course
This interface describes the set of methods that all database loaders for CourseMembership objects must implement.
CourseMembershipDbLoader.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CourseMembershipDbLoader instance associated with the default instance of the database BbPersistenceManager.
CourseMembershipDbLoader.Default() - Constructor for class blackboard.persist.course.CourseMembershipDbLoader.Default
 
CourseMembershipDbPersister - Interface in blackboard.persist.course
This interface describes the set of methods that all database persisters for CourseMembership objects must implement.
CourseMembershipDbPersister.Default - Class in blackboard.persist.course
A utility class that provides quick access to the CourseMembershipDbPersister instance associated with the default instance of the database BbPersistenceManager.
CourseMembershipDbPersister.Default() - Constructor for class blackboard.persist.course.CourseMembershipDbPersister.Default
 
CourseMembershipDef - Interface in blackboard.data.course
CourseMembershipDef
CourseMembershipRoleFilter - Class in blackboard.data.course
 
CourseMembershipRoleFilter(CourseMembership.Role) - Constructor for class blackboard.data.course.CourseMembershipRoleFilter
 
CourseQuota - Class in blackboard.data.course
The CourseQuota class provides convenience methods and accessor methods that encapsulate common routines that are needed when using Course quotas.
CourseQuota(Course) - Constructor for class blackboard.data.course.CourseQuota
 
CourseToc - Class in blackboard.data.navigation
The CourseToc class provides a representation of the left hand navigation items displayed when inside a course in the Bb CMS.
CourseToc() - Constructor for class blackboard.data.navigation.CourseToc
Creates an instance of Course with default property values.
CourseToc.Target - Class in blackboard.data.navigation
 
CourseTocDbLoader - Interface in blackboard.persist.navigation
This interface describes the set of methods that all database loaders for CourseToc objects must implement.
CourseTocDbLoader.Default - Class in blackboard.persist.navigation
A utility class that provides quick access to the CourseTocDbLoader instance associated with the default instance of the database BbPersistenceManager.
CourseTocDbLoader.Default() - Constructor for class blackboard.persist.navigation.CourseTocDbLoader.Default
 
CourseUpload - Class in blackboard.data.content
The CourseUpload class wraps a reference to a file that has been uploaded to the digital drop box in a course.
CourseUpload() - Constructor for class blackboard.data.content.CourseUpload
Default constructor.
CourseUpload.Status - Class in blackboard.data.content
Status
CourseUploadDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for CourseUpload objects must implement.
CourseUploadDbPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all database persisters for CourseUpload objects must implement.
CourseUploadDef - Interface in blackboard.data.content
CourseUploadDef
createAvailabilityFilter(boolean) - Static method in class blackboard.data.course.Course
Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course "availability".
createCourseIdFilter(Id) - Static method in class blackboard.data.announcement.Announcement
Factory method to create an instance of the ListFilter interface capable of filtering a list of Announcement objects based upon their course Id value.
createCourseIdFilter(Id) - Static method in class blackboard.data.calendar.CalendarEntry
Factory method to create an instance of the ListFilter interface capable of filtering a list of CalendarEntry objects based upon their course Id value.
createDurationFilter(Date, BbList) - Static method in class blackboard.data.course.Course
Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the course duration availability.
createInstance(Course) - Static method in class blackboard.data.course.CourseQuota
 
createMembershipRoleFilter(BbList, CourseMembership.Role) - Static method in class blackboard.data.course.Course
Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses.
createMembershipRoleFilter(BbList, CourseMembership.Role, boolean) - Static method in class blackboard.data.course.Course
Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses.
createServiceLevelFilter(Course.ServiceLevel) - Static method in class blackboard.data.course.Course
Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course service level (as returned by Course.getServiceLevelType()).
createSignedLicense(License) - Static method in class blackboard.platform.LicenseUtil
 
createSignedLicenseManager(LicenseManager) - Static method in class blackboard.platform.LicenseUtil
 
createTempFile() - Method in interface blackboard.platform.config.ConfigurationService
Creates a temp file in the Bb temp file space.
createTypeFilter(CalendarEntry.Type) - Static method in class blackboard.data.calendar.CalendarEntry
Factory method to create an instance of the ListFilter interface capable of filtering a list of CalendarEntry objects based upon their CalendarEntry.Type value.
CS - Static variable in class blackboard.data.content.ContentFile.StorageType
 
CS_DB_CMS_USER_PASS - Static variable in class blackboard.platform.config.BbConfig
 
CS_DB_SA_USER - Static variable in class blackboard.platform.config.BbConfig
 
CS_DB_SYSTEMUSER_PASS - Static variable in class blackboard.platform.config.BbConfig
 
CS_EXTERNAL_DATA_COURSES - Static variable in class blackboard.platform.config.BbConfig
 
CS_EXTERNAL_DATA_INST - Static variable in class blackboard.platform.config.BbConfig
 
CS_EXTERNAL_DATA_LIBRARY - Static variable in class blackboard.platform.config.BbConfig
 
CS_EXTERNAL_DATA_ORGS - Static variable in class blackboard.platform.config.BbConfig
 
CS_EXTERNAL_DATA_USERS - Static variable in class blackboard.platform.config.BbConfig
 
CS_VIRTUAL_SERVER_NAME - Static variable in class blackboard.platform.config.BbConfig
 
CTX_PATH_KEY - Static variable in interface blackboard.data.content.ContentConstants
Key for content caching of path to current content item
CustomData - Class in blackboard.portal.external
The CustomData class provides module developers access to read and edit custom data associated either with the module in general or with a users specific personalization settings.

D

DATA_SOURCE_ID - Static variable in interface blackboard.data.course.ClassificationDef
 
DATA_SOURCE_ID - Static variable in interface blackboard.data.course.CourseDef
 
DATA_SOURCE_ID - Static variable in interface blackboard.data.course.CourseMembershipDef
 
DATA_SOURCE_ID - Static variable in interface blackboard.data.user.UserDef
 
DATA_TYPE - Static variable in class blackboard.data.announcement.Announcement
 
DATA_TYPE - Static variable in class blackboard.data.calendar.CalendarEntry
Constant used to identify data type
DATA_TYPE - Static variable in class blackboard.data.content.AggregateReviewStatus
 
DATA_TYPE - Static variable in class blackboard.data.content.ChildFile
 
DATA_TYPE - Static variable in class blackboard.data.content.Content
 
DATA_TYPE - Static variable in class blackboard.data.content.ContentFile
 
DATA_TYPE - Static variable in class blackboard.data.content.ContentFileRef
 
DATA_TYPE - Static variable in class blackboard.data.content.ContentFolder
Object data type constant
DATA_TYPE - Static variable in class blackboard.data.content.ContentStatus
 
DATA_TYPE - Static variable in class blackboard.data.content.CourseDocument
 
DATA_TYPE - Static variable in class blackboard.data.content.CourseLink
 
DATA_TYPE - Static variable in class blackboard.data.content.CourseUpload
 
DATA_TYPE - Static variable in class blackboard.data.content.ExternalLink
 
DATA_TYPE - Static variable in class blackboard.data.content.GroupUpload
 
DATA_TYPE - Static variable in class blackboard.data.content.Lesson
 
DATA_TYPE - Static variable in class blackboard.data.content.Link
 
DATA_TYPE - Static variable in class blackboard.data.content.StaffInfo
Standard data object type constant
DATA_TYPE - Static variable in class blackboard.data.content.StaffInfoFolder
Standard persistence object data type constant
DATA_TYPE - Static variable in class blackboard.data.content.UploadedFile
 
DATA_TYPE - Static variable in class blackboard.data.course.Cartridge
 
DATA_TYPE - Static variable in class blackboard.data.course.Course
Object data type constant used in brokering loaders and persisters
DATA_TYPE - Static variable in class blackboard.data.course.CourseMembership
 
DATA_TYPE - Static variable in class blackboard.data.course.Group
 
DATA_TYPE - Static variable in class blackboard.data.course.GroupMembership
 
DATA_TYPE - Static variable in class blackboard.data.navigation.CourseToc
 
DATA_TYPE - Static variable in class blackboard.data.role.PortalRole
 
DATA_TYPE - Static variable in class blackboard.data.user.User
Object data type constant, used in finding loaders and persisters
DATA_TYPE - Static variable in class blackboard.data.user.UserRole
 
DATA_VERSION - Static variable in interface blackboard.data.content.ContentDef
 
DATABASE_BBADMIN_DB_DATADIR - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_DB_DATADIR_WIN - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_DB_MSSQL_LOGDIR_WIN - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_DB_NAME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_DB_ORACLE_INDEXDIR - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_DB_PASSWORD - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_FULLHOSTNAME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_INSTANCENAME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_MACHINENAME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_ORACLE_INSTANCENAMETYPE - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_PORTNUMBER - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_BBADMIN_MACHINE_SYSTEMUSERPASSWORD - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_LOCAL_ORACLE_HOME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_TYPE - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_VI_DB_NAME - Static variable in class blackboard.platform.config.BbConfig
 
DATABASE_VI_DB_PASSWORD - Static variable in class blackboard.platform.config.BbConfig
 
DatabaseContainer - Class in blackboard.persist
The DatabaseContainer class implements the Container interface for a database.
DatabaseContainer(BbDatabase) - Constructor for class blackboard.persist.DatabaseContainer
Constructor - creates a new DatabaseContainer object with the given BbDatabase used to define the specifics of the data source.
DataType - Class in blackboard.persist
The DataType class provides a means of encapsulating the type of data objects as defined within the persistence framework.
DataType(String) - Constructor for class blackboard.persist.DataType
Deprecated. Use DataType.DataType(Class) instead.
DataType(Class) - Constructor for class blackboard.persist.DataType
Creates a new DataType object with the given class value as the unique data type identifier.
DATE_RANGE - Static variable in class blackboard.data.course.Course.Duration
Course is only intended to be available between specific date ranges
deactivatePlugIn(Id) - Method in class blackboard.platform.plugin.PlugInManager
Sets plugins status to inactive and unregisters the webapp
debug() - Method in class blackboard.base.SharableArrayList
Prints ArrayList elements for debugging.
DEBUG - Static variable in class blackboard.platform.log.LogService.Verbosity
Used to log all messages.
DEFAULT - Static variable in class blackboard.base.FormattedText.Type
Value used when not specifically identified.
DEFAULT - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
DEFAULT - Static variable in class blackboard.data.announcement.Announcement.Type
Default is COURSE.
DEFAULT - Static variable in class blackboard.data.BbAttribute.Type
 
DEFAULT - Static variable in class blackboard.data.calendar.CalendarEntry.Type
The default is PERSONAL.
DEFAULT - Static variable in class blackboard.data.content.ChildFile.Action
 
DEFAULT - Static variable in class blackboard.data.content.Content.RenderType
 
DEFAULT - Static variable in class blackboard.data.content.ContentFile.Action
 
DEFAULT - Static variable in class blackboard.data.content.ContentFile.StorageType
 
DEFAULT - Static variable in class blackboard.data.content.CourseDocument.Area
Deprecated.  
DEFAULT - Static variable in class blackboard.data.content.CourseDocument.Type
Deprecated.  
DEFAULT - Static variable in class blackboard.data.content.CourseUpload.Status
 
DEFAULT - Static variable in class blackboard.data.content.Link.ReferredToType
 
DEFAULT - Static variable in class blackboard.data.content.Link.ReferrerType
 
DEFAULT - Static variable in class blackboard.data.content.UploadedFile.Action
 
DEFAULT - Static variable in class blackboard.data.course.Course.Duration
Default value, CONTINUOUS
DEFAULT - Static variable in class blackboard.data.course.Course.Enrollment
 
DEFAULT - Static variable in class blackboard.data.course.Course.NavStyle
Default is TEXT
DEFAULT - Static variable in class blackboard.data.course.Course.Pace
Default is INSTRUCTOR_LED
DEFAULT - Static variable in class blackboard.data.course.Course.ServiceLevel
 
DEFAULT - Static variable in class blackboard.data.course.CourseMembership.Role
 
DEFAULT - Static variable in class blackboard.data.gradebook.ReportingPeriod
 
DEFAULT - Static variable in class blackboard.data.navigation.CourseToc.Target
 
DEFAULT - Static variable in class blackboard.data.user.User.EducationLevel
Default is FRESHMAN
DEFAULT - Static variable in class blackboard.data.user.User.Gender
Default is UNKNOWN
DEFAULT - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
DEFAULT - Static variable in class blackboard.data.user.User.SystemRole
Default role is USER
DEFAULT - Static variable in class blackboard.platform.log.LogService.Verbosity
Default is DEBUG; however this is typically over-ridden in the service configuration file.
DEFAULT_LOCALE - Static variable in interface blackboard.platform.plugin.PlugInDef
 
DEFAULT_PK2 - Static variable in class blackboard.persist.PkId
 
defineAlias(BbEnum) - Static method in class blackboard.base.BbEnum
Define a value as a pointer to another value.
defineDefault(BbEnum) - Static method in class blackboard.base.BbEnum
Sets the default object for the enumeration.
defineNewFileLog(String, String, LogService.Verbosity, boolean) - Method in interface blackboard.platform.log.LogService
Convenience method to create a new file-based log.
defineNewFileLog(String, String, LogService.Verbosity, BbLocale, boolean) - Method in interface blackboard.platform.log.LogService
Convenience method to create a new file-based log.
deleteAllByUserId(Id) - Method in interface blackboard.persist.user.UserRoleDbPersister
Deletes the UserRoles associated with the given user Id value using a connection from the associated persistence manager's database container.
deleteAllByUserId(Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbPersister
Deletes the UserRoles identified by the given user value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.announcement.AnnouncementDbPersister
Deletes the Announcement identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbPersister
Deletes the Announcement identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.calendar.CalendarEntryDbPersister
Deletes the CalendarEntry identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbPersister
Deletes the CalendarEntry identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.content.ContentDbPersister
Deletes the Content identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Deletes the Content identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.content.ContentFileDbPersister
Deletes the Content identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.content.ContentFileDbPersister
Deletes the Content identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.content.LinkDbPersister
Deletes the Link identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.content.LinkDbPersister
Deletes the Link identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.content.StaffInfoDbPersister
Deletes the StaffInfo identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbPersister
Deletes the StaffInfo identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.course.CartridgeDbPersister
Deletes the Cartridge identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.course.CartridgeDbPersister
Deletes the Cartridge identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.course.CourseDbPersister
Deletes the Course identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.course.CourseDbPersister
Deletes the Course identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.course.CourseMembershipDbPersister
Deletes the CourseMembership identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbPersister
Deletes the CourseMembership identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.course.GroupDbPersister
Deletes the Group identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.course.GroupDbPersister
Deletes the Group identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.course.GroupMembershipDbPersister
Deletes the GroupMembership identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbPersister
Deletes the GroupMembership identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Deletes the Lineitem with the given Id from the database using a connection obtained through this object's database context.
deleteById(Id, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Deletes the Lineitem with the given Id from the database using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Deletes the Score identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Deletes the Score identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.role.PortalRoleDbPersister
Deletes the PortalRole identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.role.PortalRoleDbPersister
Deletes the PortalRole identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.user.UserDbPersister
Deletes the User identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.user.UserDbPersister
Deletes the User identified by the given Id value using the supplied connection.
deleteById(Id) - Method in interface blackboard.persist.user.UserRoleDbPersister
Deletes the UserRole identified by the given Id value using a connection from the associated persistence manager's database container.
deleteById(Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbPersister
Deletes the UserRole identified by the given Id value using the supplied connection.
DELIMITER - Static variable in class blackboard.platform.plugin.Version
Static value for string construction and parsing.
DEPARTMENT - Static variable in interface blackboard.data.user.UserInfoDef
 
DEPLOY_TYPE - Static variable in interface blackboard.platform.plugin.PlugInDef
 
DESCENDING - Static variable in class blackboard.base.BaseComparator
DESCENDING constant for use in this class's constructor.
DESCRIPTION - Static variable in interface blackboard.data.course.ButtonStyleDef
 
DESCRIPTION - Static variable in interface blackboard.data.course.CartridgeDef
 
DESCRIPTION - Static variable in interface blackboard.data.course.CourseDef
 
DESCRIPTION - Static variable in interface blackboard.data.course.GroupDef
 
DESCRIPTION - Static variable in interface blackboard.platform.plugin.PlugInDef
 
disablePlugIn(Id) - Method in class blackboard.platform.plugin.PlugInManager
Disables the plugin specified by Id.
disassociateCurrentSessionAndUser() - Method in class blackboard.platform.security.authentication.SessionStub
If the userId is associated with a valid user record in the database, then the current session should be associated with that user record, in the database.
doAuthenticate(HttpServletRequest, HttpServletResponse) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Performs the work of authentication.
doAuthenticate(Hashtable, SessionStub, boolean) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Implementation specific version of doAuthenticate which does additional checking before calling authenticate.
doAuthenticate(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Performs the actual, implementation-specific work of authentication.
doCompare(Object, Object) - Method in class blackboard.base.BaseComparator
Subclasses must override this method to provide functionality.
doCompare(Object, Object) - Method in class blackboard.base.GenericFieldComparator
Implementation of BaseComparator.doCompare().
DOCUMENT - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-document
doLogout(HttpServletRequest, HttpServletResponse) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Implementation method.
doLogout(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Performs the actual, implementation-specific work of invalidating the user's authentication status.
DOUBLE - Static variable in class blackboard.data.BbAttribute.Type
 
DURATION_TYPE - Static variable in interface blackboard.data.course.CourseDef
 

E

ECOMMERCE_ADMIN - Static variable in class blackboard.data.user.User.SystemRole
Manages the back-end settings for portal-ecommerce functionality
EDUCATION_LEVEL - Static variable in interface blackboard.data.user.UserDef
 
EMAIL - Static variable in interface blackboard.data.content.StaffInfoDef
 
EMAIL_ADDRESS - Static variable in interface blackboard.data.user.UserInfoDef
 
EMAIL_ENROLLMENT - Static variable in class blackboard.data.course.Course.Enrollment
Instructors have the ability to enroll users, and students can email requests to the instructor for enrollment
EMBED - Static variable in class blackboard.data.content.ContentFile.Action
 
EMBED - Static variable in class blackboard.data.content.UploadedFile.Action
 
enablePlugIn(Id) - Method in class blackboard.platform.plugin.PlugInManager
Enables the specified plugin.
encodeNavigationItemURL(HttpServletRequest, String) - Method in interface blackboard.platform.session.BbSession
Performs url parse/replace operation for navigation item specific entities.
encodeSessionContext(String) - Method in interface blackboard.platform.session.BbSession
Encodes this session's id on the given url as a request parameter formatted as "?
encodeTemplateUrl(HttpServletRequest, String) - Method in interface blackboard.platform.session.BbSession
Encodes context information on the given url as required by the template based format.
ENCODING - Static variable in class blackboard.platform.config.BbConfig
Encoding character set used to handle streaming input and byte handling
END_DATE - Static variable in interface blackboard.data.content.ContentDef
 
END_DATE - Static variable in interface blackboard.data.course.CourseDef
 
ENROLLMENT_ACCESS_CODE - Static variable in interface blackboard.data.course.CourseDef
 
ENROLLMENT_DATE - Static variable in interface blackboard.data.course.CourseMembershipDef
 
ENROLLMENT_END_DATE - Static variable in interface blackboard.data.course.CourseDef
 
ENROLLMENT_START_DATE - Static variable in interface blackboard.data.course.CourseDef
 
ENROLLMENT_TYPE - Static variable in interface blackboard.data.course.CourseDef
 
equals(Object) - Method in class blackboard.base.FormattedText
Overrides the equals() method in Object to provide a simple way to compare two FormattedText objects.
EQUALS - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
equals(Object) - Method in class blackboard.data.user.User.InstRole
Deprecated.  
equals(Object) - Method in class blackboard.persist.CacheKey
 
equals(Object) - Method in class blackboard.persist.DatabaseContainer
 
equals(Object) - Method in class blackboard.persist.DataType
Indicates whether the given object is "equal to" this one.
equals(Object) - Method in class blackboard.persist.Id
Overrides the equals() method in Object to provide a simple way to compare two Ids.
equals(Object) - Method in class blackboard.persist.PkId
Overrides the equals() method in Object to provide a simple way to compare two PkIds.
equals(Object) - Method in class blackboard.persist.UnsetId
Overrides the equals() method in Object to provide a simple way to compare two UnsetId s.
equals(Object) - Method in class blackboard.platform.log.LogService.Verbosity
 
EQUALS - Static variable in class blackboard.platform.plugin.Version
Static value for compare() method return value.
ERROR - Static variable in class blackboard.platform.log.LogService.Verbosity
Used to log messages resulting from system errors.
ERROR_MSG - Static variable in class blackboard.platform.ApplicationLauncher
 
execute() - Method in interface blackboard.platform.Application
Executes application logic.
EXITED - Static variable in class blackboard.platform.StatusCode
 
EXPIRATION_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
EXPIRATION_ATTR_FORMAT - Static variable in class blackboard.platform.License.XmlDef
 
EXPIRATION_ATTR_NEVER - Static variable in class blackboard.platform.License.XmlDef
 
EXTERNAL - Static variable in class blackboard.data.gradebook.Lineitem.AssessmentLocation
assessmentId points to an assessment on an external system.
EXTERNAL - Static variable in class blackboard.data.gradebook.Score.AttemptLocation
The attempt data is external to Blackboard.
EXTERNAL_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-externallink
EXTERNAL_LINK_DATA_TYPE - Static variable in class blackboard.data.content.ExternalLink
Deprecated. Use the constant ExternalLink.DATA_TYPE instead
ExternalLink - Class in blackboard.data.content
The ExternalLink class is a representation of an external link within the Bb Course Management System.
ExternalLink() - Constructor for class blackboard.data.content.ExternalLink
Default constructor.

F

FACULTY - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
FAILURE - Static variable in class blackboard.platform.ResultCode
 
FAMILY_NAME - Static variable in interface blackboard.data.content.StaffInfoDef
 
FAMILY_NAME - Static variable in interface blackboard.data.user.UserInfoDef
 
FATAL - Static variable in class blackboard.platform.log.LogService.Verbosity
Used to log messages that cause severe disruption to the system.
FAVORITE_LINKS - Static variable in interface blackboard.data.course.CourseMembershipDef
 
FEE - Static variable in interface blackboard.data.course.CourseDef
 
FEMALE - Static variable in class blackboard.data.user.User.Gender
Female
FILE - Static variable in class blackboard.data.content.Content.RenderType
Renders the underlying object as a reference to a single file.
FILE_ACTION - Static variable in interface blackboard.data.content.UploadedFileDef
 
FILE_ID - Static variable in interface blackboard.data.content.UploadDef
 
FILE_NAME - Static variable in interface blackboard.data.content.UploadedFileDef
 
FILE_ONLY_LESSON - Static variable in class blackboard.data.content.CourseDocument.Type
Deprecated.  
FILE_SIZE - Static variable in interface blackboard.data.content.UploadedFileDef
 
FileSystemException - Exception in blackboard.platform.filesystem
 
FileSystemException(String) - Constructor for exception blackboard.platform.filesystem.FileSystemException
Constructor
FileSystemException(String, Exception) - Constructor for exception blackboard.platform.filesystem.FileSystemException
Constructor
FileSystemService - Interface in blackboard.platform.filesystem
Interface for FileSystemServiceImpl class.
filterByAvailability(boolean) - Method in class blackboard.base.FilteringIterator
Applies the availability filter, AvailabilityFilter, to this FilteringIterator.
FilterCacheByLoader - Class in blackboard.persist
The FilterCacheByLoader filters out given objects that are cacheKey with specified Loader.
FilterCacheByLoader() - Constructor for class blackboard.persist.FilterCacheByLoader
 
FilterCacheByLoader(String) - Constructor for class blackboard.persist.FilterCacheByLoader
 
FilteringIterator - Class in blackboard.base
The FilteringIterator class provides a means of applying a set of "filters" to an iterator.
FilteringIterator(Iterator) - Constructor for class blackboard.base.FilteringIterator
Creates a FilteringIterator using the supplied Iterator.
FilteringIterator(Iterator, ListFilter) - Constructor for class blackboard.base.FilteringIterator
Creates a FilteringIterator using the supplied Iterator and applying the "filtering" specified by the given ListFilter.
FINAL - Static variable in class blackboard.data.gradebook.ReportingPeriod
 
FIXED_NUM_DAYS - Static variable in class blackboard.data.course.Course.Duration
Course is only available for a set number of days
FLOAT - Static variable in class blackboard.data.BbAttribute.Type
 
flushAll() - Method in class blackboard.persist.Cache
 
flushEntry(String) - Method in class blackboard.persist.Cache
 
flushGroup(String) - Method in class blackboard.persist.Cache
 
FOLDER - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-folder
Folder - Interface in blackboard.data.content
The Folder is the root of the content folder class hierarchy.
formatPropertyValue(Object) - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
FormattedText - Class in blackboard.base
The FormattedText class provides a means for storing a piece of text along with a companion formatting specification.
FormattedText() - Constructor for class blackboard.base.FormattedText
Default constructor; creates an empty string with FormattedText.Type.SMART.
FormattedText(String, FormattedText.Type) - Constructor for class blackboard.base.FormattedText
Constructor, presets the string value and type.
FORMATTEDTEXT - Static variable in class blackboard.data.BbAttribute.Type
 
FormattedText.Type - Class in blackboard.base
Enumeration class to specify possible text formats.
FORUM - Static variable in class blackboard.data.content.Link.ReferredToType
 
FORUM_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-forumlink
FRESHMAN - Static variable in class blackboard.data.user.User.EducationLevel
College or university freshman.
fromExternalString(String, Class) - Static method in class blackboard.base.BbEnum
Returns the BbEnum element specified by the externalString in the target enumeration class, enumClass.
fromExternalString(String) - Static method in class blackboard.base.FormattedText.Type
Returns the FormattedText.Type element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.announcement.Announcement.Type
Returns the Announcement.Type element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.BbAttribute.Type
Returns the BbAttribute.Type element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.calendar.CalendarEntry.Type
Returns the CalendarEntry.Type element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.content.ChildFile.Action
Returns the ChildFile.Action element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.Content.RenderType
Returns the Content.Rendertype element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.content.ContentFile.Action
Returns the ContentFile.Action element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.ContentFile.StorageType
Returns the ContentFile.StorageType element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.CourseDocument.Area
Deprecated. Returns the CourseDocument.Area element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.CourseDocument.Type
Deprecated. Returns the CourseDocument.Type element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.Link.ReferredToType
Returns the Link.ReferredToType element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.Link.ReferrerType
Returns the Link.ReferrerType element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.content.UploadedFile.Action
Returns the Action element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.course.Course.Duration
Returns the Course.Duration element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.course.Course.Enrollment
Returns the Course.Enrollment element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.course.Course.NavStyle
Returns the Course.NavStyle element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.course.Course.Pace
Returns the Course.Pace element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.course.Course.ServiceLevel
Returns the Course.ServiceLevel element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.course.CourseMembership.Role
Returns the CourseMembership.Role element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.gradebook.ReportingPeriod
Returns the ReportingPeriod element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.navigation.CourseToc.Target
Returns the CourseToc.Target element specified by the externalString .
fromExternalString(String) - Static method in class blackboard.data.user.User.EducationLevel
Returns the User.EducationLevel element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.user.User.Gender
Returns the User.Gender element specified by the externalString.
fromExternalString(String, Class) - Static method in class blackboard.data.user.User.InstRole
Deprecated.  
fromExternalString(String) - Static method in class blackboard.data.user.User.InstRole
Deprecated. Returns the User.InstRole element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.data.user.User.SystemRole
Returns the User.SystemRole element specified by the externalString.
fromExternalString(String) - Static method in class blackboard.platform.log.LogService.Verbosity
Generates the proper enumerated object from a string representation.
fromFieldName(String, Class) - Static method in class blackboard.base.BbEnum
Returns the BbEnum element specified by the fieldName in the target enumeration class, enumClass.
fromFieldName(String, Class, boolean) - Static method in class blackboard.base.BbEnum
Returns the BbEnum element specified by the fieldName in the target enumeration class, enumClass.
fromFieldName(String) - Static method in class blackboard.base.FormattedText.Type
Returns the FormattedText.Type element specified by the fieldName.
fromFieldName(String) - Static method in class blackboard.data.content.ContentFile.Action
Returns the ContentFile.Action element specified by the fieldName.
fromFieldName(String) - Static method in class blackboard.data.content.ContentFile.StorageType
Returns the ContentFile.StorageType element specified by the fieldName.
fromFieldName(String) - Static method in class blackboard.data.content.UploadedFile.Action
Returns the Action element specified by the fieldName.
fromFieldName(String) - Static method in class blackboard.data.course.CourseMembership.Role
Returns the FormattedText.Type element specified by the fieldName.
fromFieldName(String, Class) - Static method in class blackboard.data.user.User.InstRole
Deprecated.  
fromFieldName(String, Class, boolean) - Static method in class blackboard.data.user.User.InstRole
Deprecated. Returns the User.InstRole element specified by the fieldName.
fromFieldName(String) - Static method in class blackboard.data.user.User.SystemRole
Returns the FormattedText.Type element specified by the fieldName.
FULL - Static variable in class blackboard.data.course.Course.ServiceLevel
 

G

GENDER - Static variable in interface blackboard.data.user.UserDef
 
generateId(DataType, String) - Method in class blackboard.persist.BbPersistenceManager
Generates an Id instance specific to the Container associated with this persistence manager.
generateId(DataType, int, int) - Method in class blackboard.persist.BbPersistenceManager
Generates an Id instance specific to the Container associated with this persistence manager.
generateId(DataType, int) - Method in class blackboard.persist.BbPersistenceManager
Generates an Id instance specific to the Container associated with this persistence manager.
generateId(DataType, String) - Method in interface blackboard.persist.Container
Generates an Id instance specific to this Container.
generateId(DataType, int, int) - Method in interface blackboard.persist.Container
Generates an Id instance specific to this Container.
generateId(DataType, int) - Method in interface blackboard.persist.Container
Generates an Id instance specific to this Container.
generateId(DataType, String) - Method in class blackboard.persist.DatabaseContainer
Generates an Id instance specific to this DatabaseContainer.
generateId(DataType, int, int) - Method in class blackboard.persist.DatabaseContainer
Generates an Id instance specific to this DatabaseContainer .
generateId(DataType, int) - Method in class blackboard.persist.DatabaseContainer
Generates an Id instance specific to this DatabaseContainer .
generateId(DataType, String) - Static method in class blackboard.persist.Id
Generates an Id instance using the default database persistence manager as given by context.
generateId(DataType, int, int) - Static method in class blackboard.persist.Id
Generates an Id instance using the default database persistence manager as given by context.
generateId(DataType, int) - Static method in class blackboard.persist.Id
Generates an Id instance using the default database persistence manager as given by context.
generateId(DataType, String) - Method in class blackboard.persist.RemoteDbContainer
Generates an Id instance specific to this XmlContainer .
generateId(DataType, int, int) - Method in class blackboard.persist.RemoteDbContainer
Generates an Id instance specific to this XmlContainer .
generateId(DataType, int) - Method in class blackboard.persist.RemoteDbContainer
Generates an Id instance specific to this DatabaseContainer .
GenericFieldComparator - Class in blackboard.base
Comparator implementation that allows objects in a list to be compared based on the value of an attribute that they have in common.
GenericFieldComparator(String, Class) - Constructor for class blackboard.base.GenericFieldComparator
Constructor.
GenericFieldComparator(boolean, String, Class) - Constructor for class blackboard.base.GenericFieldComparator
Constructor.
GenericFieldFilter - Class in blackboard.base
Filter implementation that allows objects in a list to be filtered based on the value of an attribute that they have in common.
GenericFieldFilter(String, Class, Object, GenericFieldFilter.Comparison) - Constructor for class blackboard.base.GenericFieldFilter
Constructs the filter to perform a comparison using a specific field accessor, to a specific value.
GenericFieldFilter.Comparison - Class in blackboard.base
 
getAbsoluteLimit() - Method in class blackboard.data.course.Course
Returns the absolute storage limit for this Course.
getAction() - Method in class blackboard.data.content.ChildFile
Returns the action specified for this ChildFile.
getAction() - Method in class blackboard.data.content.ContentFile
Returns the action specified for this ContentFile.
getActions() - Method in class blackboard.data.AttributePermission
Returns the actions, in normalized form, which is one of "get", "set", or "get,set".
getActions() - Method in class blackboard.persist.PersistPermission
Returns the actions, in normalized form.
getActiveSessionList() - Method in interface blackboard.platform.session.BbSessionManagerService
Returns a List of all active session in this VM.
getAllowedIps() - Method in class blackboard.platform.License
Returns the set of IP addresses that this license is restricted to run on.
getAllowEmailEnrollRequests() - Method in class blackboard.data.course.Course
Deprecated.  
getAllowGuests() - Method in class blackboard.data.content.Content
Returns the allow guests flag for this piece of Content.
getAllowGuests() - Method in class blackboard.data.course.Course
Returns the allow guests flag for this Course.
getAllowGuests() - Method in class blackboard.data.navigation.CourseToc
Returns the allow guests flag for this CourseToc.
getAllowObservers() - Method in class blackboard.data.content.Content
Returns the allow observers flag for this piece of Content.
getAllowObservers() - Method in class blackboard.data.course.Course
Returns the allow observers flag for this Course.
getAllowObservers() - Method in class blackboard.data.navigation.CourseToc
Returns the allow observers flag for this CourseToc.
getAnalysisHandlerUrl() - Method in class blackboard.data.gradebook.Lineitem
 
getAppName() - Method in class blackboard.base.AppVersion
Returns the application name of the AppVersion.
getAppPack() - Method in class blackboard.platform.LicenseManager
 
getAppPackNumber(String) - Static method in class blackboard.platform.LicenseUtil
 
getAppVersion() - Method in interface blackboard.persist.Container
Return the AppVersion associated with this Container .
getAppVersion() - Method in class blackboard.persist.DatabaseContainer
Return the AppVersion associated with this DatabaseContainer.
getAppVersion() - Method in interface blackboard.persist.Loader
Returns the AppVersion associated with this Loader.
getAppVersion() - Method in interface blackboard.persist.Persister
Returns the AppVersion associated with this Persister .
getAppVersion() - Method in class blackboard.persist.RemoteDbContainer
Return the AppVersion associated with this XmlContainer .
getArea() - Method in class blackboard.data.content.CourseDocument
Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries
getAsmtId() - Method in class blackboard.data.announcement.Announcement
Deprecated. This field no longer exists as of Bb6 and should not be used.
getAsmtId() - Method in class blackboard.data.content.CourseDocument
Deprecated. The links to other objects in the system have been generalized. The preferred method is to use the Link object. This method will always return Id.UNSET_ID
getAssessmentDirectory(String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
Returns the directory that stores all content directories for Assessment-related content.
getAssessmentDirectory(String, String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
Returns the directory that stores a given file for a given Assessment in a given Course.
getAssessmentId() - Method in class blackboard.data.gradebook.Lineitem
Returns a String-based Id for the associated assessment.
getAssessmentLocation() - Method in class blackboard.data.gradebook.Lineitem
assessmentLocation indicates whether the assessment referenced by this Lineitem is native to the Blackboard server or stored externally.
getAssignmentDirectory(String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
Returns the directory that stores all content directories for Assignment-related content.
getAssignmentDirectory(String, Id) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
Returns the directory that stores all content directories for a given Assignment.
getAssignmentDirectory(String, Id, String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
Returns the directory that stores a given file for a given Assignment in a given Course.
getAttemptDirectory(String, Id, AttemptFile.FileType) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course and attempt id.
getAttemptDirectory(Course, Id, AttemptFile.FileType) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course and attempt id.
getAttemptHandlerUrl() - Method in class blackboard.data.gradebook.Lineitem
Returns the URL for this item's attemptHandler if this Lineitem points to an external assessment.
getAttemptId() - Method in class blackboard.data.gradebook.Score
Returns a String-based Id for the external attempt handler.
getAttemptLocation() - Method in class blackboard.data.gradebook.Score
Returns whether the attempt associated with this score is internal to Blackboard or external.
getAttribute(String, BbSession.Scope) - Method in interface blackboard.platform.session.BbSession
Deprecated. Use HttpSession for private attributes (visible only to the calling webapp). Use getGlobalKey() for global attributes (visible across all webapps).
getAuthType() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Returns a String identifier for the authentication type for a given implementation of HttpAuthModule
getAuthType() - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Returns a String identifier for the authentication type for a given implementation of HttpAuthModule.
getAuthType() - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns a String identifier for the authentication type for a given implementation of HttpAuthModule.
getAvailableAuthTypes() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
Accessors
getAvailableContentHandlers() - Method in class blackboard.data.content.ContentHandlerWrapper
 
getAvailableContentHandlers() - Method in class blackboard.platform.plugin.PlugInManager
Deprecated. a filtering iterator is the preferred method for getting this information
getAvailablePlugIns() - Method in class blackboard.platform.plugin.PlugInManager
Deprecated. plugin availability can be determined either through a filtering interator, or by examining the available property directly.
getBackpackUIAllowed() - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether to display Bbackpack links.
getBannerImageFile() - Method in class blackboard.data.course.Course
Returns the banner image file associated with this Course.
getBatchUid() - Method in class blackboard.data.course.Course
Returns the batch uid associated with this Course.
getBatchUid() - Method in class blackboard.data.user.User
Returns the batch uid associated with this User.
getBbAttribute(String) - Method in class blackboard.data.BbAttributes
Returns the BbAttribute object associated with given name ("key").
getBbAttributeList() - Method in class blackboard.data.BbAttributes
Returns a list of the contained BbAttribute values.
getBbAttributes() - Method in class blackboard.data.BbLink
Returns the BbAttributes associated with this BbLink.
getBbAttributes() - Method in class blackboard.data.BbObject
Returns the BbAttributes associated with this BbObject.
getBbAttributes() - Method in interface blackboard.data.IBbObject
Returns the BbAttributes associated with this IBbObject.
getBbDatabase() - Method in class blackboard.persist.DatabaseContainer
Returns the BbDatabase associated with this DatabaseContainer.
getBbEnum(String) - Method in class blackboard.data.BbAttributes
Get the BbEnum value associated with given attribute name.
getBbObject(String) - Method in class blackboard.data.BbAttributes
Get the IBbObject value associated with given attribute name.
getBbProperties() - Method in interface blackboard.platform.config.ConfigurationService
Returns aggregate of bb-config.properties and properties from active service manager config.
getBbProperty(String) - Method in interface blackboard.platform.config.ConfigurationService
Shortcut to return an individual property from bb-config.properties or from this service manager's config file.
getBbProperty(String, String) - Method in interface blackboard.platform.config.ConfigurationService
Shortcut to return an individual property from bb-config.properties or from this service manager's config file.
getBbServicesDir() - Method in interface blackboard.platform.config.ConfigurationService
Deprecated.  
getBbSessionId() - Method in interface blackboard.platform.session.BbSession
Returns the Blackboard assigned unique id for this user's session.
getBbSessionIdMd5() - Method in interface blackboard.platform.session.BbSession
Returns the Blackboard assigned unique id for this user's session as an MD5 hashed string.
getBiography() - Method in class blackboard.data.content.StaffInfo
Returns the biography of this StaffInfo.
getBirthDate() - Method in class blackboard.data.user.User
Returns the birth date of this User.
getBlackboardDir() - Method in interface blackboard.platform.config.ConfigurationService
Returns the directory in which the Blackboard application is installed.
getBody() - Method in class blackboard.data.announcement.Announcement
Returns the body of this Announcement.
getBody() - Method in class blackboard.data.content.Content
Returns the body of this object as a FormattedText object.
getBoolean(String) - Method in class blackboard.data.BbAttributes
Get the Boolean value associated with given attribute name.
getBrandingDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the branding for given host.
getBuild() - Method in class blackboard.platform.plugin.Version
Returns the build version number, the fourth number in a string of the form N.N.N.N
getBuildNumber() - Method in class blackboard.platform.LicenseManager
 
getBuildNumber() - Static method in class blackboard.platform.LicenseUtil
 
getBundle() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
 
getBundle() - Static method in class blackboard.platform.security.SecurityUtil
Returns the security ResourceBundle, based on the current context locale.
getBundleFile(Id, BbLocale) - Method in class blackboard.platform.plugin.PlugInManager
 
getBundleManager() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return BundleManager.
getBundleName() - Method in class blackboard.base.BbLabeledEnum
assessmentEnum will extend getBundle to return "assessment", then all assessment enums will extend AssessmentEnum
getBundleName(Id) - Method in class blackboard.platform.plugin.PlugInManager
 
getBusinessFax() - Method in class blackboard.data.user.UserInfo
Returns the business fax of this UserInfo object
getBusinessPhone1() - Method in class blackboard.data.user.UserInfo
Returns the business phone 1 of this UserInfo object
getBusinessPhone2() - Method in class blackboard.data.user.UserInfo
Returns the business phone 2 of this UserInfo object
getButtonStyle() - Method in class blackboard.data.course.Course
Returns the ButtonStyle associated with this Course.
getButtonStyleId() - Method in class blackboard.data.course.Course
Returns the button style Id associated with this Course.
getCache() - Method in class blackboard.persist.BbPersistenceManager
Returns the Cache associated with this persistence manager.
getCacheFileName() - Method in interface blackboard.persist.CachingLoader
Returns the name of the file used to signal the loader data has been updated.
getCalendar(String) - Method in class blackboard.data.BbAttributes
Get the Calendar value associated with given attribute name.
getCardNumber() - Method in class blackboard.data.user.User
Returns a String representing the encrypted BbCard number for this User.
getCartridge() - Method in class blackboard.data.course.Course
Returns the Cartridge associated with this Course.
getCartridgeId() - Method in class blackboard.data.course.Course
Returns the cartridge Id associated with this Course.
getCatalogUrl() - Static method in class blackboard.platform.plugin.PlugInManager
Utility method to calculate the catalog URL from a navigation item.
getCDRomDriveMac() - Method in class blackboard.data.user.User
Returns the CDRomDriveMac of this User object.
getCDRomDrivePC() - Method in class blackboard.data.user.User
Returns the CDRomDrivePC of this User object.
getChildFiles() - Method in class blackboard.data.content.ContentFile
Returns the list of child files for this ContentFile.
getChildren() - Method in class blackboard.data.content.ContentFolder
Returns the list of children that presently belong to (was assigned to) this CourseDocumentFolder.
getChildren() - Method in interface blackboard.data.content.Folder
Returns the list of children that presently belong to (was assigned to) this Folder.
getChildren() - Method in class blackboard.data.content.StaffInfoFolder
Returns the list of children that presently belong to (was assigned to) this StaffInfoFolder.
getCity() - Method in class blackboard.data.user.UserInfo
Returns the city of this UserInfo object
getClassification() - Method in class blackboard.data.course.Course
Returns the Classification associated with this Course.
getClassificationId() - Method in class blackboard.data.course.Course
Returns the classification Id associated with this Course.
getClientId() - Method in class blackboard.platform.LicenseManager
Returns the client id fromt the LicenseFile
getCollabDocDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
returns the doc root of the collab server
getColumnOrder() - Method in class blackboard.data.gradebook.Lineitem
Returns the column position for this line item.
getComments() - Method in class blackboard.data.content.CourseUpload
Method getComments.
getCompany() - Method in class blackboard.data.user.UserInfo
Returns the company of this UserInfo object
getComponent() - Method in class blackboard.platform.License
Returns the component name.
getConfigDirectory(String, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the configuration directory for installing plug-ins.
getConfigErrs() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Collects errors from loading configuration properties for this authentication type.
getConfigKeys() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getConfigProperties(File) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getConfigurationService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return ConfigurationService.
getConfiguredFile(String, boolean) - Method in interface blackboard.platform.config.ConfigurationService
Utility for service implementations to get a file path from the configured properties.
getConfiguredFiles(String, boolean) - Method in interface blackboard.platform.config.ConfigurationService
Utility for service implementations to get a file list from the configured properties.
getConfiguredLog(String) - Method in interface blackboard.platform.log.LogService
Returns a log that has been configured by name or null if one is not found.
getConfiguredProvider() - Method in interface blackboard.platform.security.AccessManagerService
Returns the preferred Provider, loaded from the system setting found in the ConfigurationService
getConstraint() - Method in class blackboard.data.ValidationWarning
Returns the description of the constraint.
getContainer() - Method in class blackboard.persist.BbPersistenceManager
Returns the Container associated with this persistence manager.
getContainer() - Method in class blackboard.persist.Id
Returns the Container associated with this Id.
getContentDirectory(String) - Static method in class blackboard.platform.filesystem.CourseFileManager
Returns the content parent directory for the given Course.
getContentDirectory(String, Id) - Static method in class blackboard.platform.filesystem.CourseFileManager
Returns the directory that stores the given piece of content for the given Course.
getContentDirectory(String, Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course and content id.
getContentDirectory(Course, Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course and content id.
getContentFiles() - Method in class blackboard.data.content.Content
Returns the list of ContentFile objects associated with the content item.
getContentHandler() - Method in class blackboard.data.content.Content
Returns the Content Handler handle associated with this content object.
getContentHandler(String) - Method in class blackboard.platform.plugin.PlugInManager
Returns the ContentHandler for the given handle in the current virtual installation.
getContentHandlers() - Method in class blackboard.platform.plugin.PlugInManager
Returns a list of installed content handlers.
getContentId() - Method in class blackboard.data.content.ContentFile
Returns the content Id to which this ContentFile "belongs" (is part of).
getContentId() - Method in class blackboard.data.content.ContentStatus
Returns the content id that this status is attached to
getContentId() - Method in class blackboard.data.navigation.CourseToc
Returns the content Id of this CourseToc.
getContents() - Method in class blackboard.platform.security.SecurityResources
 
getContentStatus() - Method in class blackboard.data.content.Content
Returns the ContentStatus for this content item.
getContentSystemVersion() - Method in class blackboard.platform.plugin.PlugInManager
Returns the current Content System version, or null if the Content System is not installed.
getContentViewUrl(Content, User) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getContentViewUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
Returns the URL for viewing the content in its location within the Course Content UI.
getContext() - Method in class blackboard.persist.BbPersistenceManager
Returns the PersistenceContext associated with this persistence manager.
getContext() - Method in interface blackboard.platform.context.ContextManager
Retrieves the current context previously set via ContextManager.setContext(HttpServletRequest).
getContextManager() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return ContextManager.
getContextSessionDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory of the session in the current context.
getCountry() - Method in class blackboard.data.user.UserInfo
Returns the country of this UserInfo object
getCourse() - Method in class blackboard.data.course.CourseQuota
Accessor Methods
getCourse() - Method in class blackboard.data.gradebook.GradeRecord
Deprecated.  
getCourseAbsoluteLimit() - Method in class blackboard.data.course.CourseQuota
This method looks at the individual absolute course quota as well as the absolute system level quota and will return the absolute course quota if it exists.
getCourseAbsoluteLimitRemainingSize() - Method in class blackboard.data.course.CourseQuota
Calculate the remaining size left in the course quota
getCourseBatchUid() - Method in class blackboard.data.gradebook.GradeRecord
 
getCourseDirectory(String) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course.
getCourseDirectory(Course) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course.
getCourseId() - Method in class blackboard.data.announcement.Announcement
Returns the course Id to which this Announcement was posted.
getCourseId() - Method in class blackboard.data.calendar.CalendarEntry
Returns the course Id to which this CalendarEntry was posted.
getCourseId() - Method in class blackboard.data.content.AggregateReviewStatus
Returns the course id that this status is attached to
getCourseId() - Method in class blackboard.data.content.Content
Returns the course Id associated with this piece of Content.
getCourseId() - Method in class blackboard.data.content.StaffInfo
Gets the Id of the course associated with this StaffInfo object.
getCourseId() - Method in class blackboard.data.course.Course
Returns the course Id (not pk) associated with this Course.
getCourseId() - Method in class blackboard.data.course.CourseMembership
Returns the course Id associated with this CourseMembership .
getCourseId() - Method in class blackboard.data.course.Group
Returns the course Id associated with this Group
getCourseId() - Method in class blackboard.data.gradebook.GradeRecord
 
getCourseId() - Method in class blackboard.data.gradebook.Lineitem
Returns the Id of the Course this Lineitem is associated with.
getCourseId() - Method in class blackboard.data.navigation.CourseToc
Returns the course Id of this CourseToc.
getCourseId(HttpServletRequest) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the CourseId given an HttpServletRequest object
getCourseMembershipId() - Method in class blackboard.data.content.Upload
Gets the id of the course membership record for the user that performed this upload in the course that contains it.
getCourseMembershipId() - Method in class blackboard.data.course.GroupMembership
Returns the course membership Id associated with this GroupMembership.
getCourseMembershipId() - Method in class blackboard.data.gradebook.Score
Returns the Id of the CourseMembership for the user this Score is associated with.
getCourseSize() - Method in class blackboard.data.course.CourseQuota
Return the size of the current course.
getCourseSoftLimit() - Method in class blackboard.data.course.CourseQuota
This method looks at the individual soft course quota as well as the soft system level quota and will return the soft course quota if it exists.
getCourseUploadLimit() - Method in class blackboard.data.course.CourseQuota
This method looks at the individual course file upload limit as well as the system level file upload limit and will return the course limit if it exists.
getCpViewUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getCreateAccountAllowed(HttpServletRequest, HttpServletResponse) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
getCreateAccountAllowed() Determines based on configuration information, whether users may create new accounts.
getCreateAccountAllowed(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether users may create new accounts.
getCreatedDate() - Method in class blackboard.data.BbObject
Deprecated.  
getCreatedDate() - Method in interface blackboard.data.IBbObject
Deprecated.  
getCreateTimeMillis() - Method in interface blackboard.platform.session.BbSession
Deprecated. The session creation time is not stored in the database. Local "in memory" time is meaningless since sessions can be opened on multiple machines in a load balanced scenario.
getCreateUrl(ContentHandler, Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getCreatorUserId() - Method in class blackboard.data.announcement.Announcement
Returns the creator user Id associated with this Announcement .
getCreatorUserId() - Method in class blackboard.data.calendar.CalendarEntry
Returns the creator user Id associated with this CalendarEntry .
getCustomData(Id, Id) - Static method in class blackboard.portal.external.CustomData
Get CustomData without detailed reference to PortalRequestContext information.
getCustomProperties(String, boolean) - Method in interface blackboard.platform.config.ConfigurationService
Provision for implementations of ApplicationLauncher to provide non-relative locations for client manipulated configuration properties.
getDatabaseByKey(String) - Method in interface blackboard.platform.db.JdbcService
 
getDataSourceBatchUid() - Method in class blackboard.data.gradebook.GradeRecord
Returns the data source batch uid associated with this object.
getDataSourceId() - Method in class blackboard.data.course.Course
Returns the data source Id associated with this Course.
getDataSourceId() - Method in class blackboard.data.course.CourseMembership
Returns the data source Id of this CourseMembership.
getDataSourceId() - Method in class blackboard.data.role.PortalRole
gets the datasource id value for this PortalRole.
getDataSourceId() - Method in class blackboard.data.user.User
Returns the data source Id of this User.
getDataType() - Method in class blackboard.data.announcement.Announcement
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.BbObject
Returns the DataType identifier for the given BbObject-derived object.
getDataType() - Method in class blackboard.data.calendar.CalendarEntry
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.AggregateReviewStatus
 
getDataType() - Method in class blackboard.data.content.ChildFile
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.Content
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.ContentFile
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.ContentFileRef
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.ContentFolder
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.ContentStatus
 
getDataType() - Method in class blackboard.data.content.CourseDocument
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.CourseLink
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.CourseUpload
 
getDataType() - Method in class blackboard.data.content.ExternalLink
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.GroupUpload
 
getDataType() - Method in class blackboard.data.content.Lesson
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.Link
Returns the DataType identifier for the given BbObject-derived object.
getDataType() - Method in class blackboard.data.content.StaffInfo
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.StaffInfoFolder
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.content.UploadedFile
 
getDataType() - Method in class blackboard.data.course.Cartridge
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.course.Course
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.course.CourseMembership
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.course.Group
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.course.GroupMembership
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.gradebook.Lineitem
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.gradebook.Score
Returns the DataType identifier for this object.
getDataType() - Method in interface blackboard.data.IBbObject
Returns the DataType identifier for the given IBbObject-derived object.
getDataType() - Method in class blackboard.data.navigation.CourseToc
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.role.PortalRole
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.user.User
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.data.user.UserRole
Returns the DataType identifier for this object.
getDataType() - Method in class blackboard.persist.Id
Returns the DataType associated with this Id.
getDataValidationService() - Static method in class blackboard.platform.BbServiceManager
Deprecated. DataValidationService implementation is incomplete and unstable at this time.
getDateAdded() - Method in class blackboard.data.gradebook.Lineitem
Returns the date and time this Score was added to the gradebook.
getDateAdded() - Method in class blackboard.data.gradebook.Score
Returns the date and time this Score was added to the gradebook.
getDateChanged() - Method in class blackboard.data.gradebook.Lineitem
Returns the date and time this Lineitem was modified.
getDateChanged() - Method in class blackboard.data.gradebook.Score
Returns the date and time this Score was modified.
getDbPersistenceManager() - Method in interface blackboard.platform.persistence.PersistenceService
Returns the BbPersistenceManager instance for the Blackboard system specifically associated with the default database container.
getDefaultAuthType() - Static method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Return the default authentication type
getDefaultDatabase() - Method in interface blackboard.platform.db.JdbcService
 
getDefaultDisplayName() - Method in class blackboard.data.user.User.InstRole
Deprecated.  
getDefaultElement(Class) - Static method in class blackboard.base.BbEnum
Returns the first element in the enumeration where isDefault() is true.
getDefaultInstance() - Static method in class blackboard.data.content.ContentHandlerWrapper
 
getDefaultInstance() - Static method in class blackboard.data.content.ContentWrapper
 
getDefaultInstance() - Static method in class blackboard.persist.DatabaseContainer
Returns the default DatabaseContainer for the system.
getDefaultInstance() - Static method in class blackboard.persist.RemoteDbContainer
Returns the default XmlContainer for the system.
getDefaultLog() - Method in interface blackboard.platform.log.LogService
Returns the Log instance configured as the default Log
getDefaultPermissions() - Static method in class blackboard.platform.security.BbPolicy
 
getDeletedElements() - Method in class blackboard.base.BbDeleteTrackingList
Returns a collection of all elements removed through one mechanism or another.
getDepartment() - Method in class blackboard.data.user.UserInfo
Returns the department of this UserInfo object
getDescription() - Method in class blackboard.data.BbLink
Returns the description associated with this BbLink.
getDescription() - Method in class blackboard.data.calendar.CalendarEntry
Returns the description of this CalendarEntry.
getDescription() - Method in class blackboard.data.content.CourseLink
Returns the description of this CourseLink.
getDescription() - Method in class blackboard.data.content.ExternalLink
Returns the description of this ExternalLink.
getDescription() - Method in class blackboard.data.course.Cartridge
Returns the description associated with this Cartridge.
getDescription() - Method in class blackboard.data.course.Course
Returns the description associated with this Course.
getDescription() - Method in class blackboard.data.course.Group
Returns the description of this Group
getDescription() - Method in class blackboard.data.role.PortalRole
gets the description value for this PortalRole.
getDescription() - Method in class blackboard.platform.LicenseDescriptor
Returns the description for this component.
getDisplayAuthType() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
Helper methods
getDisplayAuthType(String) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getDisplayContentReturnURL(Id) - Static method in class blackboard.platform.plugin.PlugInUtil
Deprecated. use getDisplayContentReturnURL(contentId, courseId)
getDisplayContentReturnURL(Id, Id) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the return URL for jsps going back to the Editable Content page.
getDisplayContentReturnURL(String) - Static method in class blackboard.platform.plugin.PlugInUtil
Deprecated. use getDisplayContentReturnURL(contentId, courseId)
getDisplayContentReturnURL(String, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the return URL for jsps going back to the Display Content page.
getDisplayName() - Method in class blackboard.base.BbLabeledEnum
 
getDisplayName() - Method in class blackboard.data.user.User.InstRole
Deprecated. Returns a displayable representation of the given Institution Role
getDoAuthenticateParams(HttpServletRequest) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Gets the authentication parameters from the request object.
getDomainId() - Method in class blackboard.data.user.User
Deprecated. This field no longer exists as of Bb6 and should not be used.
getDouble(String) - Method in class blackboard.data.BbAttributes
Get the Double value associated with given attribute name.
getDurationType() - Method in class blackboard.data.course.Course
Returns the duration type for this Course.
getEditableContentReturnURL(Id) - Static method in class blackboard.platform.plugin.PlugInUtil
Deprecated. use getEditableContentReturnURL(contentId,courseId)
getEditableContentReturnURL(Id, Id) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the return URL for jsps going back to the Editable Content page.
getEditableContentReturnURL(String) - Static method in class blackboard.platform.plugin.PlugInUtil
Deprecated. use getEditableContentReturnURL(contentId, courseId)
getEditableContentReturnURL(String, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the return URL for jsps going back to the Editable Content page.
getEducationLevel() - Method in class blackboard.data.user.User
Returns the education level of this User object Requires AttributePermission with name "user.personalinfo", actions "get".
getEmail() - Method in class blackboard.data.content.StaffInfo
Returns the email of this StaffInfo object.
getEmailAddress() - Method in class blackboard.data.user.UserInfo
Returns the email address of this UserInfo object
getEndDate() - Method in class blackboard.data.calendar.CalendarEntry
Returns the date on which this CalendarEntry will/has end(ed).
getEndDate() - Method in class blackboard.data.content.Content
Returns the last date this content object will be available to students.
getEndDate() - Method in class blackboard.data.course.Course
Returns the date on which this Course will/has end(ed).
getEnforceQuota() - Method in class blackboard.data.course.CourseQuota
Return whether quotas are enabled on the system level for the course or organization
getEnforceUploadLimit() - Method in class blackboard.data.course.CourseQuota
Return whether system upload limits are enabled for the course or organization
getEnrollmentAccessCode() - Method in class blackboard.data.course.Course
Returns the enrollment access code associated with this Course.
getEnrollmentDate() - Method in class blackboard.data.course.CourseMembership
Returns the date on which this CourseMembership (enrollment record) object was created.
getEnrollmentEndDate() - Method in class blackboard.data.course.Course
Returns the date on which enrollment in this Course ends.
getEnrollmentStartDate() - Method in class blackboard.data.course.Course
Returns the date on which enrollment in this Course starts.
getEnrollmentType() - Method in class blackboard.data.course.Course
Returns the enrollment type for this Course.
getEntitlementDbLoader() - Static method in class blackboard.platform.security.SecurityDbUtil
Returns the EntitlementDbLoader instance associated with the default instance of the database BbPersistenceManager.
getEntry(Object) - Method in class blackboard.persist.Cache
 
getError() - Method in class blackboard.data.ValidationWarning
Returns the description of the error.
getError() - Method in class blackboard.platform.ResultCode
 
getErrorFallbackToBb() - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns a true if the LDAP provider is configured to "fall back" to the default authentication if an error is encountered using LDAP.
getExitStatus() - Method in class blackboard.platform.ResultCode
 
getExpiration() - Method in class blackboard.platform.License
Returns the expiration date for this component.
getFamilyName() - Method in class blackboard.data.content.StaffInfo
Returns the family name (last name) of this StaffInfo object.
getFamilyName() - Method in class blackboard.data.user.UserInfo
Returns the family name (last name) of this UserInfo object
getFamilyNameUpdateHtml() - Method in class blackboard.platform.LicenseManager
 
getFavoriteLinks() - Method in class blackboard.data.course.CourseMembership
Returns the list of favorite links for this CourseMembership.
getFee() - Method in class blackboard.data.course.Course
Returns the fee (cost) for this Course.
getFile() - Method in class blackboard.data.content.Upload
Gets the uploaded file record of the file referred to by this upload.
getFile(String) - Method in class blackboard.platform.filesystem.MultipartRequest
Returns a File associated with the given name.
getFileAction() - Method in class blackboard.data.content.UploadedFile
Method getFileAction.
getFileFromParameterName(String) - Method in class blackboard.platform.filesystem.MultipartRequest
Returns a File associated with the given parameter name.
getFileId() - Method in class blackboard.data.content.Upload
Gets the id of the uploaded file record of the file referred to by this upload.
getFileName() - Method in class blackboard.data.content.UploadedFile
Method getFileName.
getFiles(String) - Method in class blackboard.platform.filesystem.MultipartRequest
Returns an array of all the files uploaded with this request.
getFileSize() - Method in class blackboard.data.content.UploadedFile
Method getFileSize.
getFileSystemService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return FileSystemService.
getFilteredSubList(ListFilter) - Method in class blackboard.base.BbList
Returns a sublist containing only those elements that meet the given filter's requirements.
getFilteringIterator() - Method in class blackboard.base.BbList
Returns a BbList.Iterator for this list with no applied filters.
getFilteringIterator(ListFilter) - Method in class blackboard.base.BbList
Returns a BbList.Iterator for this list with the given filter applied.
getFloat(String) - Method in class blackboard.data.BbAttributes
Get the Float value associated with given attribute name.
getForgotPasswordUrl() - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether users may request their password.
getFormattedPropertyKey(String) - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getFormattedText(String) - Method in class blackboard.data.BbAttributes
Get the FormattedText value associated with given attribute name.
getFromCache(String) - Method in class blackboard.persist.Cache
 
getFullMessageTrace() - Method in exception blackboard.base.NestedException
 
getFullMessageTrace() - Method in exception blackboard.base.NestedRuntimeException
 
getGender() - Method in class blackboard.data.user.User
Returns the gender of this User object.
getGivenName() - Method in class blackboard.data.content.StaffInfo
Returns the given name (first name) of this StaffInfo object.
getGivenName() - Method in class blackboard.data.user.UserInfo
Returns the given name (first name) of this UserInfo object
getGlobalKey(String) - Method in interface blackboard.platform.session.BbSession
Retrieves a key that was stored for global use.
getGrade() - Method in class blackboard.data.gradebook.GradeRecord
Returns the grade as a String for the GradeRecord
getGrade() - Method in class blackboard.data.gradebook.Score
Returns the actual grade for this Score.
getGradebookDirectory(String) - Static method in class blackboard.platform.filesystem.GradebookFileManager
Returns the directory that stores content for a gradebook for a given Course in the system.
getGradebookDirectory(String, Id) - Static method in class blackboard.platform.filesystem.GradebookFileManager
Returns the directory that stores all content for a given Attempt in a given Course.
getGradebookInstructorDirectory(String, Id, String) - Static method in class blackboard.platform.filesystem.GradebookFileManager
Returns the directory that stores a comment file for a given Attempt in a given Course.
getGradebookName() - Method in class blackboard.data.gradebook.GradeRecord
Deprecated.  
getGradebookStudentDirectory(String, Id, String) - Static method in class blackboard.platform.filesystem.GradebookFileManager
Returns the directory that stores a comment file for a given Attempt in a given Course.
getGroupId() - Method in class blackboard.data.content.GroupUpload
Gets the id of the group that contains this group upload.
getGroupId() - Method in class blackboard.data.course.GroupMembership
Returns the group Id associated with this GroupMembership.
getGuestAllowed() - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether guests may access Blackboard installation.
getHasCartridgeAccess() - Method in class blackboard.data.course.CourseMembership
Returns the has cartridge access flag for this CourseMembership.
getHasDescriptionPage() - Method in class blackboard.data.course.Course
Returns the has description page flag for this Course.
getHashKey() - Method in class blackboard.persist.CacheKey
 
getHashValue(String) - Static method in class blackboard.platform.LicenseUtil
Utility method that generates a hex-formatted string representation of the message digest obtained from the specified string.
getHashValue(String) - Static method in class blackboard.platform.security.authentication.RDBMSAuthUtil
 
getHashValue(String) - Static method in class blackboard.platform.security.SecurityUtil
Utility method that generates a hex-formatted string representation of the message digest obtained from the specified string.
getHashValue(String, String) - Static method in class blackboard.platform.security.SecurityUtil
Utility method that generates a hex-formatted string representation of the message digest obtained from the specified string.
getHexString(byte[]) - Static method in class blackboard.platform.LicenseUtil
Returns the hexadecimal representation of the specified byte array.
getHomeFax() - Method in class blackboard.data.user.UserInfo
Returns the home fax of this UserInfo object
getHomePageUrl() - Method in class blackboard.data.content.StaffInfo
Returns the home page URL value of this StaffInfo object.
getHomePhone1() - Method in class blackboard.data.user.UserInfo
Returns the home phone 1 of this UserInfo object
getHomePhone2() - Method in class blackboard.data.user.UserInfo
Returns the home phone 2 of this UserInfo object
getIconListUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getIconToolbarUrl(ContentHandler) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getId(String) - Method in class blackboard.data.BbAttributes
Get the Id value associated with given attribute name.
getId() - Method in class blackboard.data.BbObject
Returns the Id associated with this BbObject.
getId() - Method in class blackboard.data.gradebook.Lineitem
 
getId() - Method in class blackboard.data.gradebook.Score
 
getId() - Method in interface blackboard.data.IBbObject
Returns the Id associated with this IBbObject.
getIdentifier() - Method in class blackboard.data.course.Cartridge
Returns the identifier (string-based unique id) associated with this Cartridge.
getImageFile() - Method in class blackboard.data.content.StaffInfo
This method is for INTERNAL USE ONLY.
getImageFile() - Method in class blackboard.data.course.CourseMembership
Returns the image of this CourseMembership object.
getImplClassForAuthType(String) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
Singleton accessors
getInitFailReason() - Method in class blackboard.platform.BbServiceManager
Returns the exception that was thrown on startup, causing the service manager to abort initialization.
getInstalledAuthType() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstalledInstance() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstance() - Static method in class blackboard.base.NullIterator
Returns a NullIterator instance.
getInstance(Course) - Static method in class blackboard.data.content.ContentHandlerWrapper
 
getInstance(Course) - Static method in class blackboard.data.content.ContentWrapper
 
getInstance() - Static method in class blackboard.persist.announcement.AnnouncementDbLoader.Default
Returns the AnnouncementDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.announcement.AnnouncementDbPersister.Default
Returns the AnnouncementDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance(Container) - Static method in class blackboard.persist.BbPersistenceManager
Returns an instance of BbPersistenceManager associated with the given target container.
getInstance(Container, PersistenceContext) - Static method in class blackboard.persist.BbPersistenceManager
Returns an instance of BbPersistenceManager associated with the given target container and persistence content.
getInstance() - Static method in class blackboard.persist.calendar.CalendarEntryDbLoader.Default
Returns the CalendarEntryDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.calendar.CalendarEntryDbPersister.Default
Returns the CalendarEntryDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.AggregateReviewStatusDbLoader.Default
Returns the AggregateReviewStatusDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.ContentDbLoader.Default
Returns the ContentDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.ContentDbPersister.Default
Returns the ContentDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.ContentFileDbLoader.Default
Returns the ContentFileDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.ContentFileDbPersister.Default
Returns the ContentFileDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.ContentStatusDbLoader.Default
Returns the ContentStatusDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.LinkDbLoader.Default
Returns the LinkDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.LinkDbPersister.Default
Returns the LinkDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.StaffInfoDbLoader.Default
Returns the StaffInfoDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.content.StaffInfoDbPersister.Default
Returns the StaffInfoDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CartridgeDbLoader.Default
Returns the CartridgeDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CartridgeDbPersister.Default
Returns the CartridgeDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CourseDbLoader.Default
Returns the CourseDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CourseDbPersister.Default
Returns the CourseDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CourseMembershipDbLoader.Default
Returns the CourseMembershipDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.CourseMembershipDbPersister.Default
Returns the CourseMembershipDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.GroupDbLoader.Default
Returns the GroupDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.GroupDbPersister.Default
Returns the GroupDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.GroupMembershipDbLoader.Default
Returns the GroupMembershipDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.course.GroupMembershipDbPersister.Default
Returns the GroupMembershipDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.navigation.CourseTocDbLoader.Default
Returns the CourseTocDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.role.PortalRoleDbLoader.Default
Returns the PortalRoleDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.role.PortalRoleDbPersister.Default
Returns the PortalRoleDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.user.UserDbLoader.Default
Returns the UserDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.user.UserDbPersister.Default
Returns the UserDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.user.UserRoleDbLoader.Default
Returns the UserRoleDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.persist.user.UserRoleDbPersister.Default
Returns the UserRoleDbPersister instance associated with the default instance of the database BbPersistenceManager.
getInstance(File, boolean) - Static method in class blackboard.platform.LicenseManager
Returns an instance of LicenseManager initialized with the specified file.
getInstance(File) - Static method in class blackboard.platform.LicenseManager
Returns an instance of LicenseManager initialized with the specified file.
getInstance() - Static method in class blackboard.platform.plugin.ContentHandlerDbLoader.Default
Returns the ContentHandlerDbLoader instance associated with the default instance of the database BbPersistenceManager.
getInstance() - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstance(String) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstance(String, String[]) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstance(VirtualInstallation, String, String[]) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getInstance() - Static method in class blackboard.platform.security.SecurityResources
 
getInstitutionId() - Method in class blackboard.data.course.Course
Deprecated.  
getInstitutionName() - Method in class blackboard.data.course.Course
Returns the institution name associated with this Course.
getInstitutionRole() - Method in class blackboard.data.user.User
Deprecated. Use getPortalRoleId() instead
getInteger(String) - Method in class blackboard.data.BbAttributes
Get the Integer value associated with given attribute name.
getInternalHandle() - Method in class blackboard.data.navigation.CourseToc
Returns the internal handle associated with this CourseToc.
getIntroduction() - Method in class blackboard.data.course.CourseMembership
Returns the introduction associated with this CourseMembership.
getIntValue() - Method in class blackboard.platform.StatusCode
 
getIsAvailable() - Method in interface blackboard.data.Available
Returns whether this item is available.
getIsAvailable() - Method in class blackboard.data.content.Content
Returns whether the piece of Content is available.
getIsAvailable() - Method in class blackboard.data.content.Link
Returns the availability flag for this Link.
getIsAvailable() - Method in class blackboard.data.content.StaffInfo
Returns the value of the availability attribute.
getIsAvailable() - Method in class blackboard.data.course.Course
Returns the availability flag for this Course.
getIsAvailable() - Method in class blackboard.data.course.CourseMembership
Returns the availability flag for this CourseMembership.
getIsAvailable() - Method in class blackboard.data.course.Group
Returns whether this Group is available.
getIsAvailable() - Method in class blackboard.data.gradebook.Lineitem
Returns a flag describing whether students can see the item in their views of the gradebook.
getIsAvailable() - Method in class blackboard.data.user.User
Returns the availability flag for this User.
getIsChatRoomAvailable() - Method in class blackboard.data.course.Group
Returns whether the chat room should be enabled for this Group.
getIsDescribed() - Method in class blackboard.data.content.Content
Returns whether this Content contains meta-data.
getIsDirty() - Method in class blackboard.data.BbAttribute
Get the "dirty" status of this BbAttribute.
getIsDirty() - Method in class blackboard.data.BbAttributes
Get the "dirty" status of this BbAttributes.
getIsDiscussionBoardAvailable() - Method in class blackboard.data.course.Group
Returns whether the discussion board should be enabled for this Group .
getIsEmailAvailable() - Method in class blackboard.data.course.Group
Returns whether email should be enabled for this Group.
getIsEnabled() - Method in class blackboard.data.navigation.CourseToc
Returns whether this CourseToc is enabled.
getIsEntryPoint() - Method in class blackboard.data.navigation.CourseToc
Returns whether this CourseToc is an entry point.
getIsFolder() - Method in class blackboard.data.content.Content
Returns whether this piece of Content should be treated as a folder of content, or as an actual content piece itself.
getIsFolder() - Method in class blackboard.data.content.ContentFolder
Overrides the method of the same name in Content.
getIsFolder() - Method in class blackboard.data.content.StaffInfo
Returns the value of the folder attribute.
getIsFolder() - Method in class blackboard.data.content.StaffInfoFolder
Overrides the method of the same name in StaffInfo.
getIsFromCartridge() - Method in class blackboard.data.content.Content
Returns whether this piece of TrackedContent came from a course cartridge.
getIsInfoPublic() - Method in class blackboard.data.user.User
Returns the is info public flag for this User.
getIsLesson() - Method in class blackboard.data.content.Content
Returns whether the underlying content represents a lesson.
getIsLocaleEnforced() - Method in class blackboard.data.course.Course
Returns the enforced locale flag for this Course.
getIsLockedOut() - Method in class blackboard.data.course.Course
Returns the locked out flag for this Course.
getIsNavCollapsible() - Method in class blackboard.data.course.Course
Returns the "is navigation collapsible" flag for this Course.
getIsPermanent() - Method in class blackboard.data.announcement.Announcement
Returns whether this Announcement should always be displayed, regardless of the date it was posted.
getIsReadOnly() - Method in class blackboard.data.BbAttribute
Returns value of the isReadOnly flag.
getIsReviewable() - Method in class blackboard.data.content.Content
Returns whether this piece of Content is presently set for review.
getIsSequential() - Method in class blackboard.data.content.Content
Indicates whether the object is a Lesson that requires its contents to be displayed in a sequential fashion.
getIsSet() - Method in class blackboard.data.BbAttribute
Retrieve "set" status of this BbAtribute.
getIsTracked() - Method in class blackboard.data.content.Content
Returns whether this piece of TrackedContent is presently set for access tracking.
getIsTransferAreaAvailable() - Method in class blackboard.data.course.Group
Returns whether the transfer area should be enabled for this Group .
getJdbcService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return JdbcService.
getJobTitle() - Method in class blackboard.data.user.UserInfo
Returns the job title of this UserInfo object
getKey() - Method in class blackboard.persist.CacheEntry
Returns the key of this cache entry.
getKey() - Method in class blackboard.platform.License
Returns the validation digest for this component.
getKey() - Method in class blackboard.platform.LicenseManager
Returns the validation key from the license file.
getKeys() - Method in class blackboard.portal.external.CustomData
Returns the Enumeration of keys for the portal data contained within this object.
getLabel() - Method in class blackboard.data.navigation.CourseToc
Returns the label associated with this CourseToc.
getLabel() - Method in class blackboard.data.role.PortalRole
Returns the name String associated with this PortalRole .
getLastAccessTimeMillis() - Method in interface blackboard.platform.session.BbSession
Returns the system time in milliseconds as specified by System.getTimeMillis() of when this session instance was last accessed.
getLastLoginDate() - Method in class blackboard.data.user.User
Returns the last login date of this User.
getLaunchInNewWindow() - Method in class blackboard.data.content.Content
Indicates whether a link for this object should be launched in a new window.
getLaunchInNewWindow() - Method in class blackboard.data.navigation.CourseToc
Returns whether this CourseToc should be launched in a new window (when selected within the user interface).
getLevelAsInt() - Method in class blackboard.platform.log.LogService.Verbosity
Returns an integer representation of this verbosity.
getLicenseExpiration(String) - Method in class blackboard.platform.LicenseManager
Returns the expiration for a given license or null if it never expires.
getLicenseKey() - Method in class blackboard.platform.LicenseDescriptor
Returns the component represented by this descriptor.
getLicenseManager() - Static method in class blackboard.platform.BbServiceManager
Method to access the LicenseManager.
getLicenseParameter(String, String) - Method in class blackboard.platform.LicenseManager
Returns the value of the specified property in the target key or null if the property is not found.
getLicenseUnitsParameter(String, String) - Method in class blackboard.platform.LicenseManager
Returns the Integer value of the specified property in the target key or null if the property is not found.
getLineitemId() - Method in class blackboard.data.gradebook.Score
Returns the Id of the gradebook Lineitem this score is attached to.
getLinkName() - Method in class blackboard.data.content.ChildFile
Returns the name of the link to display with this file object.
getLinkName() - Method in class blackboard.data.content.ContentFile
Returns the name of the link to display with this file object.
getLinkName() - Method in class blackboard.data.content.UploadedFile
Method getLinkName.
getLoader(String) - Method in class blackboard.persist.BbPersistenceManager
Returns a loader implementation as specified by the given type value and using the default AppVersion specifier.
getLoader(String, AppVersion) - Method in class blackboard.persist.BbPersistenceManager
Returns a loader implementation as specified by the given type value and using the provided AppVersion specifier.
getLoaderName() - Method in class blackboard.persist.CacheKey
Returns the loader name for this cache key.
getLoaderNames() - Method in class blackboard.persist.FilterCacheByLoader
 
getLocale() - Method in class blackboard.data.course.Course
Returns the locale of this Course object.
getLocale() - Method in class blackboard.data.user.User
Returns the locale of this User object.
getLocaleDir() - Method in interface blackboard.platform.config.ConfigurationService
Returns the base directory in which locale packs are installed.
getLocaleManager() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return LocaleManager.
getLogFileName() - Method in interface blackboard.platform.log.Log
Returns filename for this log.
getLogName() - Method in interface blackboard.platform.log.Log
Returns the name used to register this log.
getLogsDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root of the logs directory for use within application.
getLogService() - Method in class blackboard.persist.BbPersistenceManager
Returns the LogService for this persistence manager.
getLogService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return LogService.
getLong(String) - Method in class blackboard.data.BbAttributes
Get the Long value associated with given attribute name.
getLongProductName() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, superscript etc. tagged around each product if multiple products exist.
getLongProductNameHtml() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, superscript etc. tagged around each product if multiple products exist.
getLongProductNameHtmlTm() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, TM, superscript etc. tagged around each product if multiple products exist.
getMajor() - Method in class blackboard.platform.plugin.Version
Returns the major version number, the first number in a string of the form N.N.N.N
getMajorReleaseNumber() - Method in class blackboard.platform.LicenseManager
 
getMajorReleaseNumber(String) - Static method in class blackboard.platform.LicenseUtil
 
getMd5SessionId() - Method in class blackboard.platform.security.authentication.SessionStub
Returns the Blackboard assigned unique id for this user's session as an MD5 hashed string.
getMembership() - Method in class blackboard.data.content.ContentStatus
Returns the membership associated with this status.
getMessage() - Method in exception blackboard.data.ValidationException
Gets the message associated with this exception and a list of all the attached warnings.
getMessage() - Method in class blackboard.platform.ResultCode
 
getMessagingDirectory(String) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the messaging directory relative to the course.
getMessagingDirectory(Course) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course.
getMessagingDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course.
getMethodName() - Method in class blackboard.persist.CacheKey
Returns the method name for this cache key.
getMiddleName() - Method in class blackboard.data.user.UserInfo
Returns the middle name of this UserInfo object
getMinor() - Method in class blackboard.platform.plugin.Version
Returns the minor version number, the second number in a string of the form N.N.N.N
getMobilePhone() - Method in class blackboard.data.user.UserInfo
Returns the mobile phone of this UserInfo object
getModifiedDate() - Method in class blackboard.data.announcement.Announcement
Deprecated.  
getModifiedDate() - Method in class blackboard.data.BbObject
Returns the date on which this BbObject was last modified.
getModifiedDate() - Method in interface blackboard.data.IBbObject
Returns the date on which this IBbObject was last modified.
getModifyUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getModule(String) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getModuleData(PageContext) - Static method in class blackboard.portal.external.CustomData
Load the CustomData associated with the module's general data.
getModuleDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the module for given host.
getModulePersonalizationData(PageContext) - Static method in class blackboard.portal.external.CustomData
Load the CustomData associated with the module's personalization data.
getName() - Method in class blackboard.data.BbAttribute
Retrieves name ("key") associated with this BbAttribute object.
getName() - Method in class blackboard.data.BbLink
Returns the name value of this BbLink object.
getName() - Method in class blackboard.data.content.ChildFile
Returns the file name of this file object.
getName() - Method in class blackboard.data.content.ContentFile
Returns the file name of this file object.
getName(ContentHandler) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getName() - Method in class blackboard.data.gradebook.Lineitem
Returns the name of the Lineitem.
getName() - Method in class blackboard.persist.DataType
Returns the identifier name for this DataType as a String.
getNameString(String, String) - Static method in class blackboard.platform.LicenseUtil
 
getNameString(String, String, String[]) - Static method in class blackboard.platform.LicenseUtil
 
getNavColorBg() - Method in class blackboard.data.course.Course
Returns the background color that is used for rendering the navigation links that appear on the left hand side of the course page.
getNavColorFg() - Method in class blackboard.data.course.Course
Returns the foreground color (color of text) that is used for rendering the navigation links that appear on the left hand side of the course page.
getNavItemHandle(CourseDocument) - Static method in class blackboard.platform.plugin.PlugInUtil
Deprecated.  
getNavStyle() - Method in class blackboard.data.course.Course
Returns the navigation style for this Course.
getNestedException() - Method in exception blackboard.base.NestedException
Returns Throwable
getNestedException() - Method in exception blackboard.base.NestedRuntimeException
getNestedException
getNestedException() - Method in exception blackboard.platform.BbServiceException
getNestedException
getNestedException() - Method in exception blackboard.platform.RuntimeBbServiceException
getNestedException
getNotes() - Method in class blackboard.data.course.CourseMembership
Returns the notes associated with this CourseMembership.
getNumDaysOfUse() - Method in class blackboard.data.course.Course
Returns the number of days this Course can be used.
getNumServers() - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns the number of LDAP servers configured.
getObject(String) - Method in class blackboard.data.BbAttributes
Get the Object value associated with given attribute name.
getObjectValue(String) - Method in class blackboard.portal.external.CustomData
Returns the Object property associated with the given key.
getOfficeAddress() - Method in class blackboard.data.content.StaffInfo
Returns the office address of this StaffInfo object.
getOfficeHours() - Method in class blackboard.data.content.StaffInfo
Returns the office hours of this StaffInfo object.
getOfflineName() - Method in class blackboard.data.content.Content
Returns the offline name associated with this Content.
getOfflinePath() - Method in class blackboard.data.content.Content
Returns the offline path associated with this Content.
getOutcome() - Method in class blackboard.data.gradebook.Score
For internal use only.
getOutcomeDefinition() - Method in class blackboard.data.gradebook.Lineitem
For internal use only.
getPaceType() - Method in class blackboard.data.course.Course
Returns the pace type for this Course.
getParameter(String) - Method in class blackboard.platform.filesystem.MultipartRequest
Returns a scalar string value.
getParameter(String) - Method in class blackboard.platform.License
Returns the value for the specified custom parameter.
getParameterValues(String) - Method in class blackboard.platform.filesystem.MultipartRequest
Returns an array of values associated with a given form field.
getParentId() - Method in class blackboard.data.content.ChildFile
Returns the parent object for this file.
getParentId() - Method in class blackboard.data.content.Content
Returns the parent Id associated with this piece of Content.
getParentId() - Method in class blackboard.data.content.StaffInfo
Returns the Id of the StaffInfoFolder that contains this object.
getParentId() - Method in class blackboard.data.content.UploadedFile
Method getParentId.
getPassesRule() - Method in class blackboard.data.content.ContentStatus
Returns whether the user associated with this status object passes the adaptive release rules that are attached to the associated content object.
getPassword() - Method in class blackboard.data.user.User
Returns the password of this User object.
getPatch() - Method in class blackboard.platform.plugin.Version
Returns the patch version number, the third number in a string of the form N.N.N.N
getPermissionClass(String) - Static method in class blackboard.platform.security.PermissionParser
Returns the implementation class for a permission identifed by the type string.
getPermissions(CodeSource) - Method in class blackboard.platform.security.BbPolicy
Evaluates the global policy and returns a PermissionCollection object specifying the set of permissions allowed for code from the specified code source.
getPermissionType(Permission) - Static method in class blackboard.platform.security.PermissionParser
Returns the type string for a permission, given its XML type identifier.
getPersistenceService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return PersistenceService.
getPersistentLabel() - Method in class blackboard.data.navigation.CourseToc
Returns the database label associated with this CourseToc.
getPersistentLabel() - Method in class blackboard.data.role.PortalRole
Returns the database name String associated with this PortalRole .
getPersistentTitle() - Method in class blackboard.data.content.Content
Returns the persistent title associated with this piece of Content.
getPersistentTitle() - Method in class blackboard.data.content.StaffInfo
Returns the title for this object.
getPersister(String) - Method in class blackboard.persist.BbPersistenceManager
Returns a persister implementation as specified by the given type value and using the default AppVersion specifier.
getPersister(String, AppVersion) - Method in class blackboard.persist.BbPersistenceManager
Returns a persister implementation as specified by the given type value and using the provided AppVersion specifier.
getPersonalInfo() - Method in class blackboard.data.course.CourseMembership
Returns the personal information associated with this CourseMembership .
getPhone() - Method in class blackboard.data.content.StaffInfo
Returns the phone of this StaffInfo object.
getPk1() - Method in class blackboard.persist.PkId
Returns the primary key value of this PkId (PK1).
getPk2() - Method in class blackboard.persist.PkId
Returns the secondary key value of this PkId (PK2 or SOS_ID).
getPlatformVersion() - Method in class blackboard.platform.plugin.PlugInManager
Returns the current platform version.
getPlugIn(String, String) - Method in class blackboard.platform.plugin.PlugInManager
Returns the plug-in for the given vendor id and handle.
getPlugIn(Id) - Method in class blackboard.platform.plugin.PlugInManager
Returns the PlugIn identified by the specified Id.
getPlugIn(Id, VirtualInstallation) - Method in class blackboard.platform.plugin.PlugInManager
Simply returns the identified plugin for the specified virtual installation
getPlugInDir(PlugIn) - Method in class blackboard.platform.plugin.PlugInManager
Gets the root directory for a plugin
getPlugInLocales(Id) - Method in class blackboard.platform.plugin.PlugInManager
 
getPluginManager() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return PlugInManager.
getPlugIns() - Method in class blackboard.platform.plugin.PlugInManager
Returns a list of installed plug-ins.
getPlugInsConfigDirectory() - Method in class blackboard.platform.plugin.PlugInManager
Deprecated. due to virtual installation layout changes, this method is no longer valid. Use PlugInConfig instead.
getPlugInsDirectory(VirtualInstallation) - Method in class blackboard.platform.plugin.PlugInManager
Returns the plug-ins directory.
getPointsPossible() - Method in class blackboard.data.gradebook.Lineitem
Gets the points possible for this Lineitem
getPortalDirectEntry(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether Portal Direct Entry is enabled.
getPortalRole() - Method in class blackboard.data.user.User
Returns the PortalRole object, representing the primary institution role associated with this User.
getPortalRoleId() - Method in class blackboard.data.user.User
Returns the primary institution role Id of this User.
getPortalRoleId() - Method in class blackboard.data.user.UserRole
Returns the portal role Id associated with this UserRole .
getPosition() - Method in class blackboard.data.content.Content
Returns the position of this piece of Content within its parent content item (folder).
getPosition() - Method in class blackboard.data.content.StaffInfo
Returns the position of this object in the parent folder's collection
getPosition() - Method in class blackboard.data.navigation.CourseToc
Returns the position of this CourseToc.
getPosition() - Method in interface blackboard.data.Positionable
Returns the position of this item within its current context.
getProductDirectory(Integer) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the course.
getProductFamilyName() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, superscript etc.
getProductFamilyNameHtml() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, superscript etc.
getProductFamilyNameHtmlTm() - Method in class blackboard.platform.LicenseManager
For the Web: HTML for bold, italic, TM, superscript etc.
getProductName() - Method in class blackboard.platform.LicenseManager
Returns the product name from the LicenseFile.
getProductOwnedId() - Method in class blackboard.platform.LicenseManager
Returns the product owned id fromt the LicenseFile
getProperty(String) - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getPropKeys() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Returns a String array of the keys to this authentication module's configuration properties file.
getPropKeys() - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Returns a String array of the keys to an authentication module's configuration properties file.
getPropKeys() - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns a String array of the keys to this authentication module's configuration properties file.
getPropObjLoadErrs() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getPublisherName() - Method in class blackboard.data.course.Cartridge
Returns the publisher name associated with this Cartridge.
getRecallUrl() - Method in exception blackboard.platform.security.authentication.BbSecurityException
 
getRecycleDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory of the "recycle bin" for the application.
getRecycleDirectory(Course) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory of the "recycle bin" for a specific course.
getRecycleDirectory(File) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the appropriate recycle directory for a given file or directory.
getReferredToId() - Method in class blackboard.data.content.Link
Returns the referred to Id associated with this Link .
getReferredToType() - Method in class blackboard.data.content.Link
Returns the referred to type for this Link.
getReferrerId() - Method in class blackboard.data.content.Link
Returns the referrer Id associated with this Link.
getReferrerType() - Method in class blackboard.data.content.Link
Returns the referrer type for this Link.
getRegistry() - Method in class blackboard.data.content.ContentFile
Returns the Registry associated with this ContentFile .
getRegistry() - Method in class blackboard.data.course.Course
Returns the Registry associated with this Course.
getRegistry() - Method in class blackboard.data.user.User
Returns the Registry associated with this User.
getRemoteUser(HttpServletRequest) - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Extracts the CGI variable REMOTE_USER from the incoming request.
getRemoved() - Method in class blackboard.data.content.ContentFolder
Returns the ids that have been removed from this Folder.
getRemovedFiles() - Method in class blackboard.data.content.Content
Returns a list of the Ids of the files that have been removed from this content object.
getRemoveUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getRenderType() - Method in class blackboard.data.content.Content
Returns the RenderType for this piece of content.
getReportingPeriod() - Method in class blackboard.data.gradebook.GradeRecord
Returns the Reporting Period for a period this GradeRecord is attached to
getRequestAuthenticateUri(HttpServletRequest, HttpServletResponse) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
getRequestAuthenticateURI Indicates the target resource that should receive the current request.
getRequestInstance(HttpServletRequest) - Static method in class blackboard.platform.filesystem.MultipartRequest
Gets the MultipartRequest instance out of the given request object.
getRequireAccountToEnroll() - Method in class blackboard.data.course.Course
Deprecated.  
getRestrictionEndDate() - Method in class blackboard.data.announcement.Announcement
Returns the date up until which this Announcement should be made available for viewing within the user interface.
getRestrictionEndDate() - Method in class blackboard.data.content.CourseDocument
Returns the date up until which this CourseDocument should be made available for viewing within the user interface.
getRestrictionStartDate() - Method in class blackboard.data.announcement.Announcement
Returns the date after which this Announcement should be made available for viewing within the Blackboard application.
getRestrictionStartDate() - Method in class blackboard.data.content.CourseDocument
Returns the date after which this CourseDocument should be made available for viewing within the user interface.
getRetrievePasswordAllowed(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine whether users may request their password.
getReviewableCount() - Method in class blackboard.data.content.AggregateReviewStatus
Returns the number of content items the user can review.
getReviewed() - Method in class blackboard.data.content.ContentStatus
Returns whether the item has been reviewed.
getReviewedCount() - Method in class blackboard.data.content.AggregateReviewStatus
Returns the number of content items the user has reviewed.
getReviewedDate() - Method in class blackboard.data.content.ContentStatus
Returns the date the user reviewed this item.
getRole() - Method in class blackboard.data.course.CourseMembership
Returns the role for this CourseMembership.
getRoleID() - Method in class blackboard.data.role.PortalRole
gets the batch uid value for this PortalRole.
getRoleName() - Method in class blackboard.data.role.PortalRole
Returns the name String associated with this PortalRole .
getRootCourseDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory that all courses are stored in
getSafeBoolean(String) - Method in class blackboard.data.BbAttributes
Get the Boolean value associated with given attribute name.
getSafeDouble(String) - Method in class blackboard.data.BbAttributes
Get the Double value associated with given attribute name.
getSafeFloat(String) - Method in class blackboard.data.BbAttributes
Get the Float value associated with given attribute name.
getSafeFormattedText(String) - Method in class blackboard.data.BbAttributes
Get the FormattedText value associated with given attribute name.
getSafeId(String) - Method in class blackboard.data.BbAttributes
Get the Id value associated with given attribute name.
getSafeInteger(String) - Method in class blackboard.data.BbAttributes
Get the Integer value associated with given attribute name.
getSafeLong(String) - Method in class blackboard.data.BbAttributes
Get the Long value associated with given attribute name.
getSafeString(String) - Method in class blackboard.data.BbAttributes
Get the String value associated with given attribute name.
getScores() - Method in class blackboard.data.gradebook.Lineitem
Gets all scores associated with this LineItem.
getSecondaryDoAuthenticateParams(HttpServletRequest) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Gets the authentication parameters from the request object.
getSequence() - Method in interface blackboard.data.content.Aggregate
Returns the Sequence for this Aggregate.
getSequence() - Method in class blackboard.data.content.ContentFolder
Required method for Aggregate objects.
getSequence() - Method in class blackboard.data.content.Lesson
Returns the Sequence for this object.
getServiceInterface() - Method in class blackboard.persist.PersistenceInitializationService
getServiceInterface
getServiceInterface() - Method in class blackboard.platform.LicenseValidationService
Deprecated.  
getServiceInterface() - Method in class blackboard.platform.plugin.PlugInManager
Returns the Class for this interface implementation.
getServiceLevelType() - Method in class blackboard.data.course.Course
Returns the service level type for this Course.
getSession(HttpServletRequest) - Method in interface blackboard.platform.session.BbSessionManagerService
Returns the BbSession associated with the user making the given request.
getSessionDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root of the session directory registered for the application.
getSessionId() - Method in class blackboard.platform.security.authentication.SessionStub
Returns the Blackboard assigned unique id for this user's session.
getSessionManagerService() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return BbSessionManagerService.
getSettings() - Method in class blackboard.data.user.User
Returns the settings of this User object.
getSharedContentDir() - Method in interface blackboard.platform.config.ConfigurationService
Returns the directory in which shared content is kept
getShowAddContactInfo() - Method in class blackboard.data.user.User
Returns the show additional contact info flag for this User.
getShowAddressInfo() - Method in class blackboard.data.user.User
Returns the show address info flag for this User.
getShowEmailInfo() - Method in class blackboard.data.user.User
Returns the show email flag for this User.
getShowEmailInSR() - Method in class blackboard.data.course.Course
Deprecated.  
getShowFirstNameInSR() - Method in class blackboard.data.course.Course
Deprecated.  
getShowInCatalog() - Method in class blackboard.data.course.Course
Returns the show in catalog flag for this Course.
getShowLastNameInSR() - Method in class blackboard.data.course.Course
Deprecated.  
getShowPhone1InSR() - Method in class blackboard.data.course.Course
Deprecated.  
getShowStudentIdInSR() - Method in class blackboard.data.course.Course
Deprecated.  
getShowWorkInfo() - Method in class blackboard.data.user.User
Returns the show work info flag for this User.
getSirTitle() - Method in class blackboard.data.content.StaffInfo
Returns the sirtitle of this StaffInfo object.
getSize() - Method in class blackboard.data.content.ChildFile
Returns the size of the file wrapped by this object.
getSize() - Method in class blackboard.data.content.ContentFile
Returns the size of the file wrapped by this object.
getSoftLimit() - Method in class blackboard.data.course.Course
Returns the soft storage limit for this Course.
getSoftwareTitle(HttpServletRequest, HttpServletResponse) - Static method in class blackboard.platform.security.SecurityDbUtil
Convenience method to determine the proper name for this Blackboard system.
getSponsorsDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root directory relative to the sponsors for given id.
getStartDate() - Method in class blackboard.data.calendar.CalendarEntry
Returns the date on which this CalendarEntry will/has start(ed).
getStartDate() - Method in class blackboard.data.content.Content
Returns the Calendar that indicates the first date this object is to be made available in the student view of a course.
getStartDate() - Method in class blackboard.data.course.Course
Returns the date on which this Course will/has start(ed).
getState() - Method in class blackboard.data.user.UserInfo
Returns the state of this UserInfo object
getStatus() - Method in class blackboard.data.content.CourseUpload
Method getStatus.
getStatusCode() - Method in interface blackboard.platform.Application
Returns current status of application.
getStorageType() - Method in class blackboard.data.content.ContentFile
Returns the storageType specified for this ContentFile.
getStreet1() - Method in class blackboard.data.user.UserInfo
Returns the street1 of this UserInfo object
getStreet2() - Method in class blackboard.data.user.UserInfo
Returns the street2 of this UserInfo object
getString(String) - Method in class blackboard.data.BbAttributes
Get the String value associated with given attribute name.
getStudentId() - Method in class blackboard.data.user.User
Returns the student id of this User object Requires AttributePermission with name "user.personalinfo", actions "get".
getSubConfigErrs() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Collects errors from loading nested configuration properties for this authentication type.
getSubConfigs() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getSubList(ListFilter) - Method in class blackboard.base.SharableArrayList
Returns a sublist containing all elements meet the given filter's requirements.
getSystemAbsoluteLimit() - Method in class blackboard.data.course.CourseQuota
Return the system level quota absolute limit (if set).
getSystemRole() - Method in class blackboard.data.user.User
Returns the system role (the administrative user role in the gui) for this User.
getSystemSoftLimit() - Method in class blackboard.data.course.CourseQuota
Return the system level quota soft limit (if set).
getSystemUploadLimit() - Method in class blackboard.data.course.CourseQuota
Return the system level quota upload limit (if set).
getTargetAudienceId() - Method in class blackboard.data.course.Course
Deprecated.  
getTargetType() - Method in class blackboard.data.navigation.CourseToc
Returns the target type for this CourseToc.
getTempDir() - Method in interface blackboard.platform.config.ConfigurationService
getTempDir
getTempDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns a temp directory for use within application.
getTempDirectory() - Method in class blackboard.platform.plugin.PlugInManager
Returns the upload temp space.
getText() - Method in class blackboard.base.FormattedText
Returns the text associated with this FormattedText.
getTitle() - Method in class blackboard.data.announcement.Announcement
Returns the title associated with this Announcement.
getTitle() - Method in class blackboard.data.calendar.CalendarEntry
Returns the title associated with this CalendarEntry.
getTitle() - Method in class blackboard.data.content.Content
Returns the title associated with this piece of Content.
getTitle() - Method in class blackboard.data.content.Link
Returns the title associated with this Link.
getTitle() - Method in class blackboard.data.content.StaffInfo
Returns the title for this object.
getTitle() - Method in class blackboard.data.course.Cartridge
Returns the title associated with this Cartridge.
getTitle() - Method in class blackboard.data.course.Course
Returns the title associated with this Course.
getTitle() - Method in class blackboard.data.course.Group
Returns the title associated with this Group
getTitle() - Method in class blackboard.data.user.UserInfo
Returns the user title of this UserInfo object
getTitle() - Method in class blackboard.platform.LicenseDescriptor
Returns the human-readable title for this descriptor.
getTitleColor() - Method in class blackboard.data.content.Content
Returns the title color associated with this piece of Content.
getTitleColor() - Method in class blackboard.data.content.StaffInfo
Returns the color used to render the color.
getToolType(NavigationItem) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns a human readable name for specific navitem family identifiers.
getType() - Method in class blackboard.base.AppVersion
Returns the type value of the AppVersion.
getType() - Method in class blackboard.base.FormattedText
Returns the format type for this FormattedText.
getType() - Method in class blackboard.data.announcement.Announcement
Returns the type value associated with this Announcement.
getType() - Method in class blackboard.data.BbAttribute
Retrieves BbAttribute object type.
getType() - Method in class blackboard.data.calendar.CalendarEntry
Returns the type value associated with this CalendarEntry.
getType() - Method in class blackboard.data.content.CourseDocument
Deprecated. This attribute is no longer used in Blackboard 6. null will be returned.
getType() - Method in class blackboard.data.gradebook.Lineitem
Returns the type of the Lineitem, for example 'Assessment' or 'Homework'.
getUiFormattedAuthProps() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getUiFormattedPropKeys() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getUiFormattedSubConfigs() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getUnitsParameter(String) - Method in class blackboard.platform.License
Returns the value for the specified unit.
getUpdateName() - Method in class blackboard.platform.LicenseManager
 
getUpdateName(String) - Static method in class blackboard.platform.LicenseUtil
 
getUpdateNameLong() - Method in class blackboard.platform.LicenseManager
 
getUploadDate() - Method in class blackboard.data.content.Upload
Gets the date and time when the file referred to by this object was uploaded.
getUploadLimit() - Method in class blackboard.data.course.Course
Returns the upload storage limit for this Course.
getUri(PlugIn, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the a URI generated for this plugin and the specified resource.
getUri(String, String, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the a URI generated for this plugin and the specified resource.
getUriStem(String, String) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the a URI-stem generated for this plugin.
getUriStem(String, String, VirtualInstallation) - Static method in class blackboard.platform.plugin.PlugInUtil
Returns the a URI-stem generated for this plugin.
getUrl() - Method in class blackboard.data.BbLink
Returns the URL associated with this BbLink.
getUrl() - Method in class blackboard.data.content.Content
Returns the URL associated with this ExternalLink.
getUrl() - Method in class blackboard.data.navigation.CourseToc
Returns the URL associated with this CourseToc.
getUseChallenge() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Determines based on configuration information, whether to use challenge-response authentication.
getUseChallenge() - Method in class blackboard.platform.security.authentication.HttpAuthConfig
 
getUser() - Method in class blackboard.data.content.ContentStatus
Returns the user associated with this status.
getUser() - Method in class blackboard.data.course.CourseMembership
Returns the User attribute associated with this CourseMembership.
getUser() - Method in class blackboard.data.gradebook.GradeRecord
Deprecated.  
getUser() - Method in class blackboard.data.user.UserRole
Returns the User object of this UserRole object
getUserBatchUid() - Method in class blackboard.data.gradebook.GradeRecord
 
getUserFromUsernamePassword(String, String) - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns the User object for a given username and password.
getUserId() - Method in class blackboard.data.announcement.Announcement
Deprecated. Has been replaced by the more aptly named Announcement.getCreatorUserId()
getUserId() - Method in class blackboard.data.calendar.CalendarEntry
Deprecated. has been replaced by CalendarEntry.getCreatorUserId().
getUserId() - Method in class blackboard.data.content.AggregateReviewStatus
The id of the user this status is for.
getUserId() - Method in class blackboard.data.content.ContentStatus
The id of the user this status is for.
getUserId() - Method in class blackboard.data.course.CourseMembership
Returns the user Id associated with this CourseMembership .
getUserId() - Method in class blackboard.data.user.UserRole
Returns the user Id associated with this UserRole .
getUserId() - Method in interface blackboard.platform.session.BbSession
Returns the Id of the user associated with this session.
getUserName() - Method in class blackboard.data.user.User
Returns the username of this User object.
getUserName() - Method in interface blackboard.platform.session.BbSession
Returns the system login name of the user associated with this session.
getUserNotFoundFallbackToBb() - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Returns true of the LDAP provider is configured to "fall back" to the default authentication if the user is not found in LDAP.
getValue() - Method in class blackboard.data.BbAttribute
Retrieves object value associated with BbAttribute object.
getValue(String, BbAttribute.Type) - Method in class blackboard.data.BbAttributes
Internal convenience method to make the type-specific "get" routines much simpler (i.e., shorter).
getValue(Object) - Method in class blackboard.persist.Cache
 
getValue() - Method in class blackboard.persist.CacheEntry
Returns the value of this cache entry.
getValue(String) - Method in class blackboard.portal.external.CustomData
Returns the String property associated with the given key.
getValues(Class) - Static method in class blackboard.base.BbEnum
Returns an array of all of the elements in the target enumeration class specified by enumClass.
getValues() - Static method in class blackboard.base.FormattedText.Type
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.announcement.Announcement.Type
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.BbAttribute.Type
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.calendar.CalendarEntry.Type
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.ChildFile.Action
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.Content.RenderType
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.ContentFile.Action
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.ContentFile.StorageType
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.CourseDocument.Area
Deprecated. Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.CourseDocument.Type
Deprecated. Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.Link.ReferredToType
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.Link.ReferrerType
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.content.UploadedFile.Action
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.Course.Duration
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.Course.Enrollment
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.Course.NavStyle
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.Course.Pace
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.Course.ServiceLevel
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.course.CourseMembership.Role
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.navigation.CourseToc.Target
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.user.User.EducationLevel
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.user.User.Gender
Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.user.User.InstRole
Deprecated. Returns an array of all of the elements in this enumeration.
getValues() - Static method in class blackboard.data.user.User.SystemRole
Returns an array of all of the elements in this enumeration.
getVerbosityLevel() - Method in interface blackboard.platform.log.Log
Returns the verbosity level for this log.
getVersionNum() - Method in class blackboard.base.AppVersion
Returns the version number of the AppVersion.
getVIDataDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root of the content directory.
getVIDataDirectory(VirtualInstallation) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root of the content directory.
getViewUrl(Content) - Method in class blackboard.data.content.ContentHandlerWrapper
 
getVirtualInstallationManager() - Static method in class blackboard.platform.BbServiceManager
Convenience wrapper to return VirtualInstallationManager.
getVISystemDataDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the root of the systemdata directory.
getWarnings() - Method in exception blackboard.data.ValidationException
Returns a list of the warnings attached to this exception.
getWarnings() - Method in exception blackboard.platform.plugin.BadPackageDefException
Returns the warnings associated with this exception.
getWebAssessmentDirectory(String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
 
getWebAssessmentDirectory(String, String) - Static method in class blackboard.platform.filesystem.AssessmentFileManager
 
getWebAttemptDirectory(String, Id, AttemptFile.FileType) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and attempt id.
getWebAttemptDirectory(String, String, AttemptFile.FileType) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and attempt id.
getWebAttemptDirectory(Course, Id, AttemptFile.FileType) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and attempt id.
getWebBrandingDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the branding for given host.
getWebContentDirectory(Course, Id) - Method in class blackboard.platform.filesystem.CourseFileManager
Returns the web based directory where content and course document items are stored.
getWebContentDirectory(String, Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and content id.
getWebContentDirectory(Course, Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and content id.
getWebContentDirectory(String, String) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the course and content id.
getWebContentDirectory(Course) - Method in class blackboard.platform.filesystem.GradebookFileManager
Returns the web based directory where content and course document items are stored.
getWebContentDirectory(Course, Id) - Method in class blackboard.platform.filesystem.GradebookFileManager
Returns the web based directory where content and course document items are stored.
getWebContextSessionDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory of the session in the current context.
getWebCourseDirectory(String) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web-root based directory path to the course.
getWebCourseDirectory(Course) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web-root based directory path to the course.
getWebMessagingDirectory(String) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the url to messaging url relative to the course.
getWebMessagingDirectory(Course) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the url to messages directory relative to the course.
getWebMessagingDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the url to messages directory relative to the course.
getWebModuleDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the module for given host.
getWebPage() - Method in class blackboard.data.user.UserInfo
Returns the web page of this UserInfo object
getWebProductDirectory(Integer) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the branding for given host.
getWebSessionDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root of the session directory registered for the application.
getWebSponsorsDirectory(Id) - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root directory relative to the branding for given host.
getWebVIDataDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Deprecated. This method never worked, because it points to an unavailable d irectory
getWebVIDataDirectory(VirtualInstallation) - Method in interface blackboard.platform.filesystem.FileSystemService
Deprecated. This method never worked, because it points to an unavailable directory
getWebVISystemDataDirectory() - Method in interface blackboard.platform.filesystem.FileSystemService
Returns the web based root of the systemdata directory.
getWeight() - Method in class blackboard.data.gradebook.Lineitem
Gets the weight used in calculating cumulative scores.
getXmlPersistenceManager() - Method in interface blackboard.platform.persistence.PersistenceService
Returns the BbPersistenceManager instance for the Blackboard system specifically associated with the default XML container.
getZipCode() - Method in class blackboard.data.user.UserInfo
Returns the zip code of this UserInfo object
GIVEN_NAME - Static variable in interface blackboard.data.content.StaffInfoDef
 
GIVEN_NAME - Static variable in interface blackboard.data.user.UserInfoDef
 
GLOBAL_USER - Static variable in class blackboard.platform.session.BbSession.Scope
Deprecated. Attributes with global scope are offloaded to persistent storage in database or filesystem and are subsequently available to any webapp or consumer in any process.
GradebookFileManager - Class in blackboard.platform.filesystem
A service that returns File objects representing the path to content files for Blackboard's gradebook web application.
GradebookFileManager() - Constructor for class blackboard.platform.filesystem.GradebookFileManager
 
GRADER - Static variable in class blackboard.data.course.CourseMembership.Role
 
GradeRecord - Class in blackboard.data.gradebook
The GradeRecord class represents a grade record item for a course.
GradeRecord() - Constructor for class blackboard.data.gradebook.GradeRecord
 
GradeRecord(Outcome) - Constructor for class blackboard.data.gradebook.GradeRecord
 
GradeRecordDbLoader - Interface in blackboard.persist.gradebook
The GradeReportDbLoader interface provides a standard set of methods used to load GradeRecord and GradeRecordList from the Blackboard 5 database schema.
GRADUATE_SCHOOL - Static variable in class blackboard.data.user.User.EducationLevel
Graduate school student.
GREATER_THAN - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
GREATER_THAN - Static variable in class blackboard.platform.plugin.Version
Static value for compare() method return value.
GREATER_THAN_EQUALS - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
GROUP - Static variable in class blackboard.data.content.Link.ReferredToType
 
Group - Class in blackboard.data.course
The Group class is a representation of a course group within the Course Management System.
Group() - Constructor for class blackboard.data.course.Group
Creates an instance of Group with default property values.
GROUP_ID - Static variable in interface blackboard.data.content.GroupUploadDef
 
GROUP_ID - Static variable in interface blackboard.data.course.GroupMembershipDef
 
GROUP_LINK - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-grouplink
GroupDbLoader - Interface in blackboard.persist.course
This interface describes the set of methods that all database loaders for Group objects must implement.
GroupDbLoader.Default - Class in blackboard.persist.course
A utility class that provides quick access to the GroupDbLoader instance associated with the default instance of the database BbPersistenceManager.
GroupDbLoader.Default() - Constructor for class blackboard.persist.course.GroupDbLoader.Default
 
GroupDbPersister - Interface in blackboard.persist.course
This interface describes the set of methods that all database persisters for Group objects must implement.
GroupDbPersister.Default - Class in blackboard.persist.course
A utility class that provides quick access to the GroupDbPersister instance associated with the default instance of the database BbPersistenceManager.
GroupDbPersister.Default() - Constructor for class blackboard.persist.course.GroupDbPersister.Default
 
GroupDef - Interface in blackboard.data.course
GroupDef
GroupMembership - Class in blackboard.data.course
The GroupMembership class is a representation of a group membership record within the Blackboard application.
GroupMembership() - Constructor for class blackboard.data.course.GroupMembership
Creates an instance of GroupMembership with default property values.
GroupMembershipDbLoader - Interface in blackboard.persist.course
This interface describes the set of methods that all database loaders for GroupMembership objects must implement.
GroupMembershipDbLoader.Default - Class in blackboard.persist.course
A utility class that provides quick access to the GroupMembershipDbLoader instance associated with the default instance of the database BbPersistenceManager.
GroupMembershipDbLoader.Default() - Constructor for class blackboard.persist.course.GroupMembershipDbLoader.Default
 
GroupMembershipDbPersister - Interface in blackboard.persist.course
This interface describes the set of methods that all database persisters for GroupMembership objects must implement.
GroupMembershipDbPersister.Default - Class in blackboard.persist.course
A utility class that provides quick access to the GroupMembershipDbPersister instance associated with the default instance of the database BbPersistenceManager.
GroupMembershipDbPersister.Default() - Constructor for class blackboard.persist.course.GroupMembershipDbPersister.Default
 
GroupMembershipDef - Interface in blackboard.data.course
GroupMembershipDef
GroupUpload - Class in blackboard.data.content
The GroupUpload class wraps a reference to a file that has been uploaded to a group file exchange in a course.
GroupUpload() - Constructor for class blackboard.data.content.GroupUpload
Default constructor.
GroupUploadDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for GroupUpload objects must implement.
GroupUploadDbPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all database persisters for GroupUpload objects must implement.
GroupUploadDef - Interface in blackboard.data.content
GroupUploadDef
GUEST - Static variable in class blackboard.data.course.CourseMembership.Role
 
GUEST - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
GUEST - Static variable in class blackboard.data.user.User.SystemRole
Guest role.

H

HANDLE - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HANDLE - Static variable in interface blackboard.platform.plugin.PlugInDef
 
HAS_CARTRIDGE_ACCESS - Static variable in interface blackboard.data.course.CourseMembershipDef
 
HAS_DESCRIPTION_PAGE - Static variable in interface blackboard.data.course.CourseDef
 
HASH_ALGORITHM - Static variable in class blackboard.platform.security.SecurityUtil
 
hashCode() - Method in class blackboard.data.user.User.InstRole
Deprecated.  
hashCode() - Method in class blackboard.persist.CacheKey
 
hashCode() - Method in class blackboard.persist.DatabaseContainer
 
hashCode() - Method in class blackboard.persist.Id
Returns a hash code value for the object.
hashCode() - Method in class blackboard.persist.PkId
Allow Ids to be used as a key in a hashtable.
hashCode() - Method in class blackboard.persist.UnsetId
Returns a hash code value for the object.
hashCode() - Method in class blackboard.platform.log.LogService.Verbosity
 
hasMapping(Id) - Method in interface blackboard.persist.PersistenceContext
Returns whether or not a mapping exists for the given Id.
hasNext() - Method in class blackboard.base.FilteringIterator
Determines if any more elements that pass all applied filters exist in the iterator.
hasNext() - Method in class blackboard.base.NullIterator
Since there is nothing to iterate over, there is never a "next" item, and this method always returns false.
hasSameContainer(Id) - Method in class blackboard.persist.Id
Returns true if the given Id has the same Container as this Id instance.
hasSameDataType(Id) - Method in class blackboard.persist.Id
Returns true if the given Id has the same DataType as this Id instance.
hasValidKey() - Method in class blackboard.platform.License
Returns whether this component's validation key is correct.
HIGH_SCHOOL - Static variable in class blackboard.data.user.User.EducationLevel
Grades 9 through 12.
HOME_FAX - Static variable in interface blackboard.data.user.UserInfoDef
 
HOME_PAGE_URL - Static variable in interface blackboard.data.content.StaffInfoDef
 
HOME_PHONE_1 - Static variable in interface blackboard.data.user.UserInfoDef
 
HOME_PHONE_2 - Static variable in interface blackboard.data.user.UserInfoDef
 
HTML - Static variable in class blackboard.base.FormattedText.Type
Treat text as "literal HTML" with no character conversions
HTTP_ACTION_CONFIG - Static variable in interface blackboard.platform.plugin.PlugInDef
 
HTTP_ACTION_CPVIEW - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HTTP_ACTION_CREATE - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HTTP_ACTION_MODIFY - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HTTP_ACTION_REMOVE - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HTTP_ACTION_REMOVE - Static variable in interface blackboard.platform.plugin.PlugInDef
 
HTTP_ACTION_VIEW - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
HttpAuthConfig - Class in blackboard.platform.security.authentication
This class is responsible for storing in-memory the authentication properties for the Blackboard application.
HttpAuthModule - Interface in blackboard.platform.security.authentication
This interface is provided for custom authentication schemes.

I

IBbObject - Interface in blackboard.data
The IBbObject class is an interface representing the root of the data class hierarchy.
ICON_LIST - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
ICON_TOOLBAR - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
ID - Static variable in class blackboard.data.BbAttribute.Type
 
Id - Class in blackboard.persist
Provides the basis for object identifiers within the persistence framework.
Id(Container, DataType) - Constructor for class blackboard.persist.Id
Creates Id identifying it with the given container and data type values.
Id(DataType) - Constructor for class blackboard.persist.Id
Creates an Id identifying it with the given data type value.
IDENTIFIER - Static variable in interface blackboard.data.course.CartridgeDef
 
IIS_CONFIG_EXE - Static variable in interface blackboard.platform.plugin.Constants
 
IIS_WEB_NAME - Static variable in interface blackboard.platform.plugin.Constants
 
IMAGE_FILE - Static variable in interface blackboard.data.content.StaffInfoDef
 
IMAGE_FILE - Static variable in interface blackboard.data.course.CourseMembershipDef
 
Immutable - Interface in blackboard.data
The Immutable interface defines a means for specifying an object that can be made immutable.
ImmutableException - Exception in blackboard.data
Thrown if an attempt is made to modify an object that implements the Immutable interface is made after the object is marked as being complete.
ImmutableException() - Constructor for exception blackboard.data.ImmutableException
Default constructor.
ImmutableException(String) - Constructor for exception blackboard.data.ImmutableException
Constructs an ImmutableException with the given message.
IMPL_CLASS_KEY - Static variable in class blackboard.platform.security.authentication.BaseAuthenticationModule
Used internally by this module.
implies(Permission) - Method in class blackboard.data.AttributePermission
Determines whether the current permission implies the specified permission.
implies(Permission) - Method in class blackboard.persist.PersistPermission
Determines whether the current permission implies the specified permission.
include(ValidationException) - Method in exception blackboard.data.ValidationException
Provides ability to chain ValidationExceptions that are spawned in seperate method calls but share a line of processing.
INCLUDE_IF_UNKNOWN - Static variable in class blackboard.data.course.CourseMembershipRoleFilter
 
INFORMATION - Static variable in class blackboard.platform.log.LogService.Verbosity
Used to log messages that are not necessarily error conditions, but might be useful for diagnostic purposes.
init(BbPersistenceManager, AppVersion) - Method in interface blackboard.persist.Loader
Initializes the loader with the given persistence manager reference and the provided application version.
init(BbPersistenceManager, AppVersion) - Method in interface blackboard.persist.Persister
Initializes the persister with the given persistence manager reference and the provided application version.
init(ConfigurationService, String[]) - Method in interface blackboard.platform.Application
Initializes application instance for the lifetime of its instance.
init(String) - Static method in class blackboard.platform.BbServiceManager
Standard init method that should be called by bootstrap mechanism.
init(String, boolean) - Static method in class blackboard.platform.BbServiceManager
 
init(String, Properties) - Static method in class blackboard.platform.BbServiceManager
Standard init method that overloads default properties for configuration service.
init(String, Properties, boolean) - Static method in class blackboard.platform.BbServiceManager
 
init(File, Properties) - Static method in class blackboard.platform.BbServiceManager
Init method that does not depend on file system structure.
init(File, Properties, boolean) - Static method in class blackboard.platform.BbServiceManager
 
init(ConfigurationService) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Initializes authentication module.
init(ConfigurationService) - Static method in class blackboard.platform.security.authentication.HttpAuthConfig
 
init(ConfigurationService) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
This method is used to initialize the authentication module.
init(ConfigurationService) - Method in class blackboard.platform.security.authentication.LDAPAuthModule
Initializes authentication module.
init(ConfigurationService) - Static method in class blackboard.platform.security.authentication.RDBMSAuthUtil
Standard initialization method.
initFromSystemProps() - Static method in class blackboard.platform.BbServiceManager
Called internally to bootstrap service manager from the "bbservices_config" system property if services are accessed without being pre-initialized by a standard bootstrap class.
InitializationException - Exception in blackboard.base
Exceptions thrown at application initialization time.
InitializationException(String) - Constructor for exception blackboard.base.InitializationException
Constructor
InitializationException(Throwable) - Constructor for exception blackboard.base.InitializationException
Constructor
InitializationException(String, Throwable) - Constructor for exception blackboard.base.InitializationException
Constructor
INITIALIZING - Static variable in class blackboard.platform.StatusCode
 
initLoadersAndPersisters() - Method in class blackboard.persist.BbPersistenceManager
Initialize loaders/persisters
INST_CITY - Static variable in class blackboard.platform.config.BbConfig
 
INST_COUNTRY - Static variable in class blackboard.platform.config.BbConfig
 
INST_NAME - Static variable in class blackboard.platform.config.BbConfig
 
INST_STATE - Static variable in class blackboard.platform.config.BbConfig
 
INST_TYPE - Static variable in class blackboard.platform.config.BbConfig
 
INST_ZIP - Static variable in class blackboard.platform.config.BbConfig
 
INSTALL_SYS_ALLOWED_ROLES - Static variable in class blackboard.platform.plugin.PlugInUtil
 
INSTITUTION - Static variable in class blackboard.data.calendar.CalendarEntry.Type
The entry is system-wide and viewable from the system-level calendar tool.
INSTITUTION_NAME - Static variable in interface blackboard.data.course.CourseDef
 
INSTITUTION_ROLE - Static variable in interface blackboard.data.user.UserDef
 
INSTRUCTOR - Static variable in class blackboard.data.course.CourseMembership.Role
 
INSTRUCTOR_LED - Static variable in class blackboard.data.course.Course.Enrollment
Enrollment tasks for the course can only performed by the instructor
INSTRUCTOR_LED - Static variable in class blackboard.data.course.Course.Pace
Course is intended to be led by an instructor.
INTEGER - Static variable in class blackboard.data.BbAttribute.Type
 
INTEGRATION - Static variable in class blackboard.data.user.User.SystemRole
This role is private, used only for special processes that interact for data integration authentication.
INTERNAL - Static variable in class blackboard.data.gradebook.Lineitem.AssessmentLocation
assessmentId points to an assessment within Blackboard.
INTERNAL - Static variable in class blackboard.data.gradebook.Score.AttemptLocation
The attempt data is stored within Blackboard.
INTRODUCTION - Static variable in interface blackboard.data.course.CourseMembershipDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.content.ContentDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.content.LinkDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.content.StaffInfoDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.course.CourseDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.course.CourseMembershipDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.course.GroupDef
 
IS_AVAILABLE - Static variable in interface blackboard.data.user.UserDef
 
IS_CHAT_ROOM_AVAILABLE - Static variable in interface blackboard.data.course.GroupDef
 
IS_DESCRIBED - Static variable in interface blackboard.data.content.ContentDef
 
IS_DISCUSSION_BOARD_AVAILABLE - Static variable in interface blackboard.data.course.GroupDef
 
IS_EMAIL_AVAILABLE - Static variable in interface blackboard.data.course.GroupDef
 
IS_FOLDER - Static variable in interface blackboard.data.content.ContentDef
 
IS_FOLDER - Static variable in interface blackboard.data.content.StaffInfoDef
 
IS_FROM_CARTRIDGE - Static variable in interface blackboard.data.content.ContentDef
 
IS_INFO_PUBLIC - Static variable in interface blackboard.data.user.UserDef
 
IS_LESSON - Static variable in interface blackboard.data.content.ContentDef
 
IS_LOCALE_ENFORCED - Static variable in interface blackboard.data.course.CourseDef
 
IS_LOCKED_OUT - Static variable in interface blackboard.data.course.CourseDef
 
IS_NAV_COLLAPSIBLE - Static variable in interface blackboard.data.course.CourseDef
 
IS_RECYCLED - Static variable in interface blackboard.data.content.ChildFileDef
 
IS_RECYCLED - Static variable in interface blackboard.data.content.ContentFileDef
 
IS_REVIEWABLE - Static variable in interface blackboard.data.content.ContentDef
 
IS_SEQUENTIAL - Static variable in interface blackboard.data.content.ContentDef
 
IS_TRACKED - Static variable in interface blackboard.data.content.ContentDef
 
IS_TRANSFER_AREA_AVAILABLE - Static variable in interface blackboard.data.course.GroupDef
 
isAscending() - Method in class blackboard.base.BaseComparator
Returns true if this comparator has been set to compare objects in ascending order.
isAuthenticated(HttpServletRequest) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Deprecated.  
isAuthenticated(HttpServletRequest) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Deprecated. This method is no longer called.
isAuthenticated() - Method in interface blackboard.platform.session.BbSession
Returns true if the associated user has been authenticated.
isDefault() - Method in class blackboard.base.BbEnum
Returns true if this is a default element.
isExpired() - Method in class blackboard.platform.License
Returns whether this component has expired.
isExternalAuth() - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Can be used by subclasses to determine whether or not the authentication module is an external authentication module.
isGuest() - Method in class blackboard.data.role.PortalRole
gets the isGuest value for this PortalRole.
isLicensed(String) - Method in class blackboard.platform.LicenseManager
Method to check whether the specified component name is available and valid.
isLicenseUnitsParameterUnlimited(String, String) - Method in class blackboard.platform.LicenseManager
Returns true if specified the units parameter is unlimited.
isPlugInLocalized(Id) - Method in class blackboard.platform.plugin.PlugInManager
 
isRecycled() - Method in class blackboard.data.content.UploadedFile
Method isRecycled.
isRemovable() - Method in class blackboard.data.role.PortalRole
gets the isRemovable value for this PortalRole.
isRestricted(Permission) - Static method in class blackboard.platform.security.PermissionParser
Simple check to see if the permission being created is "restricted" and thus not allowed for assignment to a system extension.
isSelfSelectable() - Method in class blackboard.data.role.PortalRole
gets the isSelfSelectable value for this PortalRole.
isServiceInitialized(String) - Static method in class blackboard.platform.BbServiceManager
 
isSet() - Method in class blackboard.persist.Id
Determines if the Id has been set (is not in defalt state).
isSet() - Method in class blackboard.persist.PkId
Determines if the PkId has been set.
isSet() - Method in class blackboard.persist.UnsetId
Determines if this UnsetId has been set.
isUserInCourseRole(Id, Id, CourseMembership.Role) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated.  
isUserInCourseRole(HttpServletRequest, CourseMembership.Role) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated.  
isUserInCourseRole(HttpServletRequest, CourseMembership.Role[]) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated.  
isUserInSystemRole(Id, User.SystemRole) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated.  
isUserInSystemRole(HttpServletRequest, User.SystemRole) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated.  
isUserInSystemRole(HttpServletRequest, User.SystemRole[]) - Method in interface blackboard.platform.security.AccessManagerService
Deprecated. As of Blackboard 6.0, the authorization API based on \"is user X in role Y\" are deprecated. Authorization for 6.0 will be based on \"does user X have entitlement \'context.target.right\'\"
isValid() - Method in class blackboard.persist.CacheEntry
Returns whether or not the cache entry is still valid.
isValidForThisServer() - Method in class blackboard.platform.License
Check to see if this server is in the set of valid IP addresses associated for this license component.
isValidId(Id) - Method in class blackboard.persist.BbPersistenceManager
Convenience method to determines if the provided Id is a "valid" Id for this BbPersistenceManager's Container .
isValidId(Id) - Method in interface blackboard.persist.Container
Determines if the provided Id is a "valid" id for this Container.
isValidId(Id) - Method in class blackboard.persist.DatabaseContainer
Determines if the provided Id is a "valid" id for this DatabaseContainer.
isValidId(Id) - Method in class blackboard.persist.RemoteDbContainer
Determines if the provided Id is a "valid" id for this XmlContainer.
isValidLicenseKey(License) - Static method in class blackboard.platform.LicenseUtil
 
isValidLicenseManagerKey(LicenseManager) - Static method in class blackboard.platform.LicenseUtil
 

J

JAVA_HOME - Static variable in class blackboard.platform.config.BbConfig
 
JAVA_HOME_WIN - Static variable in class blackboard.platform.config.BbConfig
 
JdbcService - Interface in blackboard.platform.db
Core platform service that provides access to configured databases.
JOB_TITLE - Static variable in interface blackboard.data.user.UserInfoDef
 
JUNIOR - Static variable in class blackboard.data.user.User.EducationLevel
College or university junior.

K

K_8 - Static variable in class blackboard.data.user.User.EducationLevel
Kindergarten through 8th grade
KEY_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
KeyNotFoundException - Exception in blackboard.persist
Exception indicating that the Id used to load an object was not found in the target data store ("container").
KeyNotFoundException(String) - Constructor for exception blackboard.persist.KeyNotFoundException
Creates a KeyNotFoundException with the given message.
KeyNotFoundException(Throwable) - Constructor for exception blackboard.persist.KeyNotFoundException
Constructor
KeyNotFoundException(String, Exception) - Constructor for exception blackboard.persist.KeyNotFoundException
Creates a KeyNotFoundException with the given message and provided nested exception.

L

LAST_LOGIN_DATE - Static variable in interface blackboard.data.user.UserDef
 
LAUNCH_IN_NEW_WINDOW - Static variable in interface blackboard.data.content.ContentDef
 
LDAP_PROP_KEYS - Static variable in class blackboard.platform.security.authentication.LDAPAuthModule
 
LDAPAuthModule - Class in blackboard.platform.security.authentication
Implementation class for the LDAP authentication provider for Blackboard Learning system.
LDAPAuthModule() - Constructor for class blackboard.platform.security.authentication.LDAPAuthModule
Constructor for the LDAP authentication provider.
leaveContent(Content) - Method in interface blackboard.data.content.ContentVisitor
For folders, this method is called after all of the folder's children have been visited, recursively.
LESS_THAN - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
LESS_THAN - Static variable in class blackboard.platform.plugin.Version
Static value for compare() method return value.
LESS_THAN_EQUALS - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
LESSON - Static variable in interface blackboard.data.content.ContentHandlerStrings
resource/x-bb-lesson
LESSON - Static variable in class blackboard.data.content.CourseDocument.Type
Deprecated.  
Lesson - Class in blackboard.data.content
The Lesson class represents a list of content that is meant to be viewed in a linear, guided order.
Lesson() - Constructor for class blackboard.data.content.Lesson
Default constructor for Lesson objects.
LIBRARY_VERSION - Static variable in class blackboard.platform.config.BbConfig
 
License - Class in blackboard.platform
Object to represent different options in the license file.
License(String, String[], Date, String, Hashtable, Properties) - Constructor for class blackboard.platform.License
Constructor initializing License with specified parameters
LICENSE - Static variable in class blackboard.platform.License.XmlDef
 
License.XmlDef - Class in blackboard.platform
Class to wrap String constants used in XML parsing.
License.XmlDef() - Constructor for class blackboard.platform.License.XmlDef
 
LicenseDescriptor - Class in blackboard.platform
Object to wrap human-readable names and descriptions for different license keys.
LicenseDescriptor(String) - Constructor for class blackboard.platform.LicenseDescriptor
Create a descriptor for the associated component.
LicenseException - Exception in blackboard.platform
LicenseException
LicenseException(String) - Constructor for exception blackboard.platform.LicenseException
Constructor
LicenseException(Throwable) - Constructor for exception blackboard.platform.LicenseException
Constructor
LicenseException(String, Throwable) - Constructor for exception blackboard.platform.LicenseException
Constructor
LicenseExpiredException - Exception in blackboard.platform
LicenseException
LicenseExpiredException(String) - Constructor for exception blackboard.platform.LicenseExpiredException
Constructor
LicenseExpiredException(Throwable) - Constructor for exception blackboard.platform.LicenseExpiredException
Constructor
LicenseExpiredException(String, Throwable) - Constructor for exception blackboard.platform.LicenseExpiredException
Constructor
LicenseManager - Class in blackboard.platform
Class used to parse and validate license files.
LicenseManager(String, String, String, License[], String) - Constructor for class blackboard.platform.LicenseManager
Instantiates a LicenseManager object with the specified parameters and license components.
LicenseNotFoundException - Exception in blackboard.platform
LicenseException
LicenseNotFoundException(String) - Constructor for exception blackboard.platform.LicenseNotFoundException
Constructor
LicenseNotFoundException(Throwable) - Constructor for exception blackboard.platform.LicenseNotFoundException
Constructor
LicenseNotFoundException(String, Throwable) - Constructor for exception blackboard.platform.LicenseNotFoundException
Constructor
LicenseUtil - Class in blackboard.platform
LicenseUtil.
LicenseUtil() - Constructor for class blackboard.platform.LicenseUtil
 
LicenseValidationService - Class in blackboard.platform
Deprecated.  
LicenseValidationService() - Constructor for class blackboard.platform.LicenseValidationService
Deprecated.  
Lineitem - Class in blackboard.data.gradebook
The Lineitem class represents a single gradable item in a course.
Lineitem() - Constructor for class blackboard.data.gradebook.Lineitem
Constructs and returns a new Lineitem object with date added and date changed initialized to the current date.
Lineitem(OutcomeDefinition) - Constructor for class blackboard.data.gradebook.Lineitem
Creates the Lineitem using the specified OutcomeDefinition.
Lineitem.AssessmentLocation - Class in blackboard.data.gradebook
Simple class to define where the assessment identified by assessmentId is located.
LINEITEM_DATA_TYPE - Static variable in class blackboard.data.gradebook.Lineitem
Standard field used in persistence layer.
LineitemDbLoader - Interface in blackboard.persist.gradebook
The LineitemDbLoader interface provides a standard set of methods used to load Lineitems and LineitemLists from the Blackboard 5 database schema.
LineitemDbPersister - Interface in blackboard.persist.gradebook
The LineitemDbPersister interface provides a standard set of methods used to store Lineitem objects into the Blackboard database schema.
LINK - Static variable in class blackboard.data.content.Content.RenderType
Render the underlying object as a course link
LINK - Static variable in class blackboard.data.content.ContentFile.Action
 
Link - Class in blackboard.data.content
The Link class is a representation of a link within the Blackboard application.
Link() - Constructor for class blackboard.data.content.Link
Creates an instance of Link with default property values.
LINK - Static variable in class blackboard.data.content.UploadedFile.Action
 
LINK - Static variable in class blackboard.data.navigation.CourseToc.Target
Toc is a link to another entity defined within the course
Link.ReferredToType - Class in blackboard.data.content
 
Link.ReferrerType - Class in blackboard.data.content
 
LINK_NAME - Static variable in interface blackboard.data.content.ChildFileDef
 
LINK_NAME - Static variable in interface blackboard.data.content.ContentFileDef
 
LINK_NAME - Static variable in interface blackboard.data.content.UploadedFileDef
 
LINK_SOURCE_ID - Static variable in interface blackboard.data.content.LinkDef
 
LINK_SOURCE_TABLE - Static variable in interface blackboard.data.content.LinkDef
 
LinkDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for Link objects must implement.
LinkDbLoader.Default - Class in blackboard.persist.content
A utility class that provides quick access to the LinkDbLoader instance associated with the default instance of the database BbPersistenceManager.
LinkDbLoader.Default() - Constructor for class blackboard.persist.content.LinkDbLoader.Default
 
LinkDbPersister - Interface in blackboard.persist.content
This interface describes the set of methods that all database persisters for Link objects must implement.
LinkDbPersister.Default - Class in blackboard.persist.content
A utility class that provides quick access to the LinkDbPersister instance associated with the default instance of the database BbPersistenceManager.
LinkDbPersister.Default() - Constructor for class blackboard.persist.content.LinkDbPersister.Default
 
LinkDef - Interface in blackboard.data.content
LinkDef
ListFilter - Class in blackboard.base
Filters are used to get a sublist from a list using arbitrary, consumer defined, selection criteria.
ListFilter() - Constructor for class blackboard.base.ListFilter
 
listLicenses() - Method in class blackboard.platform.LicenseManager
Returns an array of all License objects read from the license file.
load() - Method in class blackboard.persist.Id
Loads the BbObject derived value that matches the current id value.
load() - Method in class blackboard.persist.PkId
Overrides load method in the base class to implement a "load by id" operation for a database id (and thus for a database container).
load(Element) - Method in interface blackboard.platform.plugin.ContentHandlerXmlLoader
Generates a ContentHandler object given an Element tree whose structure and contents match those generated by ContentHandlerXmlPerister.
load(InputStream) - Method in interface blackboard.platform.plugin.ContentHandlerXmlLoader
Generates a ContentHandler object given an InputStream which contains XML whose structure and contents match those generated by ContentHandlerXmlPerister.
loadAll() - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects in the system from the database in a lightweight fashion using a connection obtained through this object's database context.
loadAll(Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects in the system from the database in a lightweight fashion using the supplied connection.
loadAll(VirtualInstallation) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
Loads all the ContentHandlers for the specified virtual installation.
loadAll(VirtualInstallation) - Method in interface blackboard.platform.plugin.PlugInDbLoader
Loads all the PlugIn definitions for the target VirtualInstallation.
loadAllByServiceLevel(Course.ServiceLevel) - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system with the given Course.ServiceLevel value in a light-weight fashion using a connection obtained through this object's database context.
loadAllByServiceLevel(Course.ServiceLevel, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system with the given Course.ServiceLevel value in a light-weight fashion using the supplied connection.
loadAllByUserId(Id) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that represent the primary and secondary portal roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.
loadAllByUserId(Id, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that represent the primary and secondary portal roles for the given user from the database in a lightweight fashion using the supplied connection.
loadAllCourses() - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system in a light-weight fashion using a connection obtained through this object's database context.
loadAllCourses(Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system in a light-weight fashion using the supplied connection.
loadAvailableByCourse(Course) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
loadAvailableByCourse
loadAvailableByCourse(Course, Connection) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
loadAvailableByCourse
loadAvailableByCourseIdAndUserId(Id, Id, int, boolean) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
loadAvailableByCourseIdAndUserId Loads the list of all available announcements that pertain to the user identified by the given user id, within the course specified by the given courseId, within a given time period.
loadAvailableByCourseIdAndUserId(Id, Id, int, boolean, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
loadAvailableByCourseIdAndUserId Loads the list of all available announcements that pertain to the user identified by the given user id, within the course specified by the given courseId, within a given time period using the supplied connection
loadAvailableByType(Announcement.Type, boolean) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects currently available to the user of the type identified by the given Announcement.Type using a connection obtained through this object's database context.
loadAvailableByType(Announcement.Type) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects currently available to the user of the type identified by the given Announcement.Type using a connection obtained through this object's database context.
loadAvailableByType(Announcement.Type, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects currently available to the user of the type identified by the given Announcement.Type using the supplied connection.
loadAvailableByType(Announcement.Type, int) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects currently available to the user of the type identified by the given Announcement.Type created or modified within the last n days, using a connection obtained through this object's database context.
loadAvailableByType(Announcement.Type, int, boolean, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects currently available to the user of the type identified by the given Announcement.Type created or modified within the last n days, using the supplied connection.
loadAvailableByUserId(Id) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Loads the list of all available announcements (system, course and organization) that pertain to the user identified by the given user Id, using a connection obtained through this object's database context.
loadAvailableByUserId(Id, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Loads the list of all available announcements (system, course and organization) that pertain to the user identified by the given user Id, using the supplied connection.
loadAvailableByUserId(Id, int) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Loads the list of all available announcements (system, course and organization) that pertain to the user identified by the given user Id, within a given time period, using a connection obtained through this object's database context.
loadAvailableByUserId(Id, int, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Loads the list of all available announcements (system, course and organization) that pertain to the user identified by the given user Id, within a given time period, using the supplied connection.
loadAvailableChildren(Id, Id, boolean, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads all children of the specified folder, honoring availability settings as determined for the specified user.
loadAvailableContent(Id, Id, Connection) - Method in class blackboard.data.content.ContentWrapper
 
loadAvailableContent(Id, Id) - Method in class blackboard.data.content.ContentWrapper
 
loadByBatchUid(String) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given batch uid value from the database in a light- weight fashion using a connection obtained through this object's database context.
loadByBatchUid(String, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given batch uid value from the database in a light- weight fashion using the supplied connection.
loadByBatchUid(String, Connection, boolean) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given batch uid value from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByBatchUid(String) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given batch uid value from the database in a light- weight fashion using a connection obtained through this object's database context.
loadByBatchUid(String, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given batch uid value from the database in a light- weight fashion using the supplied connection.
loadByBatchUid(String, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given batch uid from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByCardNumberFamilyNameGivenName(String, String, String, Connection) - Method in interface blackboard.persist.user.UserDbLoader
 
loadByContentFolderId(Id) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects that are referenced by children of the specified ContentFolder (identified by Id) from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByContentFolderId(Id, Connection) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects that are referenced by children of the specified ContentFolder (identified by Id) from the database in a lightweight fashion using the supplied connection.
loadByContentFolderId(Id, Connection, boolean) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects that are referenced by children of the specified ContentFolder (identified by Id) in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByContentId(Id) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects associated with the given piece of Content (identifed by Id) from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByContentId(Id, Connection) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects associated with the given piece of Content (identifed by Id) from the database in a lightweight fashion using the supplied connection.
loadByContentId(Id, Connection, boolean, boolean) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the list of ContentFile objects associated with the given piece of Content (identifed by Id) from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByContentId(Id) - Method in interface blackboard.persist.content.ContentStatusDbLoader
Loads a list of ContentStatus objects for a specific Content object.
loadByContentId(Id, Connection) - Method in interface blackboard.persist.content.ContentStatusDbLoader
Loads a list of ContentStatus objects for a specific Content object.
loadByContentId(Id) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc with the given content Id from the database using a connection obtained through this object's database context.
loadByContentId(Id, Connection) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc with the given content Id from the database using the supplied connection.
loadByCourse(ReportingPeriod, Course) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and Course from the database using a connection obtained through this object's database context.
loadByCourse(ReportingPeriod, Course, Connection) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and Course using the supplied connection.
loadByCourse(ReportingPeriod, Course, OutputStream) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Produces a report for all the courses associated with the given course and reporting period into output.
loadByCourse(Course) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
loadByCourse
loadByCourse(Course, Connection) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
loadByCourse
loadByCourseAndUserId(Id, Id) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given user and course id from the database using a connection obtained through this object's database context.
loadByCourseAndUserId(Id, Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given user and course id from the database using the supplied connection.
loadByCourseAndUserId(Id, Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given user and course id from the database using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects that currently exist for the course identified by the given course Id using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects that currently exist for the course identified by the given course Id using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the list of CalendarEntry objects for the given course Id using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the list of CalendarEntry objects for the given course Id using the supplied connection.
loadByCourseId(Id, Calendar, Calendar) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
 
loadByCourseId(Id, Calendar, Calendar, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
 
loadByCourseId(Id) - Method in interface blackboard.persist.content.AggregateReviewStatusDbLoader
Loads a list of AggregateReviewStatus objects for all users for the give Course Id
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.AggregateReviewStatusDbLoader
Loads a list of AggregateReviewStatus objects for all users for the give Course Id
loadByCourseId(Id) - Method in interface blackboard.persist.content.ContentStatusDbLoader
Loads a list of ContentStatus objects for a specific Course object.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.ContentStatusDbLoader
Loads a list of ContentStatus objects for a specific Course object.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.CourseUploadDbLoader
Load the list of CourseUpload objects associated with the given CourseId (identified by Id) from the database using the supplied connection.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.GroupUploadDbLoader
Load the list of GroupUpload objects associated with the given CourseId (identifed by Id) from the database using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Links defined within the given course (identified by id) from the database using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Links defined within the given course (identified by id) from the database using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the list of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the list of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using the supplied connection.
loadByCourseId(Id, Connection, boolean) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the list of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using the supplied connection.
loadByCourseId(String) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given course id (not pk) value from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByCourseId(String, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given course id (not pk) value from the database in a lightweight fashion using the supplied connection.
loadByCourseId(String, Connection, boolean) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given course id (not pk) from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given course (identified by id) using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.
loadByCourseId(Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.course.GroupDbLoader
Load the list of Groups contained with the course (identified by Id) from the database using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.course.GroupDbLoader
Load the list of Groups contained with the course (identified by Id) from the database using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the list of GroupMembership objects belonging to all groups defined within the given course (identified by id) using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the list of GroupMembership objects belonging to all groups defined within the given course (identified by id) using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads a list of Lineitem objects associated with the Course whose Id is provided, using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads a list of Lineitem objects associated with the Course whose Id is provided, using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the list of CourseToc objects that currently exist for the course identified by the given course Id using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the list of CourseToc objects that currently exist for the course identified by the given course Id using the supplied connection.
loadByCourseId(Id) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given course from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByCourseId(Id, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given course from the database in a lightweight fashion using the supplied connection.
loadByCourseId(Id, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given course from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByCourseIdAndLabel(Id, String) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc from the given course (identified by id) with the given label using a connection obtained through this object's database context.
loadByCourseIdAndLabel(Id, String, Connection) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc from the given course (identified by id) with the given label using the supplied connection.
loadByCourseIdAndLineitemName(Id, String) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using a connection obtained through this object's database context.
loadByCourseIdAndLineitemName(Id, String, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using the supplied connection.
loadByCourseIdAndRole(Id, CourseMembership.Role) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using a connection obtained through this object's database context.
loadByCourseIdAndRole(Id, CourseMembership.Role, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection.
loadByCourseIdAndRole(Id, CourseMembership.Role, Connection, boolean) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection.
loadByCourseIdAndUserId(Id, Id, Calendar, Calendar) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id.
loadByCourseIdAndUserId(Id, Id, Calendar, Calendar, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id using the supplied connection.
loadByCourseList(ReportingPeriod, BbList) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and CourseList from the database using a connection obtained through this object's database context.
loadByCourseList(ReportingPeriod, BbList, Connection) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and CourseList using the supplied connection.
loadByCourseList(ReportingPeriod, BbList, OutputStream) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Produces a report for all the courses associated with the given course list and reporting period into output.
loadByCourseMembershipId(Id) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using a connection obtained through this object's database context.
loadByCourseMembershipId(Id, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using the provided connection.
loadByCourseMembershipIdAndLineitemId(Id, Id) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads the Score for a given Lineitem and CourseMembership combination using a connection obtained through this object's database context.
loadByCourseMembershipIdAndLineitemId(Id, Id, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads the Score for a given Lineitem and CourseMembership combination using the provided connection.
loadByDataSourceBatchUid(String) - Method in interface blackboard.persist.course.CourseDbLoader
Loads the lists of Courses associated with the datasource (identified by the given batch uid) from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByDataSourceBatchUid(String, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Loads the lists of Courses associated with the datasource (identified by the given batch uid) from the database in a lightweight fashion using the suppplied connection.
loadByEmailAddressFamilyNameGivenName(String, String, String) - Method in interface blackboard.persist.user.UserDbLoader
Load the BbList of users with the given email address from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByEmailAddressFamilyNameGivenName(String, String, String, Connection) - Method in interface blackboard.persist.user.UserDbLoader
These three loaders are only used by the guest deposit module using different guest identifiers
loadByFileIdAndCourseMembershipId(Id, Id, Connection) - Method in interface blackboard.persist.content.CourseUploadDbLoader
Load CourseUpload object associated with the given File (identified by FileId) and courseMembershipIdfrom the database using the supplied connection.
loadByGroupAndUserId(Id, Id) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the GroupMembership with the given user and group id from the database using a connection obtained through this object's database context.
loadByGroupAndUserId(Id, Id, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the GroupMembership with the given user and group id from the database using the supplied connection.
loadByGroupId(Id) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the list of GroupMembership objects belonging to the given group (identified by id) using a connection obtained through this object's database context.
loadByGroupId(Id, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the list of GroupMembership objects belonging to the given group (identified by id) using the supplied connection.
loadByGroupId(Id) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given group from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByGroupId(Id, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given group from the database in a lightweight fashion using the supplied connection.
loadByGroupId(Id, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are enrolled in the given group from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadByHandle(String) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
Load the ContentHandler with the given handle from the database using a connection obtained through this object's database context.
loadByHandle(String, Connection) - Method in interface blackboard.platform.plugin.ContentHandlerDbLoader
Load the ContentHandler with the given handle from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the Announcement with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the Announcement with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the CalendarEntry with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the CalendarEntry with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Load the Content with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Load the Content with the given Id from the database in a lightweight fashion using the supplied connection.
loadById(Id, Connection, boolean, boolean) - Method in interface blackboard.persist.content.ContentDbLoader
Loads the Content with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the ContentFile with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the ContentFile with the given Id from the database in a lightweight fashion using the supplied connection.
loadById(Id, Connection, boolean) - Method in interface blackboard.persist.content.ContentFileDbLoader
Load the ContentFile with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadById(Id, Connection) - Method in interface blackboard.persist.content.CourseUploadDbLoader
Load the CourseUpload object with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Link with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Link with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Load the StaffInfo or StaffInfoFolder with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Load the StaffInfo or StaffInfoFolder with the given Id from the database using the supplied connection.
loadById(Id, Connection) - Method in interface blackboard.persist.content.UploadedFileDbLoader
Method loadById.
loadById(Id) - Method in interface blackboard.persist.course.CartridgeDbLoader
Load the Cartridge with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.course.CartridgeDbLoader
Load the Cartridge with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given Id from the database in a lightweight fashion using the supplied connection.
loadById(Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseDbLoader
Load the Course with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given Id from the database using the supplied connection.
loadById(Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the CourseMembership with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.course.GroupDbLoader
Load the Group with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.course.GroupDbLoader
Load the Group with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the GroupMembership with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbLoader
Load the GroupMembership with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads the Lineitem with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbLoader
Loads the Lineitem with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads the Score with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads the Score with the given Id from the database using the provided connection.
loadById(Id) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc with the given Id from the database using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc with the given Id from the database using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given Id from the database in a lightweight fashion using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given Id from the database in a lightweight fashion using the supplied connection.
loadById(Id, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadById(Id) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the UserRole with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadById(Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the UserRole with the given Id from the database in a lightweight fashion using the supplied connection.
loadByIdentifierAndPublisherName(String, String) - Method in interface blackboard.persist.course.CartridgeDbLoader
Load the Cartridge with the given identifier (string-based id) and publisher name from the database using a connection obtained through this object's database context.
loadByIdentifierAndPublisherName(String, String, Connection) - Method in interface blackboard.persist.course.CartridgeDbLoader
Load the Cartridge with the given identifier (string-based id) and publisher name from the database using the supplied connection.
loadByLineitemId(Id) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads a list of Score objects associated with the lineitem whose Id is provided, using a connection obtained through this object's database context.
loadByLineitemId(Id, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbLoader
Loads a list of Score objects associated with the Lineitem whose Id is provided, using the provided connection.
loadByParentId(Id) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the list of StaffInfo/StaffInfoFolder objects that are the children of the object with the given Id from the database using a connection obtained through this object's database context.
loadByParentId(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the list of StaffInfo/StaffInfoFolder objects that are the children of the object with the given Id from the database using the supplied connection.
loadByPortalRoleId(Id) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load all UserRole objects with the given portal role from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByPortalRoleId(Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load all UserRole objects with the given portal role from the database in a lightweight fashion using the supplied connection.
loadByPrimaryPortalRoleId(Id) - Method in interface blackboard.persist.user.UserDbLoader
Load all users by the given portalRole id in a lightweight fashion using a connection obtained through this object's database context.
loadByPrimaryPortalRoleId(Id, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load all users by the given portalRole id in a lightweight fashion using the supplied connection.
loadByPrimaryPortalRoleId(Id, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load all users by the given portalRole id in the specified fashion using the supplied connection.
loadByReferredToIdAndType(Id, Link.ReferredToType) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Link with the given referred to id and type from the database using a connection obtained through this object's database context.
loadByReferredToIdAndType(Id, Link.ReferredToType, Connection) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Links with the given referred to id and type from the database using the supplied connection.
loadByReferrerIdAndType(Id, Link.ReferrerType) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Link with the given referrer id and type from the database using a connection obtained through this object's database context.
loadByReferrerIdAndType(Id, Link.ReferrerType, Connection) - Method in interface blackboard.persist.content.LinkDbLoader
Load the Link with the given referrer id and type from the database using the supplied connection.
loadByRoleId(String) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given role id from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByRoleId(String, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given role id from the database in a lightweight fashion using the supplied connection.
loadByRoleName(String) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given name from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByRoleName(String, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole with the given name from the database in a lightweight fashion using the supplied connection.
loadBySourceKey(ReportingPeriod, String) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and data source key from the database using a connection obtained through this object's database context.
loadBySourceKey(ReportingPeriod, String, Connection) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Loads the GradeRecordList with the given ReportingPeriod and data source key using the supplied connection.
loadBySourceKey(ReportingPeriod, String, OutputStream) - Method in interface blackboard.persist.gradebook.GradeRecordDbLoader
Produces a report for all the courses associated with the given data source key and repoting period into output.
loadByStudentIdFamilyNameGivenName(String, String, String, Connection) - Method in interface blackboard.persist.user.UserDbLoader
 
loadByTocId(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Load the Content item that is the "Top" folder for the specified CourseToc (identified by Id) in a lightweight fashion using a connection obtained through this object's database context.
loadByTocId(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Load the Content item that is the "Top" folder for the specified CourseToc (identified by Id) in a lightweight fashion using the supplied connection.
loadByTocId(Id, Connection, boolean) - Method in interface blackboard.persist.content.ContentDbLoader
Load the Content item that is the "Top" folder for the specified CourseToc (identified by Id) in a lightweight fashion using the supplied connection.
loadByType(Announcement.Type) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects that currently exist of the type identified by the given Announcement.Type using a connection obtained through this object's database context.
loadByType(Announcement.Type, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbLoader
Load the list of Announcement objects that currently exist of the type identified by the given Announcement.Type using the supplied connection.
loadByType(CalendarEntry.Type) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the list of CalendarEntry objects of the given Calendar.Type using a connection obtained through this object's database context.
loadByType(CalendarEntry.Type, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Load the list of CalendarEntry objects of the given Calendar.Type using the supplied connection.
loadByType(CalendarEntry.Type, Calendar, Calendar) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
 
loadByType(CalendarEntry.Type, Calendar, Calendar, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
 
loadByUserId(Id) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
loadByUserId(Id, Calendar, Calendar, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.
loadByUserId(Id, Calendar, Calendar) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
loadByUserId(Id, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.
loadByUserId(Id) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled using a connection obtained through this object's database context.
loadByUserId(Id, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled using the supplied connection.
loadByUserId(Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in the specified fashion (lightweight or heavyweight) in which the given user (identified by id) is enrolled using the supplied connection.
loadByUserId(Id) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given user (identified by id) using a connection obtained through this object's database context.
loadByUserId(Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection.
loadByUserId(Id, Connection, boolean) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection.
loadByUserId(Id) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the list of UserRole objects belonging to the given user (identified by id) using a connection obtained through this object's database context.
loadByUserId(Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the list of UserRole objects belonging to the given user (identified by id) using the supplied connection.
loadByUserIdAndCourseMembershipRole(Id, CourseMembership.Role) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled with a specific course based role using a connection obtained through this object's database context.
loadByUserIdAndCourseMembershipRole(Id, CourseMembership.Role, Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled with a specific course based role using the supplied connection.
loadByUserIdAndCourseMembershipRole(Id, CourseMembership.Role, Connection, boolean) - Method in interface blackboard.persist.course.CourseDbLoader
Load the list of Course objects in the specified fashion (lightweight or heavyweight) in which the given user (identified by id) with a specific course based role is enrolled using the supplied connection.
loadByUserIdAndPortalRoleId(Id, Id) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the UserRole object with the given user id and institution role from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByUserIdAndPortalRoleId(Id, Id, Connection) - Method in interface blackboard.persist.user.UserRoleDbLoader
Load the UserRole object with the given user id and institution role from the database in a lightweight fashion using the supplied connection.
loadByUserName(String) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given username from the database in a lightweight fashion using a connection obtained through this object's database context.
loadByUserName(String, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given username from the database in a lightweight fashion using the supplied connection.
loadByUserName(String, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load the User with the given username from the database in the specified fashion (lightweight or heavyweight) using the supplied connection.
loadChildren(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list containing the immediate children of the specified Content item (identified by Id) from the database in a lightweight fashion using a connection obtained through this object's database context.
loadChildren(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list containing the immediate children of the specified Content item (identified by Id) from the database in a lightweight fashion using a connection obtained using the supplied Connection.
loadChildren(Id, boolean, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list containing the immediate children of the specified Content item (identified by Id) from the database using a connection obtained using the supplied Connection.
loadContentFiles(Content, Connection) - Method in class blackboard.data.content.ContentWrapper
 
loadContentPath(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list of content items containing the specified Content item (identified by Id) along with all of its ancestors from the database in a lightweight fashion using a connection obtained through this object's database context.
loadContentPath(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list of content items containing the specified Content item (identified by Id) along with all of its ancestors from the database in a lightweight fashion using a connection obtained using the supplied Connection.
loadDefault() - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the default PortalRole object in the system from the database in a lightweight fashion using a connection obtained through this object's database context.
loadDefault(Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the default PortalRole object in the system from the database in a lightweight fashion using the supplied connection.
loadEntryPointByCourseId(Id) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc that represents the entry point for the given course (identified by id) using a connection obtained through this object's database context.
loadEntryPointByCourseId(Id, Connection) - Method in interface blackboard.persist.navigation.CourseTocDbLoader
Load the CourseToc that represents the entry point for the given course (identified by id) using the supplied connection.
Loader - Interface in blackboard.persist
The Loader interface provides the base model for any object loader defined within the persistence framework.
loadFolderByCourseId(Id) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the folder of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using a connection obtained through this object's database context.
loadFolderByCourseId(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the folder of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using the supplied connection.
loadFolderByCourseId(Id, Connection, boolean) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the folder of StaffInfo/StaffInfoFolder objects for the given course (identified by id) from the database using the supplied connection.
loadGuestUser() - Method in interface blackboard.persist.user.UserDbLoader
Load the "guest" user using a connection obtained through this object's database context.
loadInstructorsByUser(Id) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using a connection obtained through this object's database context.
loadInstructorsByUser(Id, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbLoader
Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using the supplied connection.
loadList(InputStream) - Method in interface blackboard.persist.content.ContentStatusXmlLoader
Load the list of ContentStatus objects associated with the given InputStream (identifed by in).
loadList(Element) - Method in interface blackboard.platform.plugin.ContentHandlerXmlLoader
Generates a BbList of ContentHandler objects from the Element tree provided.
loadList(InputStream) - Method in interface blackboard.platform.plugin.ContentHandlerXmlLoader
Generates a BbList of ContentHandler objects from the InputStream provided.
loadListById(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list of Content by performing a deep load rooted at the content item with the given Id.
loadListById(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list of Content by performing a deep load rooted at the content item with the given Id.
loadListById(Id, Connection, boolean) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list of Content by performing a deep load rooted at the content item with the given Id.
loadMapView(Id, Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Returns a list of items representing the top-level content items in the course.
loadObservedByObserverId(Id) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are/can be observed by the given observer (identified by their user id) in a lightweight fashion using a connection obtained through this object's database context.
loadObservedByObserverId(Id, Connection) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are/can be observed by the given observer (identified by their user id) in a lightweight fashion using the supplied connection.
loadObservedByObserverId(Id, Connection, boolean) - Method in interface blackboard.persist.user.UserDbLoader
Load all users that are/can be observed by the given observer (identified by their user id) in the specified fashion using the supplied connection.
loadPathAndStatus(Id, Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Method to return a path to a given item.
loadPersonalByUserId(Id, Calendar, Calendar) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of personal calendar entries within a given date range that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
loadPersonalByUserId(Id, Calendar, Calendar, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbLoader
Loads the list of personal calendar entries that pertain to the user identified by the given user Id using the supplied connection.
loadPrimaryRoleByUserId(Id) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole that is the primary portal role for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.
loadPrimaryRoleByUserId(Id, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the PortalRole that is the primary portal role for the given user from the database in a lightweight fashion using the supplied connection.
loadRemovable() - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that have a removable attribute of true from the database in a lightweight fashion using a connection obtained through this object's database context.
loadRemovable(Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that have a removable attribute of true from the database in a lightweight fashion using the supplied connection.
loadReviewableByCourseId(Id) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list containing the all the Content items in the given course which have reviewable flag set to true.
loadReviewableByCourseId(Id, Connection) - Method in interface blackboard.persist.content.ContentDbLoader
Loads a list containing the all the Content items in the given course which have reviewable flag set to true.
loadSecondaryRolesByUserId(Id) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that represent the secondary portal roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.
loadSecondaryRolesByUserId(Id, Connection) - Method in interface blackboard.persist.role.PortalRoleDbLoader
Load the list of PortalRole objects that represent the secondary portal roles for the given user from the database in a lightweight fashion using the supplied connection.
loadTemplates() - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system with a course registry flag indicating they are course templates.
loadTemplates(Connection) - Method in interface blackboard.persist.course.CourseDbLoader
Load all course objects in the system with a course registry flag indicating they are course templates.
LOCAL - Static variable in class blackboard.data.content.ContentFile.StorageType
 
LOCAL_USER - Static variable in class blackboard.platform.session.BbSession.Scope
Deprecated. Attributes with local scope are stored in memory and are available to all webapps and other consumers in the system.
LOCALE - Static variable in interface blackboard.data.course.CourseDef
 
LOCALE - Static variable in interface blackboard.data.user.UserDef
 
Log - Interface in blackboard.platform.log
Interface to represent interaction with a physical log.
log(String, LogService.Verbosity) - Method in interface blackboard.platform.log.Log
Logs the specified message at the appropriate verbosity.
log(String, Throwable, LogService.Verbosity) - Method in interface blackboard.platform.log.Log
Logs the specified message at the appropriate verbosity.
logDebug(String) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "debug" level.
logDebug(String, Throwable) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "debug" level.
logError(String) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "error" level.
logError(String, Throwable) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "error" level.
logFatal(String) - Method in interface blackboard.platform.log.Log
Logs specified message at "fatal" level
logFatal(String, Throwable) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "fatal" level.
logInfo(String) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "info" level.
logInfo(String, Throwable) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "info" level.
LogService - Interface in blackboard.platform.log
Core platform service for managing different logs for messages from the application.
LogService.Verbosity - Class in blackboard.platform.log
Enumeration of different log levels used in filtering log messages.
logSqlWarnings(String, SQLWarning) - Method in interface blackboard.platform.log.Log
Logs the specified message, and attaches output associated with the specified SQLWarning.
logSqlWarnings(ResultSet) - Method in interface blackboard.platform.log.Log
Logs output associated with the SQLWarnings associated with the specified ResultSet.
logSqlWarnings(Connection) - Method in interface blackboard.platform.log.Log
Logs output associated with the SQLWarnings associated with the specified Connection.
logSqlWarnings(Connection, Statement, ResultSet) - Method in interface blackboard.platform.log.Log
Logs output associated with the SQLWarnings associated with the Connection, Statement and ResultSet.
logSqlWarnings(Statement) - Method in interface blackboard.platform.log.Log
Logs output associated with the SQLWarnings associated with the specified Statement.
logWarning(String) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "warning" level.
logWarning(String, Throwable) - Method in interface blackboard.platform.log.Log
Logs the specified message at the "warning" level.
LONG - Static variable in class blackboard.data.BbAttribute.Type
 
lookupCourseContext(HttpServletRequest) - Method in interface blackboard.platform.session.BbSession
Deprecated. The return object is not part of the public API and has been removed from use.
lookupGroupContext(HttpServletRequest) - Method in interface blackboard.platform.session.BbSession
Deprecated. The return object is not part of the public API and has been removed from use.
lookupLicense(String) - Method in class blackboard.platform.LicenseManager
Returns the License associated with the specified component key.
lookupLicenseDescriptor(String) - Method in class blackboard.platform.LicenseManager
Looks up human-readable descriptor for specified component.
lookupRequestContext(HttpServletRequest) - Method in interface blackboard.platform.session.BbSession
Deprecated. The return object is not part of the public API and has been removed from use.
lookupService(Class) - Static method in class blackboard.platform.BbServiceManager
Principal brokering method for use by third party programmers; takes the service interface and locates the correct service implementation.
lookupService(String) - Static method in class blackboard.platform.BbServiceManager
Actual broker method for service lookups.
lookupTopFolderId(Id) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the Id of "Top" StaffInfoFolder for the given course (identified by id) from the database using a connection obtained through this object's database context.
lookupTopFolderId(Id, Connection) - Method in interface blackboard.persist.content.StaffInfoDbLoader
Loads the Id of "Top" StaffInfoFolder for the given course (identified by id) from the database using the supplied connection.
lookupUserContext(HttpServletRequest) - Method in interface blackboard.platform.session.BbSession
Deprecated. The return object is not part of the public API and has been removed from use.

M

main(String[]) - Static method in class blackboard.data.AttributePermission
 
main(String[]) - Static method in class blackboard.persist.PersistPermission
 
main(String[]) - Static method in class blackboard.platform.ApplicationLauncher
Arguments for application invocation are as follows: -S Service configuration level.
MAIN_DATA - Static variable in interface blackboard.data.content.ContentDef
 
MALE - Static variable in class blackboard.data.user.User.Gender
Male
mapId(Id, Container) - Method in interface blackboard.persist.PersistenceContext
Maps the given Id in the specified container space.
mapToInstRole(Id) - Static method in class blackboard.data.user.User.InstRole
Deprecated.  
mapToPortalRoleId(User.InstRole) - Static method in class blackboard.data.user.User.InstRole
Deprecated.  
markReviewed(Id, Id) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using a connection from the associated persistence manager's database container as status "Reviewed" by the user identified by userId.
markReviewed(Id, Id, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using the supplied connection as status "Reviewed" by the user identified by userId.
markReviewed(Id, Id, Calendar) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using a connection from the associated persistence manager's database container as status "Reviewed" by the user identified by userId.
markReviewed(Id, Id, Calendar, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using a connection from the associated persistence manager's database container as status "Reviewed" by the user identified by userId.
markUnreviewed(Id, Id) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using the supplied connection as status "Not Reviewed" by the user identified by userId.
markUnreviewed(Id, Id, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Marks the Content identified by the given contentId value using the supplied connection as status "Not Reviewed" by the user identified by userId.
matchesContainer(Container) - Method in class blackboard.persist.Id
Returns true if the given Container matches the Container of this Id.
matchesDataType(DataType) - Method in class blackboard.persist.Id
Returns true if the given DataType matches the DataType of this Id.
MAX_HEAPSIZE_TOMCAT - Static variable in class blackboard.platform.config.BbConfig
 
MAX_STACKSIZE_TOMCAT - Static variable in class blackboard.platform.config.BbConfig
 
MEMBERSHIP - Static variable in interface blackboard.data.content.ContentStatusDef
 
METADATA - Static variable in interface blackboard.data.content.ContentDef
 
MIDDLE_NAME - Static variable in interface blackboard.data.user.UserInfoDef
 
MIDTERM - Static variable in class blackboard.data.gradebook.ReportingPeriod
 
MIN_HEAPSIZE_TOMCAT - Static variable in class blackboard.platform.config.BbConfig
 
MOBILE_PHONE - Static variable in interface blackboard.data.user.UserInfoDef
 
MODE_AVAILABILITY - Static variable in class blackboard.platform.plugin.PlugInComparator
PlugIns are compared based on the isAvailable attribute
MODE_NAME - Static variable in class blackboard.platform.plugin.PlugInComparator
PlugIn objects are compared based on the name attribute
MODE_VENDOR - Static variable in class blackboard.platform.plugin.PlugInComparator
PlugIns are compared on the vendorName attribute
MODE_VERSION - Static variable in class blackboard.platform.plugin.PlugInComparator
PlugIns are compared on the Version attribute
MODE_WEBAPP_TYPE - Static variable in class blackboard.platform.plugin.PlugInComparator
PlugIns are compared on the webAppType attribute
MULTIPART_TKN - Static variable in class blackboard.platform.filesystem.MultipartRequest
 
MultipartRequest - Class in blackboard.platform.filesystem
Utility object to provide an encapsulation of all the data received in a file upload.
MultipartRequest() - Constructor for class blackboard.platform.filesystem.MultipartRequest
Default constructor.
MYSQL_DB_TYPE - Static variable in class blackboard.base.AppVersion
 

N

NAME - Static variable in interface blackboard.data.content.ChildFileDef
 
NAME - Static variable in interface blackboard.data.content.ContentFileDef
 
NAME - Static variable in interface blackboard.data.course.ButtonStyleDef
 
NAME - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
NAME - Static variable in interface blackboard.platform.plugin.PlugInDef
 
NAME_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
NAV_COLOR_BG - Static variable in interface blackboard.data.course.CourseDef
 
NAV_COLOR_FG - Static variable in interface blackboard.data.course.CourseDef
 
NAV_STYLE - Static variable in interface blackboard.data.course.CourseDef
 
NestedException - Exception in blackboard.base
Base exception class for application specific exceptions that wish to hide the underlying exceptions.
NestedException(String) - Constructor for exception blackboard.base.NestedException
Constructor
NestedException(Throwable) - Constructor for exception blackboard.base.NestedException
Constructor
NestedException(String, Throwable) - Constructor for exception blackboard.base.NestedException
Constructor
NestedRuntimeException - Exception in blackboard.base
Base exception class for application specific exceptions that wish to hide the underlying exceptions.
NestedRuntimeException(String) - Constructor for exception blackboard.base.NestedRuntimeException
Constructor
NestedRuntimeException(Throwable) - Constructor for exception blackboard.base.NestedRuntimeException
Constructor
NestedRuntimeException(String, Throwable) - Constructor for exception blackboard.base.NestedRuntimeException
Constructor
NET_MODULE_CLASS - Static variable in interface blackboard.platform.plugin.Constants
 
NET_WEB_APP - Static variable in interface blackboard.platform.plugin.Constants
 
newId(DataType) - Static method in class blackboard.persist.Id
Returns a new Id instance, using a default implementation.
next() - Method in class blackboard.base.BbList.Iterator
Returns the next element in the list.
next() - Method in class blackboard.base.FilteringIterator
Returns the next object in the iterator which passes all applied filters.
next() - Method in class blackboard.base.NullIterator
Since there is nothing to iterate over, this method always returns null.
nextObject() - Method in class blackboard.base.FilteringIterator
Deprecated. Use next() like a good Iterator should.
NO_EXPIRATION - Static variable in class blackboard.platform.License
 
NONE - Static variable in class blackboard.data.course.CourseMembership.Role
 
NONE - Static variable in class blackboard.data.user.User.SystemRole
 
NOOP - Static variable in class blackboard.base.ListFilter
A convenient filter implementation that allows any object to pass.
NOT_AVAILABLE_ONLY - Static variable in class blackboard.data.AvailabilityFilter
Can be provided to constructor as targetAvailability value
NOT_EQUALS - Static variable in class blackboard.base.GenericFieldFilter.Comparison
 
NOTES - Static variable in interface blackboard.data.course.CourseMembershipDef
 
NULL_DATA_TYPE - Static variable in class blackboard.persist.DataType
 
NULL_VALUE - Static variable in class blackboard.platform.security.authentication.SessionStub
 
NullIterator - Class in blackboard.base
A "null" implementation of the Iterator interface.
NUM_DAYS_OF_USE - Static variable in interface blackboard.data.course.CourseDef
 
NUM_SUPPORTED_AUTH_TYPES - Static variable in class blackboard.platform.security.authentication.HttpAuthConfig
 

O

OBJECT - Static variable in class blackboard.data.BbAttribute.Type
 
ObjectSerializationException - Exception in blackboard.persist
ObjectSerializationException
ObjectSerializationException(String) - Constructor for exception blackboard.persist.ObjectSerializationException
Creates a ConstraintViolationException with the given message.
OBSERVER - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
OBSERVER - Static variable in class blackboard.data.user.User.SystemRole
Observer role.
OFFICE_ADDRESS - Static variable in interface blackboard.data.content.StaffInfoDef
 
OFFICE_HOURS - Static variable in interface blackboard.data.content.StaffInfoDef
 
OFFLINE_NAME - Static variable in interface blackboard.data.content.ContentDef
 
OFFLINE_PATH - Static variable in interface blackboard.data.content.ContentDef
 
OPERATING - Static variable in class blackboard.platform.StatusCode
 
ORACLE_CLIENT_DRIVERTYPE - Static variable in class blackboard.platform.config.BbConfig
 
ORACLE_DB_TYPE - Static variable in class blackboard.base.AppVersion
 
Organization - Class in blackboard.data.course
The Organization class provides a representation of an organization (or community) within the Blackboard system.
Organization() - Constructor for class blackboard.data.course.Organization
Creates an instance of Organization with default property values.
OS_FILE_SEPARATOR - Static variable in class blackboard.platform.config.BbConfig
 
OS_PATH_SEPARATOR - Static variable in class blackboard.platform.config.BbConfig
 
OTHER - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  

P

PACE_TYPE - Static variable in interface blackboard.data.course.CourseDef
 
PACKAGE - Static variable in class blackboard.data.content.ContentFile.Action
 
PACKAGE - Static variable in class blackboard.data.content.UploadedFile.Action
 
PackageXmlDef - Interface in blackboard.platform.plugin
Class to record the element and attribute strings used in the plug-in manifest.
PARAM - Static variable in class blackboard.platform.License.XmlDef
 
PARENT - Static variable in interface blackboard.data.course.ClassificationDef
 
PARENT_ID - Static variable in interface blackboard.data.content.ChildFileDef
 
PARENT_ID - Static variable in interface blackboard.data.content.ContentDef
 
PARENT_ID - Static variable in interface blackboard.data.content.StaffInfoDef
 
PARENT_ID - Static variable in interface blackboard.data.content.UploadedFileDef
 
PARENT_ID - Static variable in interface blackboard.data.course.ClassificationDef
 
parse(String) - Static method in class blackboard.platform.plugin.Version
Parses a string of the form "n.n.n.n" into a Version object.
PARSE_ARGS - Static variable in class blackboard.platform.ApplicationLauncher
 
parsePermissions(String) - Static method in class blackboard.platform.security.PermissionParser
Returns a Permissions collection parsed from the string.
parsePermissions(Element) - Static method in class blackboard.platform.security.PermissionParser
Fills a permissions collection from the XML element passed in.
PASSES_RULE - Static variable in interface blackboard.data.content.ContentStatusDef
 
passesFilter(Object) - Method in class blackboard.base.GenericFieldFilter
Returns true if the given element passes this filter's tests for inclusion in the sublist.
passesFilter(Object) - Method in class blackboard.base.ListFilter
Returns true if the given element passes this filter's tests for inclusion in the sublist.
passesFilter(Object) - Method in class blackboard.data.AvailabilityFilter
Implements passesFilter method of the ListFilter class.
passesFilter(Object) - Method in class blackboard.data.course.CourseMembershipRoleFilter
 
passesFilter(Object) - Method in class blackboard.persist.FilterCacheByLoader
 
passesFilters(Object) - Method in class blackboard.base.ListFilter
Returns true if the element passes all of the filters in this linked list.
PASSWORD - Static variable in interface blackboard.data.user.UserDef
 
PERL_TRACELEVEL - Static variable in class blackboard.platform.config.BbConfig
 
PermissionParser - Class in blackboard.platform.security
Utility class to parse and serialize permission sets for system extension manifests.
PermissionParser() - Constructor for class blackboard.platform.security.PermissionParser
 
PERMISSIONS_STRING - Static variable in interface blackboard.platform.plugin.PlugInDef
 
persist() - Method in class blackboard.data.BbObject
Inserts or updates the current BbObject in a lightweight fashion.
persist(Announcement) - Method in interface blackboard.persist.announcement.AnnouncementDbPersister
Inserts or updates the supplied Announcement using a connection from the associated persistence manager's database container.
persist(Announcement, Connection) - Method in interface blackboard.persist.announcement.AnnouncementDbPersister
Inserts or updates the supplied Announcement using the supplied connection.
persist(CalendarEntry) - Method in interface blackboard.persist.calendar.CalendarEntryDbPersister
Inserts or updates the supplied CalendarEntry using a connection from the associated persistence manager's database container.
persist(CalendarEntry, Connection) - Method in interface blackboard.persist.calendar.CalendarEntryDbPersister
Inserts or updates the supplied CalendarEntry using the supplied connection.
persist(Content) - Method in interface blackboard.persist.content.ContentDbPersister
Inserts or updates the supplied Content using a connection from the associated persistence manager's database container.
persist(Content, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Inserts or updates the supplied Content using the supplied connection.
persist(ContentFile) - Method in interface blackboard.persist.content.ContentFileDbPersister
Inserts or updates the supplied Content using a connection from the associated persistence manager's database container.
persist(ContentFile, Connection) - Method in interface blackboard.persist.content.ContentFileDbPersister
Inserts or updates the supplied Content using the supplied connection.
persist(CourseUpload, Connection) - Method in interface blackboard.persist.content.CourseUploadDbPersister
Inserts or updates the supplied CourseUpload using the supplied connection.
persist(GroupUpload, Connection) - Method in interface blackboard.persist.content.GroupUploadDbPersister
Inserts or updates the supplied GroupUpload using the supplied connection.
persist(Link) - Method in interface blackboard.persist.content.LinkDbPersister
Inserts or updates the supplied Link using a connection from the associated persistence manager's database container.
persist(Link, Connection) - Method in interface blackboard.persist.content.LinkDbPersister
Inserts or updates the supplied Link using the supplied connection.
persist(StaffInfo) - Method in interface blackboard.persist.content.StaffInfoDbPersister
Inserts or updates the supplied StaffInfo using a connection from the associated persistence manager's database container.
persist(StaffInfo, Connection) - Method in interface blackboard.persist.content.StaffInfoDbPersister
Inserts or updates the supplied StaffInfo using the supplied connection.
persist(UploadedFile, Connection) - Method in interface blackboard.persist.content.UploadedFileDbPersister
 
persist(Cartridge) - Method in interface blackboard.persist.course.CartridgeDbPersister
Inserts or updates the supplied Cartridge using a connection from the associated persistence manager's database container.
persist(Cartridge, Connection) - Method in interface blackboard.persist.course.CartridgeDbPersister
Inserts or updates the supplied Cartridge using the supplied connection.
persist(Course) - Method in interface blackboard.persist.course.CourseDbPersister
Inserts or updates the supplied Course in a lightweight fashion using a connection from the associated persistence manager's database container.
persist(Course, Connection) - Method in interface blackboard.persist.course.CourseDbPersister
Inserts or updates the supplied Course in a lightweight fashion using the supplied connection.
persist(CourseMembership) - Method in interface blackboard.persist.course.CourseMembershipDbPersister
Inserts or updates the supplied CourseMembership using a connection from the associated persistence manager's database container.
persist(CourseMembership, Connection) - Method in interface blackboard.persist.course.CourseMembershipDbPersister
Inserts or updates the supplied CourseMembership using the supplied connection.
persist(Group) - Method in interface blackboard.persist.course.GroupDbPersister
Inserts or updates the supplied Group using a connection from the associated persistence manager's database container.
persist(Group, Connection) - Method in interface blackboard.persist.course.GroupDbPersister
Inserts or updates the supplied Group using the supplied connection.
persist(GroupMembership) - Method in interface blackboard.persist.course.GroupMembershipDbPersister
Inserts or updates the supplied GroupMembership using a connection from the associated persistence manager's database container.
persist(GroupMembership, Connection) - Method in interface blackboard.persist.course.GroupMembershipDbPersister
Inserts or updates the supplied GroupMembership using the supplied connection.
persist(Lineitem) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Stores the given Lineitem into the database using a connection obtained through this object's database context.
persist(Lineitem, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Stores the given Lineitem into the database using the provided connection.
persist(BbList) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Stores the given LineitemList into the database Lineitem by Lineitem using a connection obtained through this object's database context.
persist(BbList, Connection) - Method in interface blackboard.persist.gradebook.LineitemDbPersister
Stores the given LineitemList into the database Lineitem by Lineitem using the provided connection.
persist(Score) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Inserts or updates the supplied Score using a connection from the associated persistence manager's database container.
persist(Score, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Inserts or updates the supplied Score using the supplied connection.
persist(BbList) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Inserts or updates the supplied ScoreList, Score by Score, using a connection from the associated persistence manager's database container.
persist(BbList, Connection) - Method in interface blackboard.persist.gradebook.ScoreDbPersister
Inserts or updates the supplied ScoreList, Score by Score, using the supplied connection.
persist(PortalRole) - Method in interface blackboard.persist.role.PortalRoleDbPersister
Inserts or updates the supplied PortalRole using a connection from the associated persistence manager's database container.
persist(PortalRole, Connection) - Method in interface blackboard.persist.role.PortalRoleDbPersister
Inserts or updates the supplied PortalRole using the supplied connection.
persist(User) - Method in interface blackboard.persist.user.UserDbPersister
Inserts or updates the supplied User using a connection from the associated persistence manager's database container.
persist(User, Connection) - Method in interface blackboard.persist.user.UserDbPersister
Inserts or updates the supplied User using the supplied connection.
persist(UserRole) - Method in interface blackboard.persist.user.UserRoleDbPersister
Inserts or updates the supplied UserRole using a connection from the associated persistence manager's database container.
persist(UserRole, Connection) - Method in interface blackboard.persist.user.UserRoleDbPersister
Inserts or updates the supplied UserRole using the supplied connection.
persist(ContentHandler) - Method in interface blackboard.platform.plugin.ContentHandlerDbPersister
Stores the specified content handler into the database associated with the current Virtual Installation.
persist(ContentHandler, Connection) - Method in interface blackboard.platform.plugin.ContentHandlerDbPersister
Stores the specified Content handler into the database specified.
persist(ContentHandler, Document) - Method in interface blackboard.platform.plugin.ContentHandlerXmlPersister
Generates an Element tree whose values and structure matches the contents of the provided ContentHandler object.
persist(PlugIn) - Method in interface blackboard.platform.plugin.PlugInDbPersister
Stores the target PlugIn into the current VirtualInstallation
persist(PlugIn, Connection) - Method in interface blackboard.platform.plugin.PlugInDbPersister
 
PersistenceCacheTask - Class in blackboard.persist
The PersistenceCacheTask represents a Task used to coordinate cached information.
PersistenceCacheTask() - Constructor for class blackboard.persist.PersistenceCacheTask
 
PersistenceContext - Interface in blackboard.persist
The PersistenceContext interface describes an object capable of storing and tracking object Id changes as those objects move between containers within the persistence framework.
PersistenceException - Exception in blackboard.persist
This class wraps exceptions generated during the persisting or loading of objects.
PersistenceException(String) - Constructor for exception blackboard.persist.PersistenceException
Creates a PersistenceException with the given message.
PersistenceException(Throwable) - Constructor for exception blackboard.persist.PersistenceException
Constructor
PersistenceException(String, Throwable) - Constructor for exception blackboard.persist.PersistenceException
Creates a PersistenceException with the given message and provided nested exception.
PersistenceInitializationService - Class in blackboard.persist
PersistenceInitializationService
PersistenceInitializationService() - Constructor for class blackboard.persist.PersistenceInitializationService
 
PersistenceService - Interface in blackboard.platform.persistence
PersistenceService
Persister - Interface in blackboard.persist
The Persister interface provides the base model for any object persister defined within the persistence framework.
persistList(List, Document) - Method in interface blackboard.persist.content.ContentStatusXmlPersister
Generates an Element whose children are the provided ContentStatus objects persisted to XML.
persistList(BbList, Document) - Method in interface blackboard.platform.plugin.ContentHandlerXmlPersister
Generates an Element whose children are the provided ContentHandler objects persisted to XML.
PersistPermission - Class in blackboard.persist
Permission encapsulating granular access to data object attributes.
PersistPermission(String, String) - Constructor for class blackboard.persist.PersistPermission
 
PERSONAL - Static variable in class blackboard.data.calendar.CalendarEntry.Type
The entry is associated with a user, and is viewed in the system-level calendar tool, which also aggregates system entries and course entries for the current user.
PERSONAL_INFO - Static variable in interface blackboard.data.course.CourseMembershipDef
 
PHONE - Static variable in interface blackboard.data.content.StaffInfoDef
 
PkId - Class in blackboard.persist
The PkId class provides the means of describing an Id within a Blackboard database container.
PkId(Container, DataType, int, int) - Constructor for class blackboard.persist.PkId
Instantiate a new PkId with the given Container, DataType, and pk key values as integers.
PkId(Container, DataType, String, String) - Constructor for class blackboard.persist.PkId
Instantiate a new PkId with the given Container, DataType, and pk key values as strings.
PkId(Container, DataType, String) - Constructor for class blackboard.persist.PkId
Instantiate a new PkId with the given Container, DataType, and pk key values as a single string.
PLAIN_TEXT - Static variable in class blackboard.base.FormattedText.Type
Treat text as unformatted; HTML characters will be entity escaped at render time.
PLUGIN_HANDLE - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
PLUGIN_ID - Static variable in interface blackboard.platform.plugin.ContentHandlerDef
 
PlugInComparator - Class in blackboard.platform.plugin
Comparator implementation to sort lists of PlugIns.
PlugInComparator(int) - Constructor for class blackboard.platform.plugin.PlugInComparator
Instantiates a comparator with the specified mode.
PlugInDbLoader - Interface in blackboard.platform.plugin
Loader interface to retrieve PlugIn instances from the database.
PlugInDbPersister - Interface in blackboard.platform.plugin
Class to persist PlugIn definitions to the database.
PlugInDef - Interface in blackboard.platform.plugin
 
PlugInException - Exception in blackboard.platform.plugin
This class wraps exceptions generated during the execution of plugins.
PlugInException(String) - Constructor for exception blackboard.platform.plugin.PlugInException
Creates a PlugInException with the given message.
PlugInException(String, Exception) - Constructor for exception blackboard.platform.plugin.PlugInException
Creates a PlugInException with the given message and provided nested exception.
PlugInManager - Class in blackboard.platform.plugin
The PlugInManager is responsible for maintaining plugin definitions for the system.
PlugInManager() - Constructor for class blackboard.platform.plugin.PlugInManager
 
PlugInUtil - Class in blackboard.platform.plugin
The PlugInUtil class is a utility class for plug-ins for the Blackboard application.
PlugInUtil() - Constructor for class blackboard.platform.plugin.PlugInUtil
 
PORTAL - Static variable in class blackboard.data.user.User.SystemRole
 
PORTAL_ROLE - Static variable in interface blackboard.data.user.UserDef
 
PORTAL_ROLE_ID - Static variable in interface blackboard.data.user.UserDef
 
PORTAL_ROLE_ID - Static variable in interface blackboard.data.user.UserRoleDef
 
PortalRole - Class in blackboard.data.role
The PortalRole class is a representation of an institution role within the Blackboard application.
PortalRole() - Constructor for class blackboard.data.role.PortalRole
Creates an instance of PortalRole with default property values.
PortalRoleDbLoader - Interface in blackboard.persist.role
This interface describes the set of methods that all database loaders for PortalRole objects must implement.
PortalRoleDbLoader.Default - Class in blackboard.persist.role
A utility class that provides quick access to the PortalRoleDbLoader instance associated with the default instance of the database BbPersistenceManager.
PortalRoleDbLoader.Default() - Constructor for class blackboard.persist.role.PortalRoleDbLoader.Default
 
PortalRoleDbPersister - Interface in blackboard.persist.role
 
PortalRoleDbPersister.Default - Class in blackboard.persist.role
A utility class that provides quick access to the PortalRoleDbPersister instance associated with the default instance of the database BbPersistenceManager.
PortalRoleDbPersister.Default() - Constructor for class blackboard.persist.role.PortalRoleDbPersister.Default
 
POS_UNDEFINED - Static variable in interface blackboard.data.Positionable
 
POSITION - Static variable in interface blackboard.data.content.ContentDef
 
POSITION - Static variable in interface blackboard.data.content.StaffInfoDef
 
Positionable - Interface in blackboard.data
The Positionable interface specifies a set of methods for setting/determining the position of an object within a list of objects.
POST_GRADUATE_SCHOOL - Static variable in class blackboard.data.user.User.EducationLevel
Post-graduate school student.
printStackTrace() - Method in exception blackboard.base.NestedException
Prints stack trace to log.
printStackTrace(PrintStream) - Method in exception blackboard.base.NestedException
printStackTrace
printStackTrace(PrintWriter) - Method in exception blackboard.base.NestedException
Prints stack trace to given PrintWriter.
printStackTrace() - Method in exception blackboard.base.NestedRuntimeException
printStackTrace
printStackTrace(PrintStream) - Method in exception blackboard.base.NestedRuntimeException
printStackTrace
printStackTrace(PrintWriter) - Method in exception blackboard.base.NestedRuntimeException
printStackTrace
printStackTrace() - Method in exception blackboard.platform.BbServiceException
printStackTrace
printStackTrace(PrintStream) - Method in exception blackboard.platform.BbServiceException
printStackTrace
printStackTrace(PrintWriter) - Method in exception blackboard.platform.BbServiceException
printStackTrace
printStackTrace() - Method in exception blackboard.platform.RuntimeBbServiceException
printStackTrace
printStackTrace(PrintStream) - Method in exception blackboard.platform.RuntimeBbServiceException
printStackTrace
printStackTrace(PrintWriter) - Method in exception blackboard.platform.RuntimeBbServiceException
printStackTrace
printTree() - Method in class blackboard.data.content.Content
printTree
processUpload(HttpServletRequest) - Method in interface blackboard.platform.filesystem.FileSystemService
Reads the file from the multipart stream and saves out the stream as a File.
PRODUCT_NAME_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
PRODUCT_OWNED_ID_ATTR - Static variable in class blackboard.platform.License.XmlDef
 
PROSPECTIVE_STUDENT - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
PUBLISHER_NAME - Static variable in interface blackboard.data.course.CartridgeDef
 
purgeContext() - Method in interface blackboard.platform.context.ContextManager
Releases the current context and flushes it from thread local storage.
putInCache(String, Object) - Method in class blackboard.persist.Cache
 
putInCache(String, Object, String[]) - Method in class blackboard.persist.Cache
 

R

RDBMSAuthUtil - Class in blackboard.platform.security.authentication
Utility class used by classes in the authentication package.
RDBMSAuthUtil() - Constructor for class blackboard.platform.security.authentication.RDBMSAuthUtil
 
readResolve() - Method in class blackboard.base.BbEnum
Serialization over-ride to ensure that a serialized object obeys object identify as defined for the BbEnum class.
RECEIVED - Static variable in class blackboard.data.content.CourseUpload.Status
 
RECYCLED - Static variable in interface blackboard.data.content.UploadedFileDef
 
refresh() - Method in class blackboard.platform.security.BbPolicy
Refreshes/reloads the policy configuration.
refreshCache() - Method in interface blackboard.persist.CachingLoader
Tells the loader its data has been modified externally and it should refresh.
refreshCachedInfo() - Method in class blackboard.platform.plugin.PlugInManager
Loads the plugin and content handler definitions into an in-memory cache.
refreshLoader(String) - Method in class blackboard.persist.BbPersistenceManager
Method to signal the cache for the specified type to refresh from the database.
registerCodeSource(File, PermissionCollection) - Method in interface blackboard.platform.security.AccessManagerService
A utility method used by the B2 framework to apply run-time permissions to the system extensions as they are loaded into the system.
REGISTERED - Static variable in class blackboard.data.course.Course.ServiceLevel
 
registerLoader(String) - Method in class blackboard.persist.FilterCacheByLoader
Adds the given loader to the list for this filter.
registerModule(Module, Connection) - Method in class blackboard.platform.plugin.PlugInManager
Registers the specified module in the database.
registerReference(Id, Id) - Method in interface blackboard.persist.PersistenceContext
Registers an Id mapping with the context.
registerService(String, String) - Static method in class blackboard.platform.BbServiceManager
Registers service, binding it to the specified service name.
registerService(Class, Class) - Static method in class blackboard.platform.BbServiceManager
Registers service, binding it to the specified service name.
registerService(Class, Object) - Static method in class blackboard.platform.BbServiceManager
Not implemented.
REGISTRY - Static variable in interface blackboard.data.content.ChildFileDef
 
REGISTRY - Static variable in interface blackboard.data.content.ContentFileDef
 
REGISTRY - Static variable in interface blackboard.data.course.CourseDef
 
REGISTRY - Static variable in interface blackboard.data.user.UserDef
 
REGULAR - Static variable in class blackboard.data.content.Content.RenderType
Renders the underlying object in the default fashion (a la Course Documents)
reInit() - Method in class blackboard.platform.plugin.PlugInManager
Reloads plugin info from the database, initializing webapps as necessary.
releaseContext() - Method in interface blackboard.platform.context.ContextManager
Releases the current context.
RemoteDbContainer - Class in blackboard.persist
The RemoteDbContainer class implements the Container interface for remote access of specific persistence operations.
RemoteDbContainer(AppVersion) - Constructor for class blackboard.persist.RemoteDbContainer
Constructor - creates a new XmlContainer object with the given AppVersion as the default AppVersion for future framework calls on this container.
remove(int) - Method in class blackboard.base.BbDeleteTrackingList
Removes the element at the specified position in this list.
remove(Object) - Method in class blackboard.base.BbDeleteTrackingList
Removes a single instance of the specified element from this collection, if it is present.
remove() - Method in class blackboard.base.FilteringIterator
 
remove() - Method in class blackboard.base.NullIterator
This method does nothing.
remove(Content) - Method in interface blackboard.data.content.Aggregate
Removes the specified Content object from this Aggregate.
remove(Content) - Method in class blackboard.data.content.ContentFolder
Removes the specified Content object from the list of children.
removeAll(Collection) - Method in class blackboard.base.BbDeleteTrackingList
Removes from this list all the elements that are contained in the specified collection.
removeAttribute(String, BbSession.Scope) - Method in interface blackboard.platform.session.BbSession
Deprecated. This method has no meaning since the corresponding set/get are not implemented.
removeBbAttribute(String) - Method in class blackboard.data.BbAttributes
Removes the BbAttribute object associated with the given name ("key")
removeCodeSource(CodeSource) - Method in class blackboard.platform.security.BbPolicy
Removes the specified code source from the list of policy entries
removeContentFile(ContentFile) - Method in class blackboard.data.content.Content
Removes the specified ContentFile object from this content object.
removeContentFile(Id) - Method in class blackboard.data.content.Content
Removes the specified ContentFile object from this object.
removeContentFile(Id, Connection) - Method in class blackboard.data.content.ContentWrapper
 
removePlugIn(Id) - Method in class blackboard.platform.plugin.PlugInManager
Deletes the specified plugin.
RENDER_TYPE - Static variable in interface blackboard.data.content.ContentDef
 
ReportingPeriod - Class in blackboard.data.gradebook
The ReportingPeriod class provides a reporting period of a course.
reposition(Id, int) - Method in interface blackboard.persist.content.ContentDbPersister
Used to dictate the new position that the Content item should have using a connection from the associated persistence manager's database container.
reposition(Id, int, Connection) - Method in interface blackboard.persist.content.ContentDbPersister
Used to dictate the new position that the Content item should have using the supplied connection.
requestAuthenticate(HttpServletRequest, HttpServletResponse) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Implementation method.
requestAuthenticate(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Send the client an authentication request.
reset() - Method in class blackboard.data.BbAttributes
Clears "isSet" and "isDirty" status of this BbAttributes
resolveFile(String) - Method in interface blackboard.platform.config.ConfigurationService
Resolves the specified file.
resolveFile(String, boolean) - Method in interface blackboard.platform.config.ConfigurationService
Resolves the specified file.
RESOURCE_BUNDLE - Static variable in class blackboard.data.content.Content
Resource bundle for this data object
RESOURCE_BUNDLE - Static variable in class blackboard.data.content.StaffInfo
Resource bundle for this data object
RESOURCE_BUNDLE - Static variable in class blackboard.data.navigation.CourseToc
Resource bundle for this data object
RESOURCE_BUNDLE - Static variable in class blackboard.data.role.PortalRole
Resource bundle for this data object
ResultCode - Class in blackboard.platform
Class detailing the exit status of an (@link Application}
retainAll(Collection) - Method in class blackboard.base.BbDeleteTrackingList
Retains only the elements in this list that are not contained in the specified collection.
REVIEWABLE_COUNT - Static variable in interface blackboard.data.content.AggregateReviewStatusDef
 
REVIEWED_COUNT - Static variable in interface blackboard.data.content.AggregateReviewStatusDef
 
REVIEWED_DATE - Static variable in interface blackboard.data.content.ContentStatusDef
 
ROLE - Static variable in interface blackboard.data.course.CourseMembershipDef
 
ROLE_10 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_11 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_12 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_13 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_14 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_15 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_16 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_17 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_18 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_19 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_20 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROLE_9 - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
ROW_STATUS - Static variable in interface blackboard.data.course.ClassificationDef
 
ROW_STATUS - Static variable in interface blackboard.data.course.CourseDef
 
ROW_STATUS - Static variable in interface blackboard.data.course.CourseMembershipDef
 
ROW_STATUS - Static variable in interface blackboard.data.user.UserDef
 
ROW_STATUS - Static variable in interface blackboard.data.user.UserRoleDef
 
run() - Method in class blackboard.persist.PersistenceCacheTask
 
runCacheUpdate() - Method in class blackboard.persist.BbPersistenceManager
Performs an update for caching loaders that rely on signalling.
runDbQuery(BbQuery) - Method in class blackboard.persist.BbPersistenceManager
Convenience method for executing a query on the persistence manager's associated database using a connection obtained through this persistence manager's database context.
runDbQuery(BbQuery, Connection) - Method in class blackboard.persist.BbPersistenceManager
Convenience method for executing a query on the persistence manager's associated database using the supplied connection.
runtimeAssertIsLicensed(String) - Method in class blackboard.platform.LicenseManager
Same as assertIsLicensed(), but exceptions are wrapped in a RuntimeBbServiceException.
RuntimeBbServiceException - Exception in blackboard.platform
RuntimeBbServiceException
RuntimeBbServiceException(String) - Constructor for exception blackboard.platform.RuntimeBbServiceException
Constructor
RuntimeBbServiceException(Throwable) - Constructor for exception blackboard.platform.RuntimeBbServiceException
Constructor
RuntimeBbServiceException(String, Throwable) - Constructor for exception blackboard.platform.RuntimeBbServiceException
Constructor

S

safeGetSession(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.session.BbSessionManagerService
Returns the BbSession associated with the user making the given request.
safeLookupService(Class) - Static method in class blackboard.platform.BbServiceManager
This method is functional identical to BbServiceManager.lookupService( Class ), but throws runtime exceptions instead of checked exceptions.
save() - Method in class blackboard.portal.external.CustomData
Saves the CustomData object.
Score - Class in blackboard.data.gradebook
The Score class represents a grade in a course for a specific user and Lineitem.
Score() - Constructor for class blackboard.data.gradebook.Score
Constructs and returns a new Score object with date added and date changed initialized to the current date.
Score(Outcome) - Constructor for class blackboard.data.gradebook.Score
For internal use only.
Score.AttemptLocation - Class in blackboard.data.gradebook
Enumeration class used to indicate the physical repository for an attempt.
SCORE_DATA_TYPE - Static variable in class blackboard.data.gradebook.Score
 
ScoreDbLoader - Interface in blackboard.persist.gradebook
The ScoreDbLoader interface provides a standard set of methods used to load Scores and ScoreLists from the Blackboard 5 database schema.
ScoreDbPersister - Interface in blackboard.persist.gradebook
The ScoreDbPersister interface provides a standard set of methods used to store Score objects into the Blackboard database schema.
ScoreProviderStrings - Interface in blackboard.data.gradebook
Interface used to define the gradebook score provider strings.
searchByUserName(String) - Method in interface blackboard.persist.user.UserDbLoader
 
SECURITY_PROVIDER - Static variable in class blackboard.platform.config.BbConfig
 
SecurityDbUtil - Class in blackboard.platform.security
A utility class that encapsulates a handful database operations performed by blackboard.platform.security classes and/or classes within its sub-package.
SecurityDbUtil() - Constructor for class blackboard.platform.security.SecurityDbUtil
 
SecurityResources - Class in blackboard.platform.security
 
SecurityResources() - Constructor for class blackboard.platform.security.SecurityResources
 
SecurityUtil - Class in blackboard.platform.security
This class provides utility methods for security logic, notably around checking for entitlements.
SecurityUtil() - Constructor for class blackboard.platform.security.SecurityUtil
 
SELF_ENROLLMENT - Static variable in class blackboard.data.course.Course.Enrollment
Instructors have the ability to enroll users, and students can also enroll themselves in the course
SELF_PACED - Static variable in class blackboard.data.course.Course.Pace
Students use the course at their own speed.
sendAccessDeniedRedirect(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.security.AccessManagerService
 
sendLoginRedirect(HttpServletRequest, HttpServletResponse) - Method in interface blackboard.platform.security.AccessManagerService
 
SENIOR - Static variable in class blackboard.data.user.User.EducationLevel
College or university senior.
SENT - Static variable in class blackboard.data.content.CourseUpload.Status
 
serializeAsProperties(Properties, String) - Method in class blackboard.platform.License
Writes component out in property (name/value) format.
serializeAsXml(String) - Method in class blackboard.platform.License
Writes out this license as a String, using the specified lineSeparator
serializePermissions(Permissions) - Static method in class blackboard.platform.security.PermissionParser
Streams the specified Permissions object into an XML format.
SERVICE_LEVEL_TYPE - Static variable in interface blackboard.data.course.CourseDef
 
serviceInit(ConfigurationService) - Method in class blackboard.persist.PersistenceInitializationService
serviceInit
serviceInit(ConfigurationService) - Method in class blackboard.platform.LicenseValidationService
Deprecated.  
serviceInit(ConfigurationService) - Method in class blackboard.platform.plugin.PlugInManager
Initialization method called by framework at system startup.
serviceShutdown() - Method in class blackboard.persist.PersistenceInitializationService
serviceShutdown
serviceShutdown() - Method in class blackboard.platform.LicenseValidationService
Deprecated.  
serviceShutdown() - Method in class blackboard.platform.plugin.PlugInManager
Implementation method required for service implementations.
serviceStartup() - Method in class blackboard.persist.PersistenceInitializationService
serviceStartup
serviceStartup() - Method in class blackboard.platform.LicenseValidationService
Deprecated.  
serviceStartup() - Method in class blackboard.platform.plugin.PlugInManager
Implementation method required for service implementations.
sessionCookiePersisted(String) - Static method in class blackboard.platform.security.authentication.RDBMSAuthUtil
 
SessionStub - Class in blackboard.platform.security.authentication
This is a helper class intended to do a subset of the work done by com.blackboard.security.CISession.
SessionStub() - Constructor for class blackboard.platform.security.authentication.SessionStub
 
SessionStub(HttpServletRequest) - Constructor for class blackboard.platform.security.authentication.SessionStub
 
set(int, Object) - Method in class blackboard.base.BbDeleteTrackingList
Replaces the element at the specified position in this list with the specified element.
set(int, Object) - Method in class blackboard.base.BbList
Overrides set() in parent to enforce type safety of this list.
setAbsoluteLimit(long) - Method in class blackboard.data.course.Course
Sets the absolute storage limit for this Course.
setAction(ChildFile.Action) - Method in class blackboard.data.content.ChildFile
Sets the display action for this ChildFile.
setAction(ContentFile.Action) - Method in class blackboard.data.content.ContentFile
Sets the display action for this ContentFile.
setAlgorithmClass(String) - Method in class blackboard.persist.Cache
 
setAllowEmailEnrollRequests(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setAllowGuests(boolean) - Method in class blackboard.data.content.Content
Sets the allow guests flag for this piece of Content.
setAllowGuests(boolean) - Method in class blackboard.data.course.Course
Sets the allow guests flag for this Course.
setAllowGuests(boolean) - Method in class blackboard.data.navigation.CourseToc
Sets the allow guests flag for this CourseToc.
setAllowObservers(boolean) - Method in class blackboard.data.content.Content
Sets the allow observers flag for this piece of Content.
setAllowObservers(boolean) - Method in class blackboard.data.course.Course
Sets the allow observers flag for this Course.
setAllowObservers(boolean) - Method in class blackboard.data.navigation.CourseToc
Sets the allow observers flag for this CourseToc.
setAnalysisHandlerUrl(String) - Method in class blackboard.data.gradebook.Lineitem
 
setArea(CourseDocument.Area) - Method in class blackboard.data.content.CourseDocument
Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries
setAscending(boolean) - Method in class blackboard.base.BaseComparator
Sets this comparators ascending/descending mode.
setAsmtId(Id) - Method in class blackboard.data.announcement.Announcement
Deprecated. This field no longer exists as of Bb6 and should not be used.
setAsmtId(Id) - Method in class blackboard.data.content.CourseDocument
Deprecated. References to other objects have been generalized through the Link. Use this object to create a "link" from a course document to an assessment instead. This method does no work.
setAssessmentId(Object, Lineitem.AssessmentLocation) - Method in class blackboard.data.gradebook.Lineitem
Sets the assessment Id to be used by an external assessment handler.
setAssessmentLocation(Lineitem.AssessmentLocation) - Method in class blackboard.data.gradebook.Lineitem
Manual over-ride for assessmentLocation.
setAttemptHandlerUrl(String) - Method in class blackboard.data.gradebook.Lineitem
Sets the URL to render student attempt data, if this Lineitem is set to interact with external assessment engines.
setAttemptId(Object, Score.AttemptLocation) - Method in class blackboard.data.gradebook.Score
Sets the attempt Id to be used by an external attempt handler.
setAttemptLocation(Score.AttemptLocation) - Method in class blackboard.data.gradebook.Score
 
setAttribute(String, Object, BbSession.Scope) - Method in interface blackboard.platform.session.BbSession
Deprecated. Use HttpSession for private attributes (visible only to the calling webapp). Use setGlobalKey() for global attributes (visible across all webapps).
setBannerImageFile(BbFile) - Method in class blackboard.data.course.Course
Sets the banner image file associated with this Course.
setBatchUid(String) - Method in class blackboard.data.course.Course
Sets the batch uid associated with this Course.
setBatchUid(String) - Method in class blackboard.data.user.User
Sets the batch uid associated with this User.
setBbEnum(String, BbEnum) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided BbEnum value.
setBbObject(String, IBbObject) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided IBbObject value.
setBbObject(String) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the "unset" value.
setBiography(FormattedText) - Method in class blackboard.data.content.StaffInfo
Sets the biography of this StaffInfo.
setBirthDate(Calendar) - Method in class blackboard.data.user.User
Sets the birth date for this User.
setBody(FormattedText) - Method in class blackboard.data.announcement.Announcement
Sets the body of this Announcement.
setBody(FormattedText) - Method in class blackboard.data.content.Content
Sets the body of this object as a FormattedText object.
setBoolean(String, boolean) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided boolean value.
setBoolean(String, Boolean) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Boolean value.
setBusinessFax(String) - Method in class blackboard.data.user.UserInfo
Sets the business fax value for this UserInfo object
setBusinessPhone1(String) - Method in class blackboard.data.user.UserInfo
Sets the business phone 1 value for this UserInfo object
setBusinessPhone2(String) - Method in class blackboard.data.user.UserInfo
Sets the business phone 2 value for this UserInfo object
setButtonStyle(ButtonStyle) - Method in class blackboard.data.course.Course
Sets the ButtonStyle value for this Course.
setButtonStyleId(Id) - Method in class blackboard.data.course.Course
Sets the button style Id value for this Course.
setCalendar(String, Calendar) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Calendar value.
setCardNumber(String) - Method in class blackboard.data.user.User
Sets the String representing the encrypted BbCard number for this User.
setCartridge(Cartridge) - Method in class blackboard.data.course.Course
Sets the Cartridge value for this Course.
setCartridgeId(Id) - Method in class blackboard.data.course.Course
Sets the cartridge Id value for this Course.
setCDRomDriveMac(String) - Method in class blackboard.data.user.User
Sets the CDRomDriveMac value for this User object.
setCDRomDrivePC(String) - Method in class blackboard.data.user.User
Sets the CDRomDrivePC value for this User object.
setChildFiles(BbList) - Method in class blackboard.data.content.ContentFile
Sets the list of child files for this ContentFile.
setCity(String) - Method in class blackboard.data.user.UserInfo
Sets the city value for this UserInfo object
setClassification(Classification) - Method in class blackboard.data.course.Course
Sets Classification associated with this Course.
setClassificationId(Id) - Method in class blackboard.data.course.Course
Sets the classification Id value for this Course.
setColumnOrder(int) - Method in class blackboard.data.gradebook.Lineitem
 
setComments(String) - Method in class blackboard.data.content.CourseUpload
Method setComments.
setCompany(String) - Method in class blackboard.data.user.UserInfo
Sets the company value for this UserInfo object
setComplete() - Method in interface blackboard.data.Immutable
Marks the object implementing this interface as being immutable such that any attempt to change the state of the object (through a "set" method), results in an ImmutableException being thrown.
setConfig(HttpAuthConfig) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Sets the configuration properties for this authentication type.
setConfig(HttpAuthConfig) - Method in interface blackboard.platform.security.authentication.HttpAuthModule
Sets the HttpAuthConfig configuration object for an authentication module.
setContainer(Container) - Method in class blackboard.persist.Id
Associates the given Container with this Id.
setContainer(Container) - Method in class blackboard.persist.UnsetId
Override Id.setContainer(Container) to prevent the setting of the container value within an UnsetId.
setContentHandler(String) - Method in class blackboard.data.content.Content
Sets the content handler for this content object.
setContentId(Id) - Method in class blackboard.data.content.ContentFile
Sets the content Id value for this ContentFile.
setContentId(Id) - Method in class blackboard.data.content.ContentStatus
Method used by the framework when setting review status.
setContentId(Id) - Method in class blackboard.data.navigation.CourseToc
Sets the content Id value for this CourseToc.
setContext(HttpServletRequest) - Method in interface blackboard.platform.context.ContextManager
High-level API that must be called to ensure that proper Context data is parsed from the current HTTP request.
setContext(Id, Id, Id, Id, Id) - Method in interface blackboard.platform.context.ContextManager
 
setCountry(String) - Method in class blackboard.data.user.UserInfo
Sets the country value for this UserInfo object
setCourse(Course) - Method in class blackboard.data.gradebook.GradeRecord
Deprecated. This method should not be used as the course information is set at load.
setCourseBatchUid(String) - Method in class blackboard.data.gradebook.GradeRecord
 
setCourseId(Id) - Method in class blackboard.data.announcement.Announcement
Sets the course Id value for this Announcement.
setCourseId(Id) - Method in class blackboard.data.calendar.CalendarEntry
Sets the course Id value for this CalendarEntry.
setCourseId(Id) - Method in class blackboard.data.content.Content
Sets the course Id value for this piece of Content.
setCourseId(Id) - Method in class blackboard.data.content.StaffInfo
Sets the course id associated with this StaffInfo object.
setCourseId(String) - Method in class blackboard.data.course.Course
Sets the course Id (not pk) associated with this Course.
setCourseId(Id) - Method in class blackboard.data.course.CourseMembership
Sets the course Id value for this CourseMembership.
setCourseId(Id) - Method in class blackboard.data.course.Group
Sets the course Id value for this Group
setCourseId(Id) - Method in class blackboard.data.gradebook.GradeRecord
 
setCourseId(Id) - Method in class blackboard.data.gradebook.Lineitem
Sets the Course Id associated with this Lineitem.
setCourseId(Id) - Method in class blackboard.data.navigation.CourseToc
Sets the course Id value for this CourseToc.
setCourseMembershipId(Id) - Method in class blackboard.data.content.Upload
Sets the id of the course membership record for the user that performed this upload in the course that contains it.
setCourseMembershipId(Id) - Method in class blackboard.data.course.GroupMembership
Sets the course membership Id value for this GroupMembership.
setCourseMembershipId(Id) - Method in class blackboard.data.gradebook.Score
Sets the CourseMembership Id to be associated with this Score.
setCreatedDate(Calendar) - Method in class blackboard.data.BbObject
Deprecated.  
setCreatedDate(Calendar) - Method in interface blackboard.data.IBbObject
Deprecated.  
setCreatorUserId(Id) - Method in class blackboard.data.announcement.Announcement
Sets the creator user Id value for this Announcement.
setCreatorUserId(Id) - Method in class blackboard.data.calendar.CalendarEntry
Sets the creator user Id value for this CalendarEntry .
setDataSourceBatchUid(String) - Method in class blackboard.data.gradebook.GradeRecord
Sets the DataSourceBatchUid to be associated with this GradeRecord
setDataSourceId(Id) - Method in class blackboard.data.course.Course
Sets the data source Id value for this Course.
setDataSourceId(Id) - Method in class blackboard.data.course.CourseMembership
Sets the data source Id value for this CourseMembership.
setDataSourceId(Id) - Method in class blackboard.data.role.PortalRole
sets the datasource id value for this PortalRole
setDataSourceId(Id) - Method in class blackboard.data.user.User
Sets the data source Id value for this User.
setDataType(DataType) - Method in class blackboard.persist.Id
Associates the given DataType with this Id.
setDataType(DataType) - Method in class blackboard.persist.UnsetId
Override Id.setDataType(DataType) to prevent the setting of the data type value within an UnsetId.
setDateAdded() - Method in class blackboard.data.gradebook.Lineitem
Sets the date and time this Lineitem was added to the gradebook using the current time.
setDateAdded(Calendar) - Method in class blackboard.data.gradebook.Lineitem
Sets the date and time this Lineitem was added to the gradebook using the provided Calendar.
setDateAdded() - Method in class blackboard.data.gradebook.Score
Sets the date and time this Score was added to the gradebook using the current time.
setDateAdded(Calendar) - Method in class blackboard.data.gradebook.Score
Sets the date and time this Score was added to the gradebook using the provided Calendar.
setDateChanged() - Method in class blackboard.data.gradebook.Lineitem
Sets the date and time this Lineitem was modified using the current time.
setDateChanged(Calendar) - Method in class blackboard.data.gradebook.Lineitem
Sets the date and time this Lineitem was modified using the provided Calendar.
setDateChanged() - Method in class blackboard.data.gradebook.Score
Sets the date and time this Score was modified using the current time.
setDateChanged(Calendar) - Method in class blackboard.data.gradebook.Score
Sets the date and time this Score was modified using the provided Calendar.
setDefaultLog(Log) - Method in interface blackboard.platform.log.LogService
Sets the default Log instance to use.
setDepartment(String) - Method in class blackboard.data.user.UserInfo
Sets the department value for this UserInfo object
setDescription(String) - Method in class blackboard.data.BbLink
Sets the description associated with this BbLink.
setDescription(FormattedText) - Method in class blackboard.data.calendar.CalendarEntry
Sets the description of this CalendarEntry.
setDescription(FormattedText) - Method in class blackboard.data.content.CourseLink
Sets the description of this CourseLink.
setDescription(FormattedText) - Method in class blackboard.data.content.ExternalLink
Sets the description of this ExternalLink.
setDescription(String) - Method in class blackboard.data.course.Cartridge
Sets the description associated with this Cartridge.
setDescription(String) - Method in class blackboard.data.course.Course
Sets the description associated with this Course.
setDescription(FormattedText) - Method in class blackboard.data.course.Group
Sets the description of this Group
setDescription(String) - Method in class blackboard.data.role.PortalRole
Sets the description String value for this PortalRole.
setDomainId(Id) - Method in class blackboard.data.user.User
Deprecated. This field no longer exists as of Bb6 and should not be used.
setDouble(String, double) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided double value.
setDouble(String, Double) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Double value.
setDurationType(Course.Duration) - Method in class blackboard.data.course.Course
Sets the duration type for this Course.
setEducationLevel(User.EducationLevel) - Method in class blackboard.data.user.User
Sets the education level value for this User object Requires AttributePermission with name "user.personalinfo", actions "set".
setEmail(String) - Method in class blackboard.data.content.StaffInfo
Sets the email value for this StaffInfo object.
setEmailAddress(String) - Method in class blackboard.data.user.UserInfo
Sets the email address value for this UserInfo object
setEndDate(Calendar) - Method in class blackboard.data.calendar.CalendarEntry
Sets the end date for this CalendarEntry.
setEndDate(Calendar) - Method in class blackboard.data.content.Content
Sets the last date this object will be available to students.
setEndDate(Calendar) - Method in class blackboard.data.course.Course
Sets the end date for this Course.
setEnrollmentAccessCode(String) - Method in class blackboard.data.course.Course
Sets the enrollment access code associated with this Course.
setEnrollmentDate(Calendar) - Method in class blackboard.data.course.CourseMembership
Sets the enrollment date for this CourseMembership.
setEnrollmentEndDate(Calendar) - Method in class blackboard.data.course.Course
Sets the enrollment end date for this Course.
setEnrollmentStartDate(Calendar) - Method in class blackboard.data.course.Course
Sets the enrollment start date for this Course.
setEnrollmentType(Course.Enrollment) - Method in class blackboard.data.course.Course
Sets the enrollment type for this Course.
setError(Throwable) - Method in class blackboard.platform.ResultCode
 
setExternalAssessmentId(String) - Method in class blackboard.data.gradebook.Lineitem
Sets the assessment Id to be used by an external assessment handler.
setExternalAttemptId(String) - Method in class blackboard.data.gradebook.Score
Sets the attempt Id to be used by an external attempt handler.
setFamilyName(String) - Method in class blackboard.data.content.StaffInfo
Sets the family name (last name) value for this StaffInfo object.
setFamilyName(String) - Method in class blackboard.data.user.UserInfo
Sets the family name (last name) value for this UserInfo object
setFavoriteLinks(BbList) - Method in class blackboard.data.course.CourseMembership
Sets the list of favorite links for this CourseMembership.
setFee(float) - Method in class blackboard.data.course.Course
Sets the fee (cost) for this Course.
setFile(UploadedFile) - Method in class blackboard.data.content.Upload
Sets the uploaded file record of the file referred to by this upload.
setFileAction(UploadedFile.Action) - Method in class blackboard.data.content.UploadedFile
Method setFileAction.
setFileName(String) - Method in class blackboard.data.content.UploadedFile
Method setFileName.
setFileSize(long) - Method in class blackboard.data.content.UploadedFile
Method setFileSize.
setFloat(String, float) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided float value.
setFloat(String, Float) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Float value.
setFormattedText(String, FormattedText) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided FormattedText value.
setGender(User.Gender) - Method in class blackboard.data.user.User
Sets the gender value for this User object.
setGivenName(String) - Method in class blackboard.data.content.StaffInfo
Sets the given name (first name) value for this StaffInfo object.
setGivenName(String) - Method in class blackboard.data.user.UserInfo
Sets the given name (first name) value for this UserInfo object
setGlobalKey(String, String) - Method in interface blackboard.platform.session.BbSession
Sets a key for global use.
setGlobalKeys(HttpServletRequest) - Method in class blackboard.platform.security.authentication.BaseAuthenticationModule
Set whatever key-value pairs need to be stored for the current session.
setGrade(String) - Method in class blackboard.data.gradebook.GradeRecord
Deprecated. This method no longer actually sets a grade as the score is immutable for the purposes of the GradeRecord.
setGrade(String) - Method in class blackboard.data.gradebook.Score
Sets the actual grade for this Score.
setGradebookName(String) - Method in class blackboard.data.gradebook.GradeRecord
Deprecated. This method no longer actually sets the title of the gradebook item as it is immutable for the purposes of the GradeRecord.
setGroupId(Id) - Method in class blackboard.data.content.GroupUpload
Sets the id of the group that contains this group upload.
setGroupId(Id) - Method in class blackboard.data.course.GroupMembership
Sets the group Id value for this GroupMembership.
setHasCartridgeAccess(boolean) - Method in class blackboard.data.course.CourseMembership
Sets the has cartridge flag for this CourseMembership.
setHasDescriptionPage(boolean) - Method in class blackboard.data.course.Course
Sets the has description page flag for this Course.
setHomeFax(String) - Method in class blackboard.data.user.UserInfo
Sets the home fax value for this UserInfo object
setHomePageUrl(String) - Method in class blackboard.data.content.StaffInfo
Sets the home page URL value for this StaffInfo object.
setHomePhone1(String) - Method in class blackboard.data.user.UserInfo
Sets the home phone 1 value for this UserInfo object
setHomePhone2(String) - Method in class blackboard.data.user.UserInfo
Sets the home phone 2 value for this UserInfo object
setId(String, Id) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Id value.
setId(Id) - Method in class blackboard.data.BbObject
Sets the Id value for this BbObject.
setId(Id) - Method in interface blackboard.data.IBbObject
Sets the Id value for this IBbObject.
setIdentifier(String) - Method in class blackboard.data.course.Cartridge
Sets the identifier associated with this Cartridge.
setImageFile(BbFile) - Method in class blackboard.data.content.StaffInfo
This method is for INTERNAL USE ONLY.
setImageFile(BbFile) - Method in class blackboard.data.course.CourseMembership
Sets the image value for this CourseMembership object.
setInstitutionId(Id) - Method in class blackboard.data.course.Course
Deprecated.  
setInstitutionName(String) - Method in class blackboard.data.course.Course
Sets the institution name associated with this Course.
setInstitutionRole(User.InstRole) - Method in class blackboard.data.user.User
Deprecated. Use setPortalRoleId(Id portalRoleId) instead
setInteger(String, int) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided int value.
setInteger(String, Integer) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Integer value.
setInternalAssessmentId(Id) - Method in class blackboard.data.gradebook.Lineitem
Sets the assessment Id to be used by an internal assessment handler.
setInternalAttemptId(Id) - Method in class blackboard.data.gradebook.Score
Sets the attempt Id to be used by an internal attempt handler.
setInternalHandle(String) - Method in class blackboard.data.navigation.CourseToc
Sets the internal handle associated with this CourseToc.
setIntroduction(String) - Method in class blackboard.data.course.CourseMembership
Sets the introduction associated with this CourseMembership.
setIsAvailable(boolean) - Method in interface blackboard.data.Available
Sets whether this item is available.
setIsAvailable(boolean) - Method in class blackboard.data.content.Content
Sets whether this piece of Content is available.
setIsAvailable(boolean) - Method in class blackboard.data.content.Link
Sets the availability flag for this Link.
setIsAvailable(boolean) - Method in class blackboard.data.content.StaffInfo
Sets the value of the availability attribute
setIsAvailable(boolean) - Method in class blackboard.data.course.Course
Sets the availability flag for this Course.
setIsAvailable(boolean) - Method in class blackboard.data.course.CourseMembership
Sets the availability flag for this CourseMembership.
setIsAvailable(boolean) - Method in class blackboard.data.course.Group
Sets whether this Group is available.
setIsAvailable(boolean) - Method in class blackboard.data.gradebook.Lineitem
Sets a flag describing whether students can see the item in their views of the gradebook.
setIsAvailable(boolean) - Method in class blackboard.data.user.User
Sets the availability flag for this User.
setIsChatRoomAvailable(boolean) - Method in class blackboard.data.course.Group
Sets whether the chat room should be enabled for this Group.
setIsDescribed(boolean) - Method in class blackboard.data.content.Content
Sets whether this Content contains meta-data.
setIsDirty(boolean) - Method in class blackboard.data.BbAttribute
Sets "dirty" (changed) status of BbAttribute
setIsDirty(boolean) - Method in class blackboard.data.BbAttributes
Sets "dirty" (changed) status of this BbAttributes
setIsDirtyCascading(boolean) - Method in class blackboard.data.BbAttributes
Sets "dirty" (changed) status of this BbAttributes
setIsDiscussionBoardAvailable(boolean) - Method in class blackboard.data.course.Group
Sets whether the discussion board should be enabled for this Group .
setIsEmailAvailable(boolean) - Method in class blackboard.data.course.Group
Sets whether email should be enabled for this Group.
setIsEnabled(boolean) - Method in class blackboard.data.navigation.CourseToc
Sets whether this CourseToc should be enabled.
setIsEntryPoint(boolean) - Method in class blackboard.data.navigation.CourseToc
Sets whether this CourseToc is an entry point.
setIsFolder(boolean) - Method in class blackboard.data.content.Content
Sets whether this piece of Content should be treated as a folder of content, or as an actual content piece itself.
setIsFolder(boolean) - Method in class blackboard.data.content.StaffInfo
Sets whether this StaffInfo should be treated as a folder of staff information objects, or as an actual staff information object.
setIsFromCartridge(boolean) - Method in class blackboard.data.content.Content
Sets whether this piece of TrackedContent came from a course cartridge.
setIsGuest(boolean) - Method in class blackboard.data.role.PortalRole
sets the isGuest value for this PortalRole
setIsInfoPublic(boolean) - Method in class blackboard.data.user.User
Sets the is info public flag for this User.
setIsLesson(boolean) - Method in class blackboard.data.content.Content
Sets whether the underlying content represents a lesson.
setIsLocaleEnforced(boolean) - Method in class blackboard.data.course.Course
Sets the enforced locale flag for this Course.
setIsLockedOut(boolean) - Method in class blackboard.data.course.Course
Sets the locked out flag for this Course.
setIsNavCollapsible(boolean) - Method in class blackboard.data.course.Course
Sets the "is navigation collapsible" flag for this Course.
setIsPermanent(boolean) - Method in class blackboard.data.announcement.Announcement
Sets whether this Announcement should always be displayed, regardless of the date it was posted.
setIsReadOnly(boolean) - Method in class blackboard.data.BbAttribute
Sets the value of the isReadOnly flag.
setIsRemovable(boolean) - Method in class blackboard.data.role.PortalRole
sets the isRemovable value for this PortalRole
setIsReviewable(boolean) - Method in class blackboard.data.content.Content
Sets whether this piece of Content should be set for review.
setIsSelfSelectable(boolean) - Method in class blackboard.data.role.PortalRole
sets the isSelfSelectable value for this PortalRole
setIsSequential(boolean) - Method in class blackboard.data.content.Content
Sets whether the object is a Lesson that requires its contents to be displayed in a sequential fashion.
setIsSet(boolean) - Method in class blackboard.data.BbAttribute
Sets the "has been set" status of this BbAttribute.
setIsSetCascading(boolean) - Method in class blackboard.data.BbAttributes
Sets "isSet"status of this BbAttributes
setIsTracked(boolean) - Method in class blackboard.data.content.Content
Sets whether this piece of TrackedContent should be set for access tracking.
setIsTransferAreaAvailable(boolean) - Method in class blackboard.data.course.Group
Sets whether the transfer area should be enabled for this Group.
setJobTitle(String) - Method in class blackboard.data.user.UserInfo
Sets the job title value for this UserInfo object
setLabel(String) - Method in class blackboard.data.navigation.CourseToc
Sets the label associated with this CourseToc.
setLabel(String) - Method in class blackboard.data.role.PortalRole
Sets the name String value for this PortalRole.
setLastLoginDate(Calendar) - Method in class blackboard.data.user.User
Sets the last login date for this User.
setLaunchInNewWindow(boolean) - Method in class blackboard.data.content.Content
Sets whether a link for this object should be launched in a new window.
setLaunchInNewWindow(boolean) - Method in class blackboard.data.navigation.CourseToc
Sets whether this CourseToc should be launched in a new window (when selected within the user interface).
setLineitemId(Id) - Method in class blackboard.data.gradebook.Score
Sets the Lineitem Id this Score is related to.
setLinkName(String) - Method in class blackboard.data.content.ChildFile
Sets the text of the link displayed for this object.
setLinkName(String) - Method in class blackboard.data.content.ContentFile
Sets the text of the link displayed for this object.
setLinkName(String) - Method in class blackboard.data.content.UploadedFile
Method setLinkName.
setLocale(String) - Method in class blackboard.data.course.Course
Sets the locale value for this Course object.
setLocale(String) - Method in class blackboard.data.user.User
Sets the locale value for this User object.
setLong(String, long) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided long value.
setLong(String, Long) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Long value.
setMessage(String) - Method in class blackboard.platform.ResultCode
 
setMiddleName(String) - Method in class blackboard.data.user.UserInfo
Sets the middle namevalue for this UserInfo object
setMobilePhone(String) - Method in class blackboard.data.user.UserInfo
Sets the mobile phone value for this UserInfo object
setModifiedDate(Calendar) - Method in class blackboard.data.announcement.Announcement
Deprecated.  
setModifiedDate(Calendar) - Method in class blackboard.data.BbObject
Sets the last modified date for this BbObject.
setModifiedDate(Calendar) - Method in interface blackboard.data.IBbObject
Sets the last modified date for this IBbObject.
setName(String) - Method in class blackboard.data.BbLink
Sets the name value for this BbLink object.
setName(String) - Method in class blackboard.data.content.ChildFile
Sets the file name of this object
setName(String) - Method in class blackboard.data.content.ContentFile
Sets the file name of this object
setName(String) - Method in class blackboard.data.gradebook.Lineitem
Sets the name of the Lineitem.
setNavColorBg(String) - Method in class blackboard.data.course.Course
Sets the background color that should be used for rendering the navigation links that appear on the left hand side of the course page.
setNavColorFg(String) - Method in class blackboard.data.course.Course
Sets the foreground color (color of text) that should be used for rendering the navigation links that appear on the left hand side of the course page.
setNavStyle(Course.NavStyle) - Method in class blackboard.data.course.Course
Sets the navigation style for this Course.
setNotes(String) - Method in class blackboard.data.course.CourseMembership
Sets the notes associated with this CourseMembership.
setNumDaysOfUse(int) - Method in class blackboard.data.course.Course
Sets the number of days of use for this Course.
setObject(String, Object) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided Object value.
setObject(String) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the "unset" value.
setObjectValue(String, Object) - Method in class blackboard.portal.external.CustomData
Sets a new Object property associated with the given key.
setOfficeAddress(String) - Method in class blackboard.data.content.StaffInfo
Sets the office address value for this StaffInfo object.
setOfficeHours(String) - Method in class blackboard.data.content.StaffInfo
Sets the office hours value for this StaffInfo object.
setOfflineName(String) - Method in class blackboard.data.content.Content
Sets the offline name associated with this Content.
setOfflinePath(String) - Method in class blackboard.data.content.Content
Sets the offline path associated with this Content.
setPaceType(Course.Pace) - Method in class blackboard.data.course.Course
Sets the pace type for this Course.
setParentId(Id) - Method in class blackboard.data.content.ChildFile
Sets the parent id of this object.
setParentId(Id) - Method in class blackboard.data.content.Content
Sets the parent Id value for this piece of Content.
setParentId(Id) - Method in class blackboard.data.content.StaffInfo
Sets the parent id to the specified id.
setParentId(Id) - Method in class blackboard.data.content.UploadedFile
Method setParentId.
setPassword(String) - Method in class blackboard.data.user.User
Sets the password value for this User object.
setPersonalInfo(String) - Method in class blackboard.data.course.CourseMembership
Sets the personal information associated with this CourseMembership .
setPhone(String) - Method in class blackboard.data.content.StaffInfo
Sets the phone value for this StaffInfo object
setPointsPossible(float) - Method in class blackboard.data.gradebook.Lineitem
Sets the maximum points possible for this Lineitem.
setPortalRole(PortalRole) - Method in class blackboard.data.user.User
Sets the PortalRole object, representing the primary institution role associated with this User.
setPortalRoleId(Id) - Method in class blackboard.data.user.User
Sets the primary institution role Id value for this User.
setPortalRoleId(Id) - Method in class blackboard.data.user.UserRole
Sets the portal role Id value for this UserRole.
setPosition(int) - Method in class blackboard.data.content.Content
Sets the position of this piece of Content within its parent content item (folder).
setPosition(int) - Method in class blackboard.data.content.StaffInfo
Sets the position of this object in the parent folder.
setPosition(int) - Method in class blackboard.data.navigation.CourseToc
Sets the position of this CourseToc.
setPosition(int) - Method in interface blackboard.data.Positionable
Sets the position of this item within its current context.
setPublisherName(String) - Method in class blackboard.data.course.Cartridge
Sets the publisher name associated with this Cartridge.
setRecycled(boolean) - Method in class blackboard.data.content.UploadedFile
Method setRecycled.
setReferredToId(Id) - Method in class blackboard.data.content.Link
Sets the internal Blackboard id of the destination ("referred to") object of this Link.
setReferredToType(Link.ReferredToType) - Method in class blackboard.data.content.Link
Sets the referrer type for this Link.
setReferrerId(Id) - Method in class blackboard.data.content.Link
Sets the Internal blackboard id of the source (referrer) object of this Link.
setReferrerType(Link.ReferrerType) - Method in class blackboard.data.content.Link
Sets the referrer type for this Link.
setRegistry(Registry) - Method in class blackboard.data.content.ContentFile
Sets the Registry associated with this ContentFile.
setRegistry(Registry) - Method in class blackboard.data.course.Course
Sets the Registry associated with this Course.
setRegistry(Registry) - Method in class blackboard.data.user.User
Sets the Registry associated with this User.
setRenderType(Content.RenderType) - Method in class blackboard.data.content.Content
Sets the RenderType for this piece of content.
setReportingPeriod(ReportingPeriod) - Method in class blackboard.data.gradebook.GradeRecord
Sets the period of the gradebook ReportingPeriod this GradeRecord is related to
setRequestInstance(HttpServletRequest, MultipartRequest) - Static method in class blackboard.platform.filesystem.MultipartRequest
Associates a MultipartRequest object with the given request.
setRequireAccountToEnroll(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setRestrictionEndDate(Calendar) - Method in class blackboard.data.announcement.Announcement
Sets the date up until which this Announcement should be made available for viewing within the user interface.
setRestrictionEndDate(Calendar) - Method in class blackboard.data.content.CourseDocument
Sets the date up until which this CourseDocument should be made available for viewing within the user interface.
setRestrictionStartDate(Calendar) - Method in class blackboard.data.announcement.Announcement
Sets the date after which this Announcement should be made available for viewing within the user interface.
setRestrictionStartDate(Calendar) - Method in class blackboard.data.content.CourseDocument
Sets the date after which this CourseDocument should be made available for viewing within the user interface.
setReviewedDate(Calendar) - Method in class blackboard.data.content.ContentStatus
Method used by framework when setting review date.
setRole(CourseMembership.Role) - Method in class blackboard.data.course.CourseMembership
Sets the role for this CourseMembership.
setRoleID(String) - Method in class blackboard.data.role.PortalRole
Sets the role Id String value for this PortalRole.
setRoleName(String) - Method in class blackboard.data.role.PortalRole
Sets the name String value for this PortalRole.
setScores(BbList) - Method in class blackboard.data.gradebook.Lineitem
Associates the input Score objects to this LineItem object.
setServiceLevelType(Course.ServiceLevel) - Method in class blackboard.data.course.Course
Sets the service level type for this Course.
setSettings(String) - Method in class blackboard.data.user.User
Sets the settings value for this User object.
setShowAddContactInfo(boolean) - Method in class blackboard.data.user.User
Sets the show additional contact infor flag for this User.
setShowAddressInfo(boolean) - Method in class blackboard.data.user.User
Sets the show address info flag for this User.
setShowEmailInfo(boolean) - Method in class blackboard.data.user.User
Sets the show email flag for this User.
setShowEmailInSR(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setShowFirstNameInSR(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setShowInCatalog(boolean) - Method in class blackboard.data.course.Course
Sets the show in catalog flag for this Course.
setShowLastNameInSR(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setShowPhone1InSR(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setShowStudentIdInSR(boolean) - Method in class blackboard.data.course.Course
Deprecated.  
setShowWorkInfo(boolean) - Method in class blackboard.data.user.User
Sets the availability flag for this User.
setSirTitle(String) - Method in class blackboard.data.content.StaffInfo
Sets the sirtitle value for this StaffInfo object.
setSize(long) - Method in class blackboard.data.content.ChildFile
Records the size of the file wrapped by this object.
setSize(long) - Method in class blackboard.data.content.ContentFile
Records the size of the file wrapped by this object.
setSoftLimit(long) - Method in class blackboard.data.course.Course
Sets the soft storage limit for this Course.
setStartDate(Calendar) - Method in class blackboard.data.calendar.CalendarEntry
Sets the start date for this CalendarEntry.
setStartDate(Calendar) - Method in class blackboard.data.content.Content
Sets the first date that this content object will be available to students.
setStartDate(Calendar) - Method in class blackboard.data.course.Course
Sets the start date for this Course.
setState(String) - Method in class blackboard.data.user.UserInfo
Sets the state value for this UserInfo object
setStatus(CourseUpload.Status) - Method in class blackboard.data.content.CourseUpload
Method setStatus.
setStorageType(ContentFile.StorageType) - Method in class blackboard.data.content.ContentFile
Sets the display storageType for this ContentFile.
setStreet1(String) - Method in class blackboard.data.user.UserInfo
Sets the street1 value for this UserInfo object
setStreet2(String) - Method in class blackboard.data.user.UserInfo
Sets the street2 value for this UserInfo object
setString(String, String) - Method in class blackboard.data.BbAttributes
Sets the value of the attribute with the given name ("key") to the provided String value.
setStudentId(String) - Method in class blackboard.data.user.User
Sets the student id value for this User object.
setSystemRole(User.SystemRole) - Method in class blackboard.data.user.User
Sets the system role (the administrative user role in the gui) for this User.
setTargetAudienceId(Id) - Method in class blackboard.data.course.Course
Deprecated.  
setTargetType(CourseToc.Target) - Method in class blackboard.data.navigation.CourseToc
Sets the target type for this CourseToc.
SETTINGS - Static variable in interface blackboard.data.user.UserDef
 
setTitle(String) - Method in class blackboard.data.announcement.Announcement
Sets the title associated with this Announcement.
setTitle(String) - Method in class blackboard.data.calendar.CalendarEntry
Sets the title associated with this CalendarEntry.
setTitle(String) - Method in class blackboard.data.content.Content
Sets the title associated with this piece of Content.
setTitle(String) - Method in class blackboard.data.content.Link
Sets the title associated with this Link.
setTitle(String) - Method in class blackboard.data.content.StaffInfo
Sets the title for this object.
setTitle(String) - Method in class blackboard.data.course.Cartridge
Sets the title associated with this Cartridge.
setTitle(String) - Method in class blackboard.data.course.Course
Sets the title associated with this Course.
setTitle(String) - Method in class blackboard.data.course.Group
Sets the title associated with this Group
setTitle(String) - Method in class blackboard.data.user.UserInfo
Sets the user title value for this UserInfo object
setTitleColor(String) - Method in class blackboard.data.content.Content
Sets the title color associated with this piece of Content.
setTitleColor(String) - Method in class blackboard.data.content.StaffInfo
Sets the color to render this object's title
setType(Announcement.Type) - Method in class blackboard.data.announcement.Announcement
Sets the type value associated with this Announcement.
setType(CalendarEntry.Type) - Method in class blackboard.data.calendar.CalendarEntry
Sets the type value associated with this CalendarEntry.
setType(CourseDocument.Type) - Method in class blackboard.data.content.CourseDocument
Deprecated. This attribute is no longer used in Blackboard 6. This method will be a no-op.
setType(String) - Method in class blackboard.data.gradebook.Lineitem
Sets the type of the Lineitem.
setUploadDate(Calendar) - Method in class blackboard.data.content.Upload
Sets the date and time when the file referred to by this object was uploaded.
setUploadLimit(long) - Method in class blackboard.data.course.Course
Sets the upload storage limit for this Course.
setUrl(String) - Method in class blackboard.data.BbLink
Sets the URL associated with this BbLink.
setUrl(String) - Method in class blackboard.data.content.Content
Sets the URL associated with this ExternalLink.
setUrl(URL) - Method in class blackboard.data.content.ExternalLink
Sets the URL associated with this ExternalLink.
setUrl(String) - Method in class blackboard.data.navigation.CourseToc
Sets the URL associated with this CourseToc.
setUser(User) - Method in class blackboard.data.course.CourseMembership
Sets the User associated with this CourseMembership.
setUser(User) - Method in class blackboard.data.gradebook.GradeRecord
Deprecated. This method should not be used as the user information is set at load.
setUser(User) - Method in class blackboard.data.user.UserRole
Sets the User object of this UserRole object
setUserBatchUid(String) - Method in class blackboard.data.gradebook.GradeRecord
 
setUserId(Id) - Method in class blackboard.data.announcement.Announcement
Deprecated. Has been replaced by the more aptly named Announcement.setCreatorUserId(Id).
setUserId(Id) - Method in class blackboard.data.calendar.CalendarEntry
Deprecated. has been replaced by CalendarEntry.setCreatorUserId(Id).
setUserId(Id) - Method in class blackboard.data.content.ContentStatus
Method used by the framework when setting review status.
setUserId(Id) - Method in class blackboard.data.course.CourseMembership
Sets the user Id value for this CourseMembership.
setUserId(Id) - Method in class blackboard.data.user.UserRole
Sets the user Id value for this UserRole.
setUserName(String) - Method in class blackboard.data.user.User
Sets the username value for this User object.
setValue() - Method in class blackboard.data.BbAttribute
Sets the value of this BbAttribute to "unset".
setValue(Object) - Method in class blackboard.data.BbAttribute
Sets value object with type Object.
setValue(String, Object, BbAttribute.Type) - Method in class blackboard.data.BbAttributes
Internal convenience method to make the type-specific "set" routines much simpler (i.e., shorter).
setValue(String, String) - Method in class blackboard.portal.external.CustomData
Sets a new String property associated with the given key.
setVerbosityLevel(LogService.Verbosity) - Method in interface blackboard.platform.log.Log
Sets the verbosity level for this log.
setWebPage(String) - Method in class blackboard.data.user.UserInfo
Sets the web page value for this UserInfo object
setWeight(float) - Method in class blackboard.data.gradebook.Lineitem
Sets the weight (as a percentage) for this Lineitem.
setZipCode(String) - Method in class blackboard.data.user.UserInfo
Sets the zip code value for this UserInfo object
SHAPE - Static variable in interface blackboard.data.course.ButtonStyleDef
 
SharableArrayList - Class in blackboard.base
This class will eventually be a copy of array list to provide for ultra shallow cloning and copy-on-modify.
SharableArrayList() - Constructor for class blackboard.base.SharableArrayList
 
SHOW_ADD_CONTACT_INFO - Static variable in interface blackboard.data.user.UserDef
 
SHOW_ADDRESS_INFO - Static variable in interface blackboard.data.user.UserDef
 
SHOW_EMAIL_INFO - Static variable in interface blackboard.data.user.UserDef
 
SHOW_IN_CATALOG - Static variable in interface blackboard.data.course.CourseDef
 
SHOW_WORK_INFO - Static variable in interface blackboard.data.user.UserDef
 
shutdown() - Static method in class blackboard.platform.BbServiceManager
Initiates a graceful shutdown of all services.
SIR_TITLE - Static variable in interface blackboard.data.content.StaffInfoDef
 
SIZE - Static variable in interface blackboard.data.content.ChildFileDef
 
SIZE - Static variable in interface blackboard.data.content.ContentFileDef
 
SMART_TEXT - Static variable in class blackboard.base.FormattedText.Type
Treat text as "literal HTML", but with additional behaviors; at render-time, single newline characters will be translated to <BR> and double newline characters will be translated to <P>.
SMTPSERVER_CONNECTIONTYPE - Static variable in class blackboard.platform.config.BbConfig
 
SMTPSERVER_HOSTNAME - Static variable in class blackboard.platform.config.BbConfig
 
SOFT_LIMIT - Static variable in interface blackboard.data.course.CourseDef
 
SOPHOMORE - Static variable in class blackboard.data.user.User.EducationLevel
College or university sophomore.
SQLSERVER_DB_TYPE - Static variable in class blackboard.base.AppVersion
 
STAFF - Static variable in class blackboard.data.user.User.InstRole
Deprecated.  
STAFF_INFO - Static variable in class blackboard.data.content.Link.ReferredToType
 
STAFF_INFO - Static variable in class blackboard.data.navigation.CourseToc.Target
Toc is a pointer to a staff information folder defined within the course
STAFF_INFO_DATA_TYPE - Static variable in class blackboard.data.content.StaffInfo
Deprecated. Use the constant StaffInfo.DATA_TYPE instead
STAFF_INFO_FOLDER_DATA_TYPE - Static variable in class blackboard.data.content.StaffInfoFolder
Deprecated. Use the constant StaffInfoFolder.DATA_TYPE instead
StaffInfo - Class in blackboard.data.content
The StaffInfo class is a representation of a staff information element within the Blackboard application.
StaffInfo() - Constructor for class blackboard.data.content.StaffInfo
Creates an instance of StaffInfo with default property values.
StaffInfoDbLoader - Interface in blackboard.persist.content
This interface describes the set of methods that all database loaders for StaffInfo objects must implement.
StaffInfoDbLoader.Default - Class in blackboard.persist.content
A utility class that provides quick access to the StaffInfoDbLoader instance associated with the default instance of the database BbPersistenceManager.
StaffInfoDbLoader.Default() - Constructor for class blackboard.persist.content.StaffInfoDbLoader.Default
 
StaffInfoDbPersister - Interface in blackboard.persist.content
StaffInfo database persister interface.
StaffInfoDbPersister.Default - Class in blackboard.persist.content
A utility class that provides quick access to the StaffInfoDbLoader instance associated with the default instance of the database BbPersistenceManager.
StaffInfoDbPersister.Default() - Constructor for class blackboard.persist.content.StaffInfoDbPersister.Default
 
StaffInfoDef - Interface in blackboard.data.content
StaffInfoDef
StaffInfoFolder - Class in blackboard.data.content
The StaffInfoFolder class is a representation of a staff information folder within the Blackboard application.
StaffInfoFolder() - Constructor for class blackboard.data.content.StaffInfoFolder
Default constructor.
START_DATE - Static variable in interface blackboard.data.content.ContentDef
 
START_DATE - Static variable in interface blackboard.data.course.CourseDef
 
STATE - Static variable in interface blackboard.data.user.UserInfoDef
 
STATUS - Static variable in interface blackboard.data.content.ContentDef
 
STATUS - Static variable in interface blackboard.data.content.CourseUploadDef
 
STATUS - Static variable in interface blackboard.platform.plugin.PlugInDef
 
StatusCode - Class in blackboard.platform
Class detailing the current status of an Application
StatusCode(int, String) - Constructor for class blackboard.platform.StatusCode
 
STORAGE_TYPE - Static variable in interface blackboard.data.content.ContentFileDef
 
STORE_ADMIN - Static variable in class blackboard.data.user.User.SystemRole
Manages the front-end portal-ecommerce functionality related to purchases
STR_MANIFEST_FILE - Static variable in interface blackboard.platform.plugin.