blackboard.platform.filesystem.manager
Class BrandingFileManager

java.lang.Object
  blackboard.platform.filesystem.AbstractFileManager
      blackboard.platform.filesystem.manager.BrandingFileManager

All Implemented Interfaces:

FileManager

public class BrandingFileManager
extends blackboard.platform.filesystem.AbstractFileManager

A service that retrieves the appropiate File object representing the path to a content file for a course in the Blackboard application.

Since:

Bb 9.0

Field Summary

Fields inherited from interface blackboard.platform.filesystem.FileManager

WEB_DELIMITER

Constructor Summary

BrandingFileManager()

Method Summary

java.io.File	getColorPaletteDirectory(java.lang.String ext_ref, boolean isDefault)
java.io.File	getColorPalettesDirectory(boolean isDefault) Returns the root directory for branding color palette storage
java.io.File	getRootDirectory(Id portalBrandingId) Returns the root directory relative to the branding for given host.
java.io.File	getThemeDirectory(java.lang.String ext_ref, boolean isDefault)
java.io.File	getThemesDirectory(boolean isDefault) Returns the root directory for branding theme storage
java.lang.String	getWebRootDirectory(Id portalBrandingId) Returns the web based root directory relative to the branding for given host.

Methods inherited from class blackboard.platform.filesystem.AbstractFileManager

buildMessage, getCourseFileManager, getCourseObject, getUnprotectedRootDirectory, getUnprotectedWebRootDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

BrandingFileManager

public BrandingFileManager()

Method Detail

getWebRootDirectory

public java.lang.String getWebRootDirectory(Id portalBrandingId)
                                     throws blackboard.platform.filesystem.FileSystemException

Returns the web based root directory relative to the branding for given host.

Specified by:

getWebRootDirectory in interface FileManager

Overrides:

getWebRootDirectory in class blackboard.platform.filesystem.AbstractFileManager

Parameters:

portalBrandingId - The ID of the entity desired

Throws:

blackboard.platform.filesystem.FileSystemException

getRootDirectory

public java.io.File getRootDirectory(Id portalBrandingId)
                              throws blackboard.platform.filesystem.FileSystemException

Returns the root directory relative to the branding for given host.

Specified by:

getRootDirectory in interface FileManager

Overrides:

getRootDirectory in class blackboard.platform.filesystem.AbstractFileManager

Parameters:

portalBrandingId - The ID of the entity desired

Throws:

blackboard.platform.filesystem.FileSystemException

getThemeDirectory

public java.io.File getThemeDirectory(java.lang.String ext_ref,
                                      boolean isDefault)
                               throws blackboard.platform.filesystem.FileSystemException

Throws:

blackboard.platform.filesystem.FileSystemException

getColorPaletteDirectory

public java.io.File getColorPaletteDirectory(java.lang.String ext_ref,
                                             boolean isDefault)
                                      throws blackboard.platform.filesystem.FileSystemException

Throws:

blackboard.platform.filesystem.FileSystemException

getColorPalettesDirectory

public java.io.File getColorPalettesDirectory(boolean isDefault)
                                       throws blackboard.platform.filesystem.FileSystemException

Returns the root directory for branding color palette storage

Parameters:

isDefault - true for default system palettes, false for user palettes

Throws:

blackboard.platform.filesystem.FileSystemException

getThemesDirectory

public java.io.File getThemesDirectory(boolean isDefault)
                                throws blackboard.platform.filesystem.FileSystemException

Returns the root directory for branding theme storage

Parameters:

isDefault - true for default system themes, false for user themes

Throws:

blackboard.platform.filesystem.FileSystemException