blackboard.cms.lrngobj
Class LOItem

java.lang.Object
  blackboard.data.BbObject
      blackboard.cms.lrngobj.LOItem

All Implemented Interfaces:

blackboard.data.IBbObject, blackboard.data.Identifiable, java.lang.Cloneable

public class LOItem
extends blackboard.data.BbObject

The LOItem class provides a representation of a Learning Object Item within the Blackboard application. Learching Object Items usually refer to a physical file or folder within the Content System, with additional metadata and status information related as metadata.

When working with LOItems, use the LOItemManager object to load, save, and delete LOItems.

Since:

Bb CS 1.2

Version:

$Revision: #1 $

Nested Class Summary

static class

LOItem.Status

Field Summary

static blackboard.persist.DataType

DATA_TYPE Object data type constant used in brokering loaders and persisters

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

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

Method Summary

java.util.Calendar	getApprovedDate() Represents the date that the LOItem was approved
blackboard.persist.Id	getApproverId() Get the Approver Id for this LOItem.
java.lang.String	getAuthors() Return the author(s) for the LOItem
boolean	getAvailableExternalInd() Return a boolean that represents whether the LOItem is available externally
boolean	getAvailableInternalInd() Return a boolean that represents whether the LOItem is available internally
blackboard.persist.Id	getCategoryId() Get the Category Id for the LOItem
blackboard.persist.DataType	getDataType() Returns the DataType identifier for the object.
java.lang.String	getDescription() Return the description of the LOItem
java.lang.String	getFileEntryPath() Return the file entry path for the LOItem.
java.lang.String	getKeywords() Returns the keywords for the LOItem
java.lang.String	getLearningObjectives() Return the Learning Objectives for the LOItem
LOItem.Status	getStatus() Get the status for the LOItem
java.util.Calendar	getSubmittedDate() Represents the date that the LOItem was submitted
blackboard.persist.Id	getSubmitterId() Get the Submitter Id for this LOItem.
java.lang.String	getTitle() Returns the title of the Learning Object Item
void	setApprovedDate(java.util.Calendar cal) Set the date when the LOItem was approved
void	setApproverId(blackboard.persist.Id id) Set the Approver Id for the LOItem.
void	setAuthors(java.lang.String str) Set the author for the LOItem
void	setAvailableExternalInd(boolean val) Set whether the LOItem is available externally
void	setAvailableInternalInd(boolean val) Set whether the LOItem is available internally
void	setCategoryId(blackboard.persist.Id id) Set the Category Id for the LOItem
void	setDescription(java.lang.String str) Set the description for the LOItem
void	setFileEntryPath(java.lang.String str) Set the file entry path for the LOItem
void	setKeywords(java.lang.String str) Set the keywords for the LOItem
void	setLearningObjectives(java.lang.String str) Set the Learning Objectives for the LOItem
void	setStatus(LOItem.Status eStatus) Set the LOItem status
void	setSubmittedDate(java.util.Calendar cal) Set the date when the LOItem was submitted
void	setSubmitterId(blackboard.persist.Id id) Set the submitter Id for the LOItem.
void	setTitle(java.lang.String str) Sets the title of the Learning Object Item

Methods inherited from class blackboard.data.BbObject

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

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final blackboard.persist.DataType DATA_TYPE

Object data type constant used in brokering loaders and persisters

Constructor Detail

LOItem

public LOItem()

Creates an instance of LOItem with default property values.

Method Detail

getTitle

public java.lang.String getTitle()

Returns the title of the Learning Object Item

Returns:

a String representing the title for the Learning Object Item.

Since:

Bb CS 1.2

setTitle

public void setTitle(java.lang.String str)

Sets the title of the Learning Object Item

Parameters:

str - A String representing the title of the Item

Since:

Bb CS 1.2

getFileEntryPath

public java.lang.String getFileEntryPath()

Return the file entry path for the LOItem.

Returns:

A String containing the file entry path

Since:

Bb CS 1.2

setFileEntryPath

public void setFileEntryPath(java.lang.String str)

Set the file entry path for the LOItem

Parameters:

str - the file entry path

Since:

Bb CS 1.2

getDescription

public java.lang.String getDescription()

Return the description of the LOItem

Returns:

A String containing the description of the LOItem

Since:

Bb CS 1.2

setDescription

public void setDescription(java.lang.String str)

Set the description for the LOItem

Parameters:

str - A String representing the description

Since:

Bb CS 1.2

getLearningObjectives

public java.lang.String getLearningObjectives()

Return the Learning Objectives for the LOItem

Returns:

A String containing the Learing Objectives

Since:

Bb CS 1.2

setLearningObjectives

public void setLearningObjectives(java.lang.String str)

Set the Learning Objectives for the LOItem

Parameters:

str - A String representing the Learning Objectives

Since:

Bb CS 1.2

getKeywords

public java.lang.String getKeywords()

Returns the keywords for the LOItem

Returns:

A String containing the keywords

Since:

Bb CS 1.2

setKeywords

public void setKeywords(java.lang.String str)

Set the keywords for the LOItem

Parameters:

str - A String representing the keywords

Since:

Bb CS 1.2

getAuthors

public java.lang.String getAuthors()

Return the author(s) for the LOItem

Returns:

A String containing the author for the LOItem

Since:

Bb CS 1.2

setAuthors

public void setAuthors(java.lang.String str)

Set the author for the LOItem

Parameters:

str - A String representing the author for the LOItem

Since:

Bb CS 1.2

getSubmitterId

public blackboard.persist.Id getSubmitterId()

Get the Submitter Id for this LOItem. The Submitter Id represents the user that submitted the LOItem.

Returns:

An Id representing the user that submitted the LOItem

Since:

Bb CS 1.2

setSubmitterId

public void setSubmitterId(blackboard.persist.Id id)

Set the submitter Id for the LOItem. The Submitter Id represents the user that submitted the LOItem.

Parameters:

id - The Submitter Id represents the user that submitted the LOItem

Since:

Bb CS 1.2

getApproverId

public blackboard.persist.Id getApproverId()

Get the Approver Id for this LOItem. The Submitter Id represents the user that approved the LOItem.

Returns:

An Id representing the user that approved the LOItem

Since:

Bb CS 1.2

setApproverId

public void setApproverId(blackboard.persist.Id id)

Set the Approver Id for the LOItem. The Submitter Id represents the user that approved the LOItem.

Parameters:

id - The Approver Id represents the user that approved the LOItem

Since:

Bb CS 1.2

getCategoryId

public blackboard.persist.Id getCategoryId()

Get the Category Id for the LOItem

Returns:

an Id representing the Category Id

Since:

Bb CS 1.2

setCategoryId

public void setCategoryId(blackboard.persist.Id id)

Set the Category Id for the LOItem

Parameters:

id - An Id representing the Category Id to be set for the LOItem

Since:

Bb CS 1.2

getAvailableExternalInd

public boolean getAvailableExternalInd()

Return a boolean that represents whether the LOItem is available externally

Returns:

a Boolean that represents whether the LOItem is available externally

Since:

Bb CS 1.2

setAvailableExternalInd

public void setAvailableExternalInd(boolean val)

Set whether the LOItem is available externally

Parameters:

val - A Boolean representing whether the LOItem is available externally

Since:

Bb CS 1.2

getAvailableInternalInd

public boolean getAvailableInternalInd()

Return a boolean that represents whether the LOItem is available internally

Returns:

a Boolean that represents whether the LOItem is available internally

Since:

Bb CS 1.2

setAvailableInternalInd

public void setAvailableInternalInd(boolean val)

Set whether the LOItem is available internally

Parameters:

val - A Boolean representing whether the LOItem is available internally

Since:

Bb CS 1.2

getSubmittedDate

public java.util.Calendar getSubmittedDate()

Represents the date that the LOItem was submitted

Returns:

A Calendar representing the date that the LOItem was submitted

Since:

Bb CS 1.2

setSubmittedDate

public void setSubmittedDate(java.util.Calendar cal)

Set the date when the LOItem was submitted

Parameters:

cal - A Calendar object that represents when the LOItem was submitted

Since:

Bb CS 1.2

getApprovedDate

public java.util.Calendar getApprovedDate()

Represents the date that the LOItem was approved

Returns:

A Calendar representing the date that the LOItem was approved

Since:

Bb CS 1.2

setApprovedDate

public void setApprovedDate(java.util.Calendar cal)

Set the date when the LOItem was approved

Parameters:

cal - A Calendar representing the date that the LOItem was approved

Since:

Bb CS 1.2

getStatus

public LOItem.Status getStatus()

Get the status for the LOItem

Returns:

the LOItem status

Since:

Bb CS 1.2

setStatus

public void setStatus(LOItem.Status eStatus)

Set the LOItem status

Parameters:

eStatus - represents the status for the LOItem

Since:

Bb CS 1.2

getDataType

public blackboard.persist.DataType getDataType()

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

Specified by:

getDataType in interface blackboard.data.IBbObject

Specified by:

getDataType in interface blackboard.data.Identifiable

Specified by:

getDataType in class blackboard.data.BbObject

Returns:

the DataType for this object

Since:

Bb CS 1.2