ARLO Nester
Classes | Functions
workspace.tools.views.library Namespace Reference

Classes

class  LaunchLibraryValidationForm
 
class  StartNewLibraryForm
 Djangeo form for creating a new Library. More...
 

Functions

def getUserLibraries (user)
 Return a list of a user's Libraries. More...
 
def getLibraryMediaFiles (library)
 Get a list of media files in a Library. More...
 
def createLibrary (user, name, notes)
 Create a new Library owned by 'user'. More...
 
def userLibraries (request)
 Display all Libraries owned or accessible by a user (/tools/userLibraries). More...
 
def startNewLibrary (request)
 Start a new Library. More...
 
def libraryFiles (request, libraryId)
 Display all Files in a Library. More...
 
def launchLibraryValidation (request)
 Launch a LibraryMediaFileValidation Task. More...
 

Function Documentation

def workspace.tools.views.library.createLibrary (   user,
  name,
  notes 
)

Create a new Library owned by 'user'.

Parameters
userUser object that owns the Library.
nameThe name of the new Library.
notesNotes stored along with the Library.
Returns
The new Library object if successful, None if a conflicting Library name exists.
def workspace.tools.views.library.getLibraryMediaFiles (   library)

Get a list of media files in a Library.

Parameters
libraryA Library object
Returns
A list of MediaFile objects (As a Django QuerySet)
def workspace.tools.views.library.getUserLibraries (   user)

Return a list of a user's Libraries.

Parameters
userA User Object
Returns
A list of Library Objects (As a Django QuerySet)
def workspace.tools.views.library.launchLibraryValidation (   request)

Launch a LibraryMediaFileValidation Task.

Parameters
requestThe Django HTTP request object
Returns
Django HTTP response object, redirect to the Job that was launched.
def workspace.tools.views.library.libraryFiles (   request,
  libraryId 
)

Display all Files in a Library.

Parameters
requestThe Django HTTP request object
libraryIdThe database ID of the Library to display.
Returns
Django HTTP response object
def workspace.tools.views.library.startNewLibrary (   request)

Start a new Library.

GET request returns the create Form, POST processes it.

Parameters
requestThe Django HTTP request object
Returns
Django HTTP response object
def workspace.tools.views.library.userLibraries (   request)

Display all Libraries owned or accessible by a user (/tools/userLibraries).

Parameters
requestThe Django HTTP request object
Returns
Django HTTP response object