|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
Aggregate.
ContentFolder can accept any type of content except ContentFileRef
objects ( "resource/x-bb-file" ).
Lesson may aggregate objects of the specified
type.
add() in parent to enforce type safety of this list.
add() in parent to enforce type safety of this list.
setType methods instead
Content (must be of type
StaffInfo) to the list of children for this Folder.
Content (must be of type
StaffInfo) to the list of children for his Folder
at the provided position value.
ChildFile to the current list of child files
defined for this ContentFile.
Content (must not be of type
ContentFile) to the list of children for this Folder.
Content (must notbe of type
ContentFile) to the list of children for this Folder
at the provided position value.
Content to this Folder
at the end of the list of content items.
Content to this Folder
at the specified position within the list of content items.
ContentFile as an attachment to this object.
ApplicationLauncher
to provide non-relative locations for client manipulated configuration properties.
Aggregate extends the notion of Folder by adding methods
that allow more explicit visibility and control over the rules of aggregation.AggregateReviewStatus object wraps the state of a user's interaction with a given piece
of content and adaptive release status.AggregateReviewStatusobjects,
which encapsulate a learner's adaptive release status, and review status for
associated Contentobjects.Announcement class is a representation of an announcement
within the Blackboard application.Announcement with default property
values.
Announcement.DATA_TYPE instead
Announcement objects must implement.AnnouncementDbLoader
instance associated with the default instance of the database BbPersistenceManager.Announcement objects must implement.AnnouncementDbPersister
instance associated with the default instance of the database BbPersistenceManager.BbLink to the current list of favorite links
currently defined for this CourseMembership.
AppVersion class provides a means of describing (indicating)
the properties of an object to be loaded/persisted by the persistence framework.AppVersion instance with the specified attributes.
hasValidKey(), except that a checked exception is thrown if the key is not valid.
isLicensed(), except that exceptions are thrown if the license
check fails.
Id is "set" -- has a value.
Container value associated with this Id
matches the provided Container value.
DataType value associated with this Id
matches the provided DataType value.
Available interface specifies a set of methods for
determining the availability of an object.targetAvailability value
BbAttribute class is used to form the basis of the name/value
pairs used for IBbObject based object properties.BbAttribute) of an object (BbObject).BbAttributeException with the given message.
BbAttributes class is used to store a set of BbAttribute
objects.BbList that maintains a tracking set of elements that have been
removed through one mechanism or another.BbList designated to only accept objects that are instances of the
object represented by the provided Class value for addition to the list.
BbLink with the given name, URL, and description.
BbList designated to only accept objects that are
instances of the object represented by the provided Class value
for addition to the list.
FilteringIterator that can be retrieved from
any BbList object using BbList.getFilteringIterator()
or BbList.getFilteringIterator(ListFilter).BbObject class is the root of the data class hierarchy.BbPersistenceManager class is the central provider of both
loader and persister implementation instances in the persistence framework.Cache provides the base model for caching for any object
loader defined within the persistence framework.CacheEntry represents an item stored in the cache.CacheKey represents a reference to an item stored in the cache.CachingLoader interface provides the base model for any database object
loader defined within the persistence framework that wishes to use cacheing.CalendarEntry.DATA_TYPE instead
CalendarEntry class provides a means for defining an event
(system, course, or personal) within the Blackboard application.CalendarEntry with default property
values.
CalendarEntry objects must implement.CalendarEntryDbLoader
instance associated with the default instance of the database BbPersistenceManager.CalendarEntry objects must implement.CalendarEntryDbPersister
instance associated with the default instance of the database BbPersistenceManager.Cartridge class provides a representation of a cartridge
record (as related to a course) within the Blackboard application.Cartridge with default property values.
Cartridge objects must implement.CartridgeDbLoader
instance associated with the default instance of the database BbPersistenceManager.Cartridge objects must implement.CartridgeDbPersister
instance associated with the default instance of the database BbPersistenceManager.SecurityManager.
ChildFile class wraps an uploaded file that is the child of
a ContentFile.assessmentId and sets assessmentLocation to UNSET.
Comparable interface.
Comparable interface.
Comparable interface.
Comparable interface.
Container interface provides the basic framework for defining
a "data source" against which the persistence framework can operate.Content class is the root of the content class hierarchy.CourseDocument.Area.COURSE_INFORMATION
CourseDocument.Area.COURSE_DOCUMENTS
CourseDocument.Area.COURSE_ASSIGNMENTS
CourseDocument.Area.COURSE_BOOKS
Content objects must implement.ContentDbLoader
instance associated with the default instance of the database BbPersistenceManager.Content objects must implement.ContentDbPersister
instance associated with the default instance of the database BbPersistenceManager.ContentFile class wraps a reference to a file that has been
uploaded to a content area in a course.BbFile
argument.
Action attribute
of a file.StorageType attribute
of a file.ContentFile objects must implement.ContentFileDbLoader
instance associated with the default instance of the database BbPersistenceManager.Content objects must implement.ContentDbPersister
instance associated with the default instance of the database BbPersistenceManager.ContentFileRef represents a file reference that can be displayed
within a Lesson.ContentFolder class is a representation of a folder within
the Bb Course Management System.Content are over-ridden, including ContentHandler and
IsFolder.
ContentHandlerLoader
instance associated with the default instance of the database BbPersistenceManager.ContentStatus object wraps the state of a user's interaction with a given piece
of content and adaptive release status.ContentStatusobjects,
which encapsulate a learner's adaptive release status, and review status for
associated Contentobjects.ContentStatus objects must implement.ContentStatus objects must implement.Context used by service APIs for information
about the current user, virtual installation, etc.Course class provides a representation of a course (course
or organization) within the Blackboard application.Course with default property values.
Course.DATA_TYPE instead
CourseDocument.DATA_TYPE instead
CourseMembership.DATA_TYPE instead
Course objects must implement.CourseDbLoader
instance associated with the default instance of the database BbPersistenceManager.Course objects must implement.CourseDbPersister
instance associated with the default instance of the database BbPersistenceManager.CourseDocument class is a representation of a course document
within the Bb Course Management System.CourseToc objects are used, which point
to different top level foldersContent.RenderTypeCourseLink class is a representation of an intra-course link
within the Bb Course Management System.CourseMembership class is a representation of a course
membership record within the Blackboard application.CourseMembership with default property
values.
CourseMembership objects must implement.CourseMembershipDbLoader
instance associated with the default instance of the database BbPersistenceManager.CourseMembership objects must implement.CourseMembershipDbPersister
instance associated with the default instance of the database BbPersistenceManager.CourseQuota class provides convenience methods and accessor methods
that encapsulate common routines that are needed when using Course quotas.CourseToc class provides a representation of the left hand
navigation items displayed when inside a course in the Bb CMS.Course with default property values.
CourseToc objects must implement.CourseTocDbLoader
instance associated with the default instance of the database BbPersistenceManager.CourseUpload class wraps a reference to a file that has
been uploaded to the digital drop box in a course.CourseUpload objects must implement.CourseUpload objects must implement.ListFilter interface
capable of filtering a list of Course objects based upon course
"availability".
ListFilter interface
capable of filtering a list of Announcement objects based upon
their course Id value.
ListFilter interface
capable of filtering a list of CalendarEntry objects based upon
their course Id value.
ListFilter interface
capable of filtering a list of Course objects based upon the
course duration availability.
ListFilter interface
capable of filtering a list of Course objects based upon the
role of a user within those courses.
ListFilter interface
capable of filtering a list of Course objects based upon the
role of a user within those courses.
ListFilter interface
capable of filtering a list of Course objects based upon course
service level (as returned by Course.getServiceLevelType()).
ListFilter interface
capable of filtering a list of CalendarEntry objects based upon
their CalendarEntry.Type value.
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.DatabaseContainer class implements the Container
interface for a database.DatabaseContainer object with the
given BbDatabase used to define the specifics of the data
source.
DataType class provides a means of encapsulating the type
of data objects as defined within the persistence framework.DataType.DataType(Class) instead.
DataType object with the given class value as the
unique data type identifier.
CONTINUOUS
TEXT
INSTRUCTOR_LED
UNKNOWN
USER
UserRoles associated with the given user Id value
using a connection from the associated persistence manager's database
container.
UserRoles identified by the given user value
using the supplied connection.
Announcement identified by the given Id
value using a connection from the associated persistence manager's
database container.
Announcement identified by the given Id
value using the supplied connection.
CalendarEntry identified by the given Id
value using a connection from the associated persistence manager's
database container.
CalendarEntry identified by the given Id
value using the supplied connection.
Content identified by the given Id
value using a connection from the associated persistence manager's
database container.
Content identified by the given Id
value using the supplied connection.
Content identified by the given Id
value using a connection from the associated persistence manager's
database container.
Content identified by the given Id
value using the supplied connection.
Link identified by the given Id value
using a connection from the associated persistence manager's database
container.
Link identified by the given Id value
using the supplied connection.
StaffInfo identified by the given Id
value using a connection from the associated persistence manager's database
container.
StaffInfo identified by the given Id
value using the supplied connection.
Cartridge identified by the given Id
value using a connection from the associated persistence manager's database
container.
Cartridge identified by the given Id
value using the supplied connection.
Course identified by the given Id
value using a connection from the associated persistence manager's database
container.
Course identified by the given Id
value using the supplied connection.
CourseMembership identified by the given Id
value using a connection from the associated persistence manager's
database container.
CourseMembership identified by the given Id
value using the supplied connection.
Group identified by the given Id
value using a connection from the associated persistence manager's database
container.
Group identified by the given Id
value using the supplied connection.
GroupMembership identified by the given Id
value using a connection from the associated persistence manager's
database container.
GroupMembership identified by the given Id
value using the supplied connection.
Score identified by the given Id
value using a connection from the associated persistence manager's database
container.
Score identified by the given Id
value using the supplied connection.
PortalRole identified by the given Id value
using a connection from the associated persistence manager's database
container.
PortalRole identified by the given Id value
using the supplied connection.
User identified by the given Id value
using a connection from the associated persistence manager's database
container.
User identified by the given Id value
using the supplied connection.
UserRole identified by the given Id value
using a connection from the associated persistence manager's database
container.
UserRole identified by the given Id value
using the supplied connection.
authenticate.
equals() method in
Object to provide a simple way to compare two FormattedText
objects.
equals() method in
Object to provide a simple way to compare two Ids.
equals() method in
Object to provide a simple way to compare two PkIds.
equals() method in
Object to provide a simple way to compare two UnsetId
s.
assessmentId points to an assessment on an external system.
ExternalLink.DATA_TYPE instead
ExternalLink class is a representation of an external link
within the Bb Course Management System.AvailabilityFilter, to this
FilteringIterator.
FilterCacheByLoader filters out given objects that are cacheKey with specified Loader.FilteringIterator class provides a means of applying a set
of "filters" to an iterator.FilteringIterator using the supplied Iterator.
FilteringIterator using the supplied Iterator and
applying the "filtering" specified by the given ListFilter.
Folder is the root of the content folder class hierarchy.FormattedText class provides a means for storing a piece of
text along with a companion formatting specification.FormattedText.Type.SMART.
externalString
in the target enumeration class, enumClass.
externalString.
externalString.
BbAttribute.Type element specified by the
externalString.
externalString.
externalString
.
externalString.
externalString
.
externalString
.
externalString
.
externalString
.
externalString
.
externalString
.
externalString.
externalString.
externalString.
externalString
.
externalString.
externalString.
externalString.
externalString.
externalString
.
externalString.
externalString.
externalString.
externalString.
fieldName
in the target enumeration class, enumClass.
fieldName
in the target enumeration class, enumClass.
fieldName.
fieldName.
fieldName.
fieldName.
fieldName.
fieldName.
fieldName.
Id instance specific to the Container
associated with this persistence manager.
Id instance specific to the Container
associated with this persistence manager.
Id instance specific to the Container
associated with this persistence manager.
Id instance specific to this Container.
Id instance specific to this Container.
Id instance specific to this Container.
Id instance specific to this DatabaseContainer.
Id instance specific to this DatabaseContainer
.
Id instance specific to this DatabaseContainer
.
Id instance using the default database persistence
manager as given by context.
Id instance using the default database persistence
manager as given by context.
Id instance using the default database persistence
manager as given by context.
Id instance specific to this XmlContainer
.
Id instance specific to this XmlContainer
.
Id instance specific to this DatabaseContainer
.
Course.
ChildFile.
ContentFile.
List of all active session in this VM.
Content.
Course.
CourseToc.
Content.
Course.
CourseToc.
AppVersion.
AppVersion associated with this Container
.
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.
Id.
false.
Id has the same Container
as this Id instance.
Id has the same DataType
as this Id instance.
IBbObject class is an interface representing the root of the data class
hierarchy.Id identifying it with the given container and data
type values.
Id identifying it with the given data type value.
Immutable interface defines a means for specifying an object
that can be made immutable.Immutable interface is made after the object is marked as being complete.ImmutableException with the given message.
assessmentId points to an assessment within Blackboard.
PortalRole.
PortalRole.
PortalRole.
Id has been set (is not in defalt state).
PkId has been set.
UnsetId has been set.
Id is a "valid"
Id for this BbPersistenceManager's Container
.
Id is a "valid" id for this
Container.
Id is a "valid" id for this
DatabaseContainer.
Id is a "valid" id for this
XmlContainer.
KeyNotFoundException with the given message.
KeyNotFoundException with the given message and
provided nested exception.
Lesson class represents a list of content that is meant to be
viewed in a linear, guided order.Lesson objects.
LicenseManager object with the specified parameters and license components.
Lineitem class represents a single gradable item in a course.Lineitem using the specified OutcomeDefinition.
assessmentId is located.LineitemDbLoader interface provides a standard set of methods used to load
Lineitems and LineitemLists from the Blackboard 5
database schema.LineitemDbPersister interface provides a standard set of methods used to store
Lineitem objects into the Blackboard database schema.Link class is a representation of a link within the Blackboard
application.Link with default property values.
Link objects must implement.LinkDbLoader
instance associated with the default instance of the database BbPersistenceManager.Link objects must implement.LinkDbPersister
instance associated with the default instance of the database BbPersistenceManager.License objects read from the license file.
BbObject derived value that matches the current id value.
load method in the base class to implement a "load
by id" operation for a database id (and thus for a database container).
ContentHandler object given an Element tree whose structure and contents match those generated by
ContentHandlerXmlPerister.
ContentHandler object given an InputStream
which contains XML whose structure and contents match those generated by
ContentHandlerXmlPerister.
Course.ServiceLevel
value in a light-weight fashion using a connection obtained through this
object's database context.
Course.ServiceLevel
value in a light-weight fashion using the supplied connection.
ContentFolder (identified by Id) from the database
in a lightweight fashion using a connection obtained through this object's
database context.
ContentFolder (identified by Id) from the database
in a lightweight fashion using the supplied connection.
ContentFolder (identified by Id) in the specified
fashion (lightweight or heavyweight) using the supplied connection.
Content (identifed by Id) from the database in a lightweight
fashion using a connection obtained through this object's database context.
Content (identifed by Id) from the database in a lightweight
fashion using the supplied connection.
Content (identifed by Id) from the database in the specified
fashion (lightweight or heavyweight) using the supplied connection.
ContentStatus objects for a specific Content
object.
ContentStatus objects for a specific Content
object.
AggregateReviewStatus objects for all users for the give Course Id
AggregateReviewStatus objects for all users for the give Course Id
ContentStatus objects for a specific Course
object.
ContentStatus objects for a specific Course
object.
CourseId (identified by Id) from the database
using the supplied connection.
CourseId (identifed by Id) from the database
using the supplied connection.
File (identified by FileId) and courseMembershipIdfrom the database
using the supplied connection.
Id from the database using the supplied connection.
CourseToc (identified by Id) in a lightweight
fashion using a connection obtained through this object's database context.
CourseToc (identified by Id) in a lightweight
fashion using the supplied connection.
CourseToc (identified by Id) in a lightweight
fashion using the supplied connection.
Calendar.Type
using a connection obtained through this object's database context.
Calendar.Type
using the supplied connection.
Loader interface provides the base model for any object
loader defined within the persistence framework.InputStream (identifed by in).
BbList of ContentHandler objects from the
Element tree provided.
BbList of ContentHandler objects from the
InputStream provided.
License associated with the specified component key.
Id of "Top" StaffInfoFolder for the given course
(identified by id) from the database using a connection obtained through
this object's database context.
Id of "Top" StaffInfoFolder for the given course
(identified by id) from the database using the supplied connection.
Id in the specified container space.
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.
Content identified by the given contentId
value using the supplied connection as status "Reviewed" by the user identified by userId.
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.
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.
Content identified by the given contentId
value using the supplied connection as status "Not Reviewed" by the user identified by userId.
Content identified by the given contentId
value using the supplied connection as status "Not Reviewed" by the user identified by userId.
Container matches the Container
of this Id.
DataType matches the DataType
of this Id.
null.
targetAvailability value
Iterator interface.ConstraintViolationException with the given message.
Organization class provides a representation of an organization
(or community) within the Blackboard system.Organization with default property values.
passesFilter method of the ListFilter class.
BbObject in a lightweight
fashion.
Announcement using a
connection from the associated persistence manager's database container.
Announcement using the
supplied connection.
CalendarEntry using a connection
from the associated persistence manager's database container.
CalendarEntry using the
supplied connection.
Content using a
connection from the associated persistence manager's database container.
Content using the
supplied connection.
Content using a
connection from the associated persistence manager's database container.
Content using the
supplied connection.
CourseUpload using the
supplied connection.
GroupUpload using the
supplied connection.
Link using a connection from
the associated persistence manager's database container.
Link using the supplied connection.
StaffInfo using a connection
from the associated persistence manager's database container.
StaffInfo using the supplied
connection.
Cartridge using a connection
from the associated persistence manager's database container.
Cartridge using the supplied
connection.
Course in a lightweight fashion
using a connection from the associated persistence manager's database
container.
Course in a lightweight fashion
using the supplied connection.
CourseMembership using a
connection from the associated persistence manager's database container.
CourseMembership using the
supplied connection.
Group using a connection from
the associated persistence manager's database container.
Group using the supplied
connection.
GroupMembership using a
connection from the associated persistence manager's database container.
GroupMembership using the
supplied connection.
Score using a connection
from the associated persistence manager's database container.
Score using the supplied
connection.
ScoreList, Score
by Score, using a connection from the associated persistence
manager's database container.
ScoreList, Score
by Score, using the supplied connection.
PortalRole using a connection from
the associated persistence manager's database container.
PortalRole using the supplied
connection.
User using a connection from
the associated persistence manager's database container.
User using the supplied
connection.
UserRole using a connection from
the associated persistence manager's database container.
UserRole using the supplied
connection.
Element tree whose values and structure matches the
contents of the provided ContentHandler object.
PersistenceCacheTask represents a Task used to coordinate cached information.PersistenceContext interface describes an object capable of
storing and tracking object Id changes as those objects move
between containers within the persistence framework.PersistenceException with the given message.
PersistenceException with the given message and
provided nested exception.
Persister interface provides the base model for any object
persister defined within the persistence framework.Element whose children are the provided ContentStatus objects persisted to XML.
Element whose children are the provided ContentHandler objects persisted to XML.
PkId class provides the means of describing an Id
within a Blackboard database container.PkId with the given Container,
DataType, and pk key values as integers.
PkId with the given Container,
DataType, and pk key values as strings.
PkId with the given Container,
DataType, and pk key values as a single string.
PlugInException with the given message.
PlugInException with the given message and
provided nested exception.
PlugInManager is responsible for maintaining plugin
definitions for the system.PlugInUtil class is a utility class for
plug-ins for the Blackboard application.PortalRole class is a representation of an institution role
within the Blackboard application.PortalRole with default property
values.
PortalRole objects must implement.PortalRoleDbLoader
instance associated with the default instance of the database BbPersistenceManager.PortalRoleDbPersister
instance associated with the default instance of the database BbPersistenceManager.Positionable interface specifies a set of methods for
setting/determining the position of an object within a list of objects.Id mapping with the context.
RemoteDbContainer class implements the Container
interface for remote access of specific persistence operations.XmlContainer object with the given
AppVersion as the default AppVersion for future
framework calls on this container.
Content object from this Aggregate.
BbAttribute object associated with the given name ("key")
ContentFile object from this content
object.
ContentFile object from this object.
ReportingPeriod class provides a reporting period of a course.Content item
should have using a connection from the associated persistence manager's
database container.
Content item
should have using the supplied connection.
BbAttributes
assertIsLicensed(), but exceptions are wrapped in a RuntimeBbServiceException.
BbServiceManager.lookupService( Class ), but throws runtime exceptions instead of
checked exceptions.
Score class represents a grade in a course for a specific user and Lineitem.ScoreDbLoader interface provides a standard set of methods used to load
Scores and ScoreLists from the Blackboard 5 database
schema.ScoreDbPersister interface provides a standard set of methods
used to store Score objects into the
Blackboard database schema.lineSeparator
Permissions object into an XML format.
set() in parent to enforce type safety of this list.
Course.
ChildFile.
ContentFile.
Content.
Course.
CourseToc.
Content.
Course.
CourseToc.
Link. Use this object to create a "link" from a course
document to an assessment instead. This method does no work.
assessmentLocation.
Lineitem is set to interact with external
assessment engines.
Course.
Course.
User.
BbEnum value.
IBbObject value.
StaffInfo.
User.
Announcement.
FormattedText object.
boolean value.
Boolean value.
UserInfo object
UserInfo object
UserInfo object
ButtonStyle value for this Course.
Id value for this Course.
Calendar value.
String representing the encrypted BbCard number for this User.
Cartridge value for this Course.
Id value for this Course.
User object.
User object.
ContentFile.
UserInfo object
Classification associated with this Course.
Id value for this Course.
UserInfo object
ImmutableException being thrown.
HttpAuthConfig configuration object for an authentication module.
Container with this Id.
Id.setContainer(Container) to prevent the setting of the
container value within an UnsetId.
Id value for this ContentFile.
Id value for this CourseToc.
Context data is
parsed from the current HTTP request.
UserInfo object
Id value for this Announcement.
Id value for this CalendarEntry.
Id value for this piece of Content.
StaffInfo object.
Course.
Id value for this CourseMembership.
Id value for this Group
Id value for this CourseToc.
Id value for this GroupMembership.
Id value for this Announcement.
Id value for this CalendarEntry
.
Id value for this Course.
Id value for this CourseMembership.
PortalRole
Id value for this User.
DataType with this Id.
Id.setDataType(DataType) to prevent the setting of the
data type value within an UnsetId.
Log instance to use.
UserInfo object
BbLink.
CalendarEntry.
CourseLink.
ExternalLink.
Cartridge.
Course.
Group
String value for this PortalRole.
double value.
Double value.
Course.
User object
Requires AttributePermission with name "user.personalinfo", actions "set".
StaffInfo object.
UserInfo object
CalendarEntry.
Course.
Course.
CourseMembership.
Course.
Course.
Course.
StaffInfo object.
UserInfo object
CourseMembership.
Course.
float value.
Float value.
FormattedText value.
User object.
StaffInfo object.
UserInfo object
Id value for this GroupMembership.
CourseMembership.
Course.
UserInfo object
StaffInfo object.
UserInfo object
UserInfo object
Id value.
Id value for this BbObject.
Id value for this IBbObject.
Cartridge.
CourseMembership object.
Course.
int value.
Integer value.
CourseToc.
CourseMembership.
Content is available.
Link.
Course.
CourseMembership.
Group is available.
User.
Group.
Content contains meta-data.
BbAttribute
BbAttributes
BbAttributes
Group
.
Group.
CourseToc should be enabled.
CourseToc is an entry point.
Content should be treated as a
folder of content, or as an actual content piece itself.
StaffInfo should be treated as a folder of
staff information objects, or as an actual staff information object.
TrackedContent came from a course
cartridge.
PortalRole
User.
Course.
Course.
Course.
Announcement should always be displayed,
regardless of the date it was posted.
isReadOnly flag.
PortalRole
Content should be set for
review.
PortalRole
Lesson that requires its contents
to be displayed in a sequential fashion.
BbAttribute.
BbAttributes
TrackedContent should be set for
access tracking.
Group.
UserInfo object
CourseToc.
String value for this PortalRole.
User.
CourseToc should be launched in a new window
(when selected within the user interface).
Course object.
User object.
long value.
Long value.
UserInfo object
UserInfo object
BbObject.
IBbObject.
BbLink object.
Course.
CourseMembership.
Course.
Object value.
StaffInfo object.
StaffInfo object.
Content.
Content.
Course.
Id value for this piece of Content.
User object.
CourseMembership
.
StaffInfo object
Lineitem.
PortalRole object, representing the primary institution role associated with this User.
Id value for this User.
Id value for this UserRole.
Content within its parent
content item (folder).
CourseToc.
Cartridge.
id of the destination ("referred
to") object of this Link.
Link.
id of the source (referrer) object
of this Link.
Link.
Registry associated with this ContentFile.
Registry associated with this Course.
Registry associated with this User.
RenderType for this piece of content.
Announcement should be made
available for viewing within the user interface.
CourseDocument should be made
available for viewing within the user interface.
Announcement should be made
available for viewing within the user interface.
CourseDocument should be made
available for viewing within the user interface.
CourseMembership.
String value for this PortalRole.
String value for this PortalRole.
Score objects to this LineItem object.
Course.
User object.
User.
User.
User.
Course.
User.
StaffInfo object.
Course.
CalendarEntry.
Course.
UserInfo object
ContentFile.
UserInfo object
UserInfo object
String value.
User object.
User.
CourseToc.
Announcement.
CalendarEntry.
Content.
Link.
Cartridge.
Course.
Group
UserInfo object
Content.
Announcement.
CalendarEntry.
Course.
BbLink.
ExternalLink.
ExternalLink.
CourseToc.
User associated with this CourseMembership.
User object of this UserRole object
Announcement.setCreatorUserId(Id).
CalendarEntry.setCreatorUserId(Id).
Id value for this CourseMembership.
Id value for this UserRole.
User object.
BbAttribute to "unset".
Object.
UserInfo object
Lineitem.
UserInfo object
<BR> and double newline characters will be
translated to <P>.
StaffInfo.DATA_TYPE instead
StaffInfoFolder.DATA_TYPE instead
StaffInfo class is a representation of a staff information
element within the Blackboard application.StaffInfo with default property values.
StaffInfo objects must implement.StaffInfoDbLoader
instance associated with the default instance of the database BbPersistenceManager.StaffInfoDbLoader
instance associated with the default instance of the database BbPersistenceManager.StaffInfoFolder class is a representation of a staff
information folder within the Blackboard application.ApplicationUpload.getFileId() to be
the same as the id currently returned by a call to Upload.getFile().
DataType that should be used for creating an appropriate
Id value for this "referred to" type value.
DataType that should be used for creating an appropriate
Id value for this "referrer" type value.
BbObject.getDataType()).
BbObject.getDataType()).
Id into its String representation.
PkId into its String representation.
UnsetId into its String representation.
AppVersion into its String representation.
BbFile object as a single line
separated list of name value pairs of this object's properties.
BbAttribute value to a string representation.
BbLink object as a single line
separated list of name value pairs of this object's properties.
BbObject object as a line-feed
separated list of name value pairs of this object's properties.
Lineitem object as a line-feed
separated list of name value pairs of this object's properties.
Lineitem object as a line-feed separated list of
name value pairs of this object's properties.
getMessage()
DataType object.
Id into its String representation.
PkId into its String representation.
UnsetId into its String representation.
assessmentId is undetermined.
UnsetId class represents an unset data object Id.Action
attribute of a file.ExternalLink)
User class is a representation of a user within the Bb
Course Management System.User with default property values.
User.DATA_TYPE instead
Userobjects must implement.UserDbLoader
instance associated with the default instance of the database BbPersistenceManager.User objects must implement.UserDbPersister
instance associated with the default instance of the database BbPersistenceManager.UserInfo class provides basic user oriented information for
extending objects.UserInfo wiht default property
values.
UserRole class provides user secondary institution role information for
extending objects.UserRole with default property
values.
UserRole objects must implement.UserRoleDbLoader
instance associated with the default instance of the database BbPersistenceManager.UserRole objects must implement.UserRoleDbPersister
instance associated with the default instance of the database BbPersistenceManager.Announcement.
BbObject.
CalendarEntry.
Content.
Course.
BbObject.
LineItem.
Score.
IBbObject.
CourseToc.
ValidationException with the given message.
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||