blackboard.cms.portfolio
Class Portfolio

java.lang.Object
  blackboard.data.BbObject
      blackboard.cms.portfolio.Portfolio

All Implemented Interfaces:

java.lang.Cloneable, blackboard.data.IBbObject

public class Portfolio

extends blackboard.data.BbObject

The Portfolio class provides a representation of a portfolio within the Blackboard application.

Since:

Bb CS 1.0

Version:

$Revision: $

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

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

Method Summary

boolean	getAccountsAccessInd()
boolean	getAvailableInd() Returns the availability flag for the Portfolio.
java.lang.String	getBgColor() Returns the background color for this Portfolio.
blackboard.persist.Id	getButtonStyleId() Returns the button style Id for the Portfolio .
boolean	getCommentsSharedInd() Returns the comments flag for the Portfolio.
blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getDescription() Returns the Portfolio description.
java.lang.String	getLearningObjectives() Returns the Portfolio Learning objectives.
blackboard.persist.Id	getOwnerId() Returns the owner Id for the Portfolio .
java.lang.String	getTextColor() Returns the text color for this Portfolio.
boolean	getTextNavInd() Returns the text navigation flag for the Portfolio.
java.lang.String	getTitle() Returns the title for this Portfolio.
void	setAccountsAccessInd(boolean val)
void	setAvailableInd(boolean val) Sets the availability flag for the Portfolio.
void	setBgColor(java.lang.String str) Sets the background color for the Portfolio.
void	setButtonStyleId(blackboard.persist.Id id) Sets the button style Id for this Portfolio.
void	setCommentsSharedInd(boolean val) Sets the comments flag for the Portfolio.
void	setDescription(java.lang.String str) Sets the description for the Portfolio.
void	setLearningObjectives(java.lang.String str) Sets the Learning Objectives for the Portfolio.
void	setOwnerId(blackboard.persist.Id id) Sets the owner Id for the Portfolio.
void	setTextColor(java.lang.String str) Sets the text color for this Portfolio.
void	setTextNavInd(boolean val) Sets the text navigation flag for the Portfolio.
void	setTitle(java.lang.String strTitle) Sets the title for this Portfolio.

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

Portfolio

public Portfolio()

Creates an instance of Portfolio with default property values.

Method Detail

getAvailableInd

public boolean getAvailableInd()

Returns the availability flag for the Portfolio. This flag determines whether or not the Portfolio is available to users (other than the owner).

Returns:

a boolean denoting whether the Portfolio is available.

setAvailableInd

public void setAvailableInd(boolean val)

Sets the availability flag for the Portfolio. This flag determines whether or not the Portfolio is available to users (other than the owner).

Parameters:

val - true if the Portfolio should be available, false otherwise.

getBgColor

public java.lang.String getBgColor()

Returns the background color for this Portfolio. The background color is displayed in the left-hand side of the frame when viewing/previewing a Portfolio

Returns:

a String representing the background color for the Portfolio.

setBgColor

public void setBgColor(java.lang.String str)

Sets the background color for the Portfolio. The background color is displayed in the left-hand side of the frame when viewing/previewing a Portfolio

Parameters:

str - a String representing the background color for the Portfolio. Values should be in hexidecimal RGB format. For example: #FFFFFF, #004263

getCommentsSharedInd

public boolean getCommentsSharedInd()

Returns the comments flag for the Portfolio. This flag determines whether or not the Portfolio is available to users (other than the owner).

Returns:

a boolean denoting whether the Portfolio allows comments to be posted.

setCommentsSharedInd

public void setCommentsSharedInd(boolean val)

Sets the comments flag for the Portfolio. This flag determines whether or not users can post comments to the Portfolio. The comments link will be rendered as the last item in the Portfolio navigation menu.

Parameters:

val - true if this Portfolio should allow comments, false otherwise.

getTextNavInd

public boolean getTextNavInd()

Returns the text navigation flag for the Portfolio. This flag determines whether or not the Portfolio is using text based navigation items.

Returns:

a boolean denoting whether the Portfolio is using text-based navigation. If false, it is using buttonstyles.

setTextNavInd

public void setTextNavInd(boolean val)

Sets the text navigation flag for the Portfolio. This flag determines whether or not the Portfolio is using text based navigation items.

Parameters:

val - true if the Portfolio should use text based navigation, false for buttonstyle navigation.

getDescription

public java.lang.String getDescription()

Returns the Portfolio description.

Returns:

a String representing the description for the Portfolio.

setDescription

public void setDescription(java.lang.String str)

Sets the description for the Portfolio.

Parameters:

str - a String representing the description for the Portfolio.

getLearningObjectives

public java.lang.String getLearningObjectives()

Returns the Portfolio Learning objectives.

Returns:

a String representing the learning objectives for the Portfolio.

setLearningObjectives

public void setLearningObjectives(java.lang.String str)

Sets the Learning Objectives for the Portfolio.

Parameters:

str - a String representing the Learning Objectives for the Portfolio.

getOwnerId

public blackboard.persist.Id getOwnerId()

Returns the owner Id for the Portfolio .

Returns:

an owner Id for this Portfolio.

setOwnerId

public void setOwnerId(blackboard.persist.Id id)

Sets the owner Id for the Portfolio.

Parameters:

id - an owner Id for the Portfolio.

getButtonStyleId

public blackboard.persist.Id getButtonStyleId()

Returns the button style Id for the Portfolio .

Returns:

a button style Id for this Portfolio.

setButtonStyleId

public void setButtonStyleId(blackboard.persist.Id id)

Sets the button style Id for this Portfolio.

Parameters:

id - a button style Id for this Portfolio.

getAccountsAccessInd

public boolean getAccountsAccessInd()

setAccountsAccessInd

public void setAccountsAccessInd(boolean val)

getTextColor

public java.lang.String getTextColor()

Returns the text color for this Portfolio. The text color, when using text navigation, is the color of the navigation item text.

Returns:

a String representing the text color for this Portfolio.

setTextColor

public void setTextColor(java.lang.String str)

Sets the text color for this Portfolio. The text color, when using text navigation, is the color of the navigation item text.

Parameters:

str - a String representing the text color for this Portfolio. Values should be in hexidecimal RGB format. For example: #FFFFFF, #004263

getTitle

public java.lang.String getTitle()

Returns the title for this Portfolio.

Returns:

a String representing the title for this Portfolio.

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title for this Portfolio.

Parameters:

strTitle - a String representing the title for this Portfolio.

getDataType

public blackboard.persist.DataType getDataType()

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

Returns:

the DataType for this object