blackboard.platform.filesystem
Class GradebookFileManager

java.lang.Object
  blackboard.platform.filesystem.GradebookFileManager

public class GradebookFileManager
extends java.lang.Object

A service that returns File objects representing the path to content files for Blackboard's gradebook web application.

Since:

Blackboard 6.0

Version:

1.0

Constructor Summary

GradebookFileManager()

Method Summary

static java.io.File	getGradebookDirectory(java.lang.String courseId) Returns the directory that stores content for a gradebook for a given Course in the system.
static java.io.File	getGradebookDirectory(java.lang.String courseId, Id attemptId) Returns the directory that stores all content for a given Attempt in a given Course.
static java.io.File	getGradebookInstructorDirectory(java.lang.String courseId, Id attemptId, java.lang.String fileGuid) Returns the directory that stores a comment file for a given Attempt in a given Course.
static java.io.File	getGradebookStudentDirectory(java.lang.String courseId, Id attemptId, java.lang.String fileGuid) Returns the directory that stores a comment file for a given Attempt in a given Course.
java.lang.String	getWebContentDirectory(Course crs) Returns the web based directory where content and course document items are stored.
java.lang.String	getWebContentDirectory(Course crs, Id contentId) Returns the web based directory where content and course document items are stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GradebookFileManager

public GradebookFileManager()

Method Detail

getWebContentDirectory

public java.lang.String getWebContentDirectory(Course crs)
                                        throws FileSystemException

Returns the web based directory where content and course document items are stored.

Parameters:

user-defined - string course id (name)

course - Course

Throws:

FileSystemException

getWebContentDirectory

public java.lang.String getWebContentDirectory(Course crs,
                                               Id contentId)
                                        throws FileSystemException

Returns the web based directory where content and course document items are stored.

Parameters:

user-defined - string course id (name)

course - Course

content - Id for the content item in the course

Throws:

FileSystemException

getGradebookDirectory

public static java.io.File getGradebookDirectory(java.lang.String courseId)
                                          throws FileSystemException

Returns the directory that stores content for a gradebook for a given Course in the system. This method does not verify that the given Course exists in the system.

Parameters:

courseId - The requested course's courseId

Returns:

A fully-qualified filesystem path.

Throws:

FileSystemException

getGradebookDirectory

public static java.io.File getGradebookDirectory(java.lang.String courseId,
                                                 Id attemptId)
                                          throws FileSystemException

Returns the directory that stores all content for a given Attempt in a given Course. This method does not verify that the given Course exists in the system.

Parameters:

courseId - The Id for the Course

attemptId - The Id for the given Attempt.

Returns:

A fully-qualified filesystem path.

Throws:

FileSystemException

getGradebookInstructorDirectory

public static java.io.File getGradebookInstructorDirectory(java.lang.String courseId,
                                                           Id attemptId,
                                                           java.lang.String fileGuid)
                                                    throws FileSystemException

Returns the directory that stores a comment file for a given Attempt in a given Course. This comment file is meant to be available only to the instructor.

Parameters:

courseId - The Id for the Course

attemptId - The Id for the given Attempt.

fileGuid - A generated unique identifier for this file.

Returns:

A fully-qualified filesystem path.

Throws:

FileSystemException

getGradebookStudentDirectory

public static java.io.File getGradebookStudentDirectory(java.lang.String courseId,
                                                        Id attemptId,
                                                        java.lang.String fileGuid)
                                                 throws FileSystemException

Returns the directory that stores a comment file for a given Attempt in a given Course. This comment file is meant to be available to both the student and the instructor.

Parameters:

courseId - The Id for the Course

attemptId - The Id for the given Attempt.

fileGuid - A generated unique identifier for this file.

Returns:

A fully-qualified filesystem path.

Throws:

FileSystemException