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

Classes

class  TagSetForm
 

Functions

def deleteTagSet (request, tagSetId)
 Delete the specified TagSet, and all contained Tags. More...
 
def tagSets (request)
 Display a list of all of the user's own TagSets. More...
 
def projectTagSets (request, projectId)
 Display a list of all of the user's own TagSets. More...
 
def startNewTagSet (request, projectId)
 Create a new TagSet within the specified Project. More...
 
def getProjectTagSetsInfo (request, projectId)
 Get a list of TagSets in a Project, and return a count of the tags in each TagSet. More...
 
def viewTagSet (request, tagSetId)
 View a TagSet and edit it's Notes. More...
 

Function Documentation

def workspace.tools.views.tagSet.deleteTagSet (   request,
  tagSetId 
)

Delete the specified TagSet, and all contained Tags.

Parameters
requestThe Django HTTP request object
tagSetIdThe Database ID of the tagset to remove
projectThe Project Object to which the TagSet belongs
Returns
Django HTTP response object ( tagSets() )
def workspace.tools.views.tagSet.getProjectTagSetsInfo (   request,
  projectId 
)

Get a list of TagSets in a Project, and return a count of the tags in each TagSet.

Note
The user and machine tag counts may be skewed. Here, machine tags are those that are also NOT user tags, so an exclusive OR.
Parameters
requestThe Django HTTP request. Note that this expects a GET method.
projectIdThe database Id of a Project to search.
Returns
JSON encoded list of dictionary [ {id, name, numUserTags, numMachineTags, totalTags } ].
def workspace.tools.views.tagSet.projectTagSets (   request,
  projectId 
)

Display a list of all of the user's own TagSets.

Parameters
requestThe Django HTTP request object
Returns
Django HTTP response object
def workspace.tools.views.tagSet.startNewTagSet (   request,
  projectId 
)

Create a new TagSet within the specified Project.

Uses the TagSetForm. Returns the form on GET, processes it on POST

Parameters
requestThe Django HTTP request object
projectIdThe Database ID of the Project in which to create the TagSet.
Returns
Django HTTP response object (Redirect to the TagSets Page on Success)
def workspace.tools.views.tagSet.tagSets (   request)

Display a list of all of the user's own TagSets.

Parameters
requestThe Django HTTP request object
Returns
Django HTTP response object
def workspace.tools.views.tagSet.viewTagSet (   request,
  tagSetId 
)

View a TagSet and edit it's Notes.

Parameters
requestThe Django HTTP request. Note that this expects a GET method.
tagSetIdThe database Id of the TagSet to show.
Returns
Django HTTP response object.