blackboard.data.course
Class Cartridge

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.course.Cartridge

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class Cartridge
extends BbObject

The Cartridge class provides a representation of a cartridge record (as related to a course) within the Blackboard application.

Since:

Bb 6.0

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Cartridge()
Creates an instance of Cartridge with default property values.

Method Summary

DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getDescription() Returns the description associated with this Cartridge.
java.lang.String	getIdentifier() Returns the identifier (string-based unique id) associated with this Cartridge.
java.lang.String	getPublisherName() Returns the publisher name associated with this Cartridge.
java.lang.String	getTitle() Returns the title associated with this Cartridge.
void	setDescription(java.lang.String strDescription) Sets the description associated with this Cartridge.
void	setIdentifier(java.lang.String strIdentifier) Sets the identifier associated with this Cartridge.
void	setPublisherName(java.lang.String strPublisherName) Sets the publisher name associated with this Cartridge.
void	setTitle(java.lang.String strTitle) Sets the title associated with this Cartridge.
void	validate() Validates the contents of this Cartridge.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

Constructor Detail

Cartridge

public Cartridge()

Creates an instance of Cartridge with default property values.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Returns the identifier (string-based unique id) associated with this Cartridge.

Returns:

the identifier value of this cartridge as a String

setIdentifier

public void setIdentifier(java.lang.String strIdentifier)

Sets the identifier associated with this Cartridge.

Parameters:

strIdentifier - a String containing the string-based unique identifier for this cartridge

getPublisherName

public java.lang.String getPublisherName()

Returns the publisher name associated with this Cartridge.

Returns:

the publisher name value of this cartridge as a String

setPublisherName

public void setPublisherName(java.lang.String strPublisherName)

Sets the publisher name associated with this Cartridge.

Parameters:

strPublisherName - a String containing the publisher name for this cartridge

getTitle

public java.lang.String getTitle()

Returns the title associated with this Cartridge.

Returns:

the title value of this cartridge as a String

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title associated with this Cartridge.

Parameters:

strTitle - a String containing the title for this cartridge

getDescription

public java.lang.String getDescription()

Returns the description associated with this Cartridge.

Returns:

the description value of this cartridge as a String

setDescription

public void setDescription(java.lang.String strDescription)

Sets the description associated with this Cartridge.

Parameters:

strDescription - a String containing the description for this cartridge

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

validate

public void validate()
              throws ValidationException

Validates the contents of this Cartridge. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails