org.sakaiproject.tool.assessment.business.entity
Class RecordingData

java.lang.Object
  org.sakaiproject.tool.assessment.business.entity.RecordingData

All Implemented Interfaces:

Serializable

public class RecordingData
extends Object
implements Serializable

Copyright: Copyright (c) 2003

Organization: Stanford University

This class implements common methods for describing data needed to record/save and retrieve audio recordings.

Usage :

RecordingData rd = new RecordingData("Rachel Gollub", "rgollub", "Intro to Wolverines and Aardvarks 221B", "10", "25"); log.debug("rgollub file:" + rd.getFileName() + "." + rd.getFileExtension()); log.debug("limit =" + rd.getLimit()); log.debug("seconds=" + rd.getSeconds());

Version:

$Id: RecordingData.java 9273 2006-05-10 22:34:28Z daisyf@stanford.edu $

Author:

Ed Smiley

See Also:

Serialized Form

Constructor Summary

RecordingData(String agent_name, String agent_id, String course_assignment_context, String lim, String sec)
Initialize with required data.

Method Summary

String	getAgentId() Accessor for agent (creator) id.
String	getAgentName() Accessor for agent (creator) name.
String	getAppName() Accessor for the user-facing application name for recording applet.
String	getCourseAssignmentContext() Accessor for free form text describing creation context.
String	getDir() Get target file system directory for audio uploads.
String	getFileExtension() Accessor for standard audio filename extension.
String	getFileName() Accessor for standard audio filename.
String	getImageURL() Accessor for the image URL for recording widget images.
String	getLimit() Accessor for retry limit.
String	getSeconds() Accessor for maximum number of seconds for recording.
Document	getXMLDataModel() This takes a RecordingData object and puts it in XML.
static void	main(String[] args) hook for unit test
void	setAgentId(String s) Mutator for recording agent id.
void	setAgentName(String s) Mutator for recording agent.
void	setAppName(String s) Mutator for the user-facing application name for recording applet.
void	setCourseAssignmentContext(String s) Mutator for recording context string.
void	setDir(String s) DOCUMENTATION PENDING
void	setFileExtension(String s) Mutator for file extension.
void	setFileName(String s) Mutator for file name.
void	setImageURL(String s) Mutator for widget images directory.
void	setLimit(String s) Mutator for retry limit.
void	setSeconds(String s) Mutator for seconds limit.
static void	unitTest() unit test for use with jUnit etc. this only tests the file name computation, the other methods are pretty trivial

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingData

public RecordingData(String agent_name,
                     String agent_id,
                     String course_assignment_context,
                     String lim,
                     String sec)

Initialize with required data. All other values are assigned a default. All values can be overridden with the mutators.

Parameters:

agent_name - The name of the person uploading the file

agent_id - The id code of the person uploading the file

course_assignment_context - The name of the course, assignment, part, quetion etc.

lim - limit on number of tries (0=unlimited, default if null)

sec - limit on time in seconds (30 default if null)

Usage :

RecordingData rd = new RecordingData("Rachel Gollub", "rgollub", "Intro to Wolverines and Aardvarks 221B", "10", "25"); log.debug("rgollub file:" + rd.getFileName() + "." + rd.getFileExtension()); log.debug("limit =" + rd.getLimit()); log.debug("seconds=" + rd.getSeconds());

Method Detail

getAgentName

public String getAgentName()

Accessor for agent (creator) name.

Returns:

agent (creator) name.

getAgentId

public String getAgentId()

Accessor for agent (creator) id.

Returns:

agent (creator) id.

getCourseAssignmentContext

public String getCourseAssignmentContext()

Accessor for free form text describing creation context. See Usage notes.

Returns:

free form text describing creation context.

getFileExtension

public String getFileExtension()

Accessor for standard audio filename extension.

Returns:

standard audio file extension.

getFileName

public String getFileName()

Accessor for standard audio filename.

Returns:

standard audio file name.

getLimit

public String getLimit()

Accessor for retry limit. If the number of retries are unlimited, this is 0.

Returns:

retry limit

getDir

public String getDir()

Get target file system directory for audio uploads.

Returns:

file system directory for audio uploads.

getSeconds

public String getSeconds()

Accessor for maximum number of seconds for recording.

Returns:

maximum number of seconds for recording.

getAppName

public String getAppName()

Accessor for the user-facing application name for recording applet.

Returns:

user-facing application name for recording applet.

getImageURL

public String getImageURL()

Accessor for the image URL for recording widget images.

Returns:

image URL for recording widget images.

setAgentName

public void setAgentName(String s)

Mutator for recording agent.

Parameters:

s - recording agent

setAgentId

public void setAgentId(String s)

Mutator for recording agent id.

Parameters:

s - recording agent id.

setCourseAssignmentContext

public void setCourseAssignmentContext(String s)

Mutator for recording context string. See: Usage

Parameters:

s - recording context string.

setFileExtension

public void setFileExtension(String s)

Mutator for file extension.

Parameters:

s - audio recording file extension.

setFileName

public void setFileName(String s)

Mutator for file name.

Parameters:

s - audio recording file name.

setLimit

public void setLimit(String s)

Mutator for retry limit.

Parameters:

s - audio recording retry limit.

setDir

public void setDir(String s)

DOCUMENTATION PENDING

Parameters:

s - DOCUMENTATION PENDING

setSeconds

public void setSeconds(String s)

Mutator for seconds limit.

Parameters:

s - audio recording seconds limit.

setAppName

public void setAppName(String s)

Mutator for the user-facing application name for recording applet.

Parameters:

s - user-facing application name for recording applet.

setImageURL

public void setImageURL(String s)

Mutator for widget images directory.

Parameters:

s - widget images directory.

getXMLDataModel

public Document getXMLDataModel()

This takes a RecordingData object and puts it in XML.

Returns:

the XML as an org.w3c.dom.Document

unitTest

public static void unitTest()

unit test for use with jUnit etc. this only tests the file name computation, the other methods are pretty trivial

Parameters:

none -

main

public static void main(String[] args)

hook for unit test

Parameters:

args - not used