blackboard.platform.filesystem.manager
Class GradebookFileManager

java.lang.Object
  extended by blackboard.platform.filesystem.AbstractFileManager
      extended by blackboard.platform.filesystem.manager.GradebookFileManager
All Implemented Interfaces:
FileManager

public class GradebookFileManager
extends blackboard.platform.filesystem.AbstractFileManager


Field Summary
 
Fields inherited from interface blackboard.platform.filesystem.FileManager
WEB_DELIMITER
 
Constructor Summary
GradebookFileManager()
           
 
Method Summary
 java.io.File getAttemptDirectory(Course crs, Id attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the root directory relative to the course.
 java.io.File getAttemptDirectory(Id courseId, Id attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the root directory relative to the course.
 java.io.File getAttemptDirectory(Id courseId, Id attemptId, blackboard.platform.gradebook2.AttemptFileType fileType)
          Returns the root directory relative to the course and attempt id.
 java.io.File getAttemptDirectory(java.lang.String courseId, Id attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the root directory relative to the course.
 java.io.File getCacheDirectory(Id courseId)
          The cache directory is the location used to store temporary cache data used to display the grade center.
 java.io.File getGradebookDirectory(Id courseId)
          Returns the directory that stores content for a gradebook for a given Course in the system.
 java.io.File getGradebookDirectory(Id courseId, Id attemptId)
          Returns the directory that stores all content for a given Attempt in a given Course.
 java.io.File getGradebookInstructorDirectory(Id courseId, Id attemptId, java.lang.String fileGuid)
          Returns the directory that stores a comment file for a given Attempt in a given Course.
 java.io.File getGradebookStudentDirectory(Id 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 getWebAttemptDirectory(Id courseId, Id attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the web based root directory relative to the course and attempt id.
 java.lang.String getWebAttemptDirectory(Id courseId, Id attemptId, blackboard.platform.gradebook2.AttemptFileType fileType)
          Returns the web based root directory relative to the course and attempt id.
 java.lang.String getWebAttemptDirectory(Id crsId, java.lang.String attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the web based root directory relative to the course and attempt id.
 java.lang.String getWebAttemptDirectory(java.lang.String courseId, java.lang.String attemptId, blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
          Returns the web based root directory relative to the course and attempt id.
 java.lang.String getWebContentDirectory(Id crsId)
          Returns the web based directory where content and course document items are stored.
 java.lang.String getWebContentDirectory(Id crsId, Id contentId)
          Returns the web based directory where content and course document items are stored.
 
Methods inherited from class blackboard.platform.filesystem.AbstractFileManager
buildMessage, getCourseFileManager, getCourseObject, getRootDirectory, getUnprotectedRootDirectory, getUnprotectedWebRootDirectory, getWebRootDirectory
 
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(Id crsId)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based directory where content and course document items are stored.

Parameters:
crsId - string course id (name)
Throws:
blackboard.platform.filesystem.FileSystemException

getWebContentDirectory

public java.lang.String getWebContentDirectory(Id crsId,
                                               Id contentId)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based directory where content and course document items are stored.

Parameters:
crsId - user-defined string course id (name)
contentId - Id for the content item in the course
Throws:
blackboard.platform.filesystem.FileSystemException

getGradebookDirectory

public java.io.File getGradebookDirectory(Id courseId)
                                   throws blackboard.platform.filesystem.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:
blackboard.platform.filesystem.FileSystemException

getGradebookDirectory

public java.io.File getGradebookDirectory(Id courseId,
                                          Id attemptId)
                                   throws blackboard.platform.filesystem.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:
blackboard.platform.filesystem.FileSystemException

getGradebookInstructorDirectory

public java.io.File getGradebookInstructorDirectory(Id courseId,
                                                    Id attemptId,
                                                    java.lang.String fileGuid)
                                             throws blackboard.platform.filesystem.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:
blackboard.platform.filesystem.FileSystemException

getGradebookStudentDirectory

public java.io.File getGradebookStudentDirectory(Id courseId,
                                                 Id attemptId,
                                                 java.lang.String fileGuid)
                                          throws blackboard.platform.filesystem.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:
blackboard.platform.filesystem.FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(Id courseId,
                                               Id attemptId,
                                               blackboard.platform.gradebook2.AttemptFileType fileType)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based root directory relative to the course and attempt id.

Parameters:
courseId - Id
attemptId - Id
Throws:
blackboard.platform.filesystem.FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(Id courseId,
                                               Id attemptId,
                                               blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based root directory relative to the course and attempt id.

Parameters:
courseId - CourseId external string
attemptId - Id Id
Throws:
blackboard.platform.filesystem.FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(Id crsId,
                                               java.lang.String attemptId,
                                               blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based root directory relative to the course and attempt id.

Parameters:
crsId - CourseId string
attemptId - Can be either Attempt external string, or for GroupAttempt ids, a string in the format "grp" + groupAttemptId.toExternalString()
Throws:
blackboard.platform.filesystem.FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(java.lang.String courseId,
                                               java.lang.String attemptId,
                                               blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                        throws blackboard.platform.filesystem.FileSystemException
Returns the web based root directory relative to the course and attempt id.

Parameters:
courseId - CourseId string
attemptId - Can be either Attempt external string, or for GroupAttempt ids, a string in the format "grp" + groupAttemptId.toExternalString()
Throws:
blackboard.platform.filesystem.FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(Id courseId,
                                        Id attemptId,
                                        blackboard.platform.gradebook2.AttemptFileType fileType)
                                 throws blackboard.platform.filesystem.FileSystemException
Returns the root directory relative to the course and attempt id.

Parameters:
courseId - Id Id
attemptId - Id Id
Throws:
blackboard.platform.filesystem.FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(Id courseId,
                                        Id attemptId,
                                        blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                 throws blackboard.platform.filesystem.FileSystemException
Returns the root directory relative to the course.

Parameters:
courseId - String Course id
attemptId - Id Id
Throws:
blackboard.platform.filesystem.FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(Course crs,
                                        Id attemptId,
                                        blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                 throws blackboard.platform.filesystem.FileSystemException
Returns the root directory relative to the course.

Parameters:
crs - String Course id
attemptId - Id Id
Throws:
blackboard.platform.filesystem.FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(java.lang.String courseId,
                                        Id attemptId,
                                        blackboard.data.gradebook.impl.AttemptFile.FileType fileType)
                                 throws blackboard.platform.filesystem.FileSystemException
Returns the root directory relative to the course.

Parameters:
courseId - String Course id
attemptId - Id Id
Throws:
blackboard.platform.filesystem.FileSystemException

getCacheDirectory

public java.io.File getCacheDirectory(Id courseId)
The cache directory is the location used to store temporary cache data used to display the grade center. This area is not copied when a course is copied. If a cache directory does not exist, one is created.

Returns:
cache directory


Copyright © 2012 Blackboard, Inc. All Rights Reserved.