blackboard.cms.portfolio
Class PortfolioPageTemplate

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

All Implemented Interfaces:

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

public class PortfolioPageTemplate
extends blackboard.data.BbObject

The PortfolioPageTemplate class provides a representation of a portfolio page templates within the Blackboard application. These templates are typically used within the PortfolioItem object where the type is 'page'.

Since:

Bb CS 1.0

Version:

$Revision: #1 $

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

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

Method Summary

boolean	getAvailableInd() Get availability flag for the PortfolioPageTemplate.
blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getHtml() Get the HTML content for the PortfolioPageTemplate.
java.lang.String	getTitle() Returns the Title for the PortfolioPageTemplate.
void	setAvailableInd(boolean val) Set availability flag for the PortfolioPageTemplate.
void	setHtml(java.lang.String str) Set the HTML content for the PortfolioPageTemplate.
void	setTitle(java.lang.String str) Sets the Title for the PortfolioPageTemplate.

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

PortfolioPageTemplate

public PortfolioPageTemplate()

Creates an instance of PortfolioPageTemplate with default property values.

Method Detail

getAvailableInd

public boolean getAvailableInd()

Get availability flag for the PortfolioPageTemplate. If the flag is true, the PortfolioPageTemplate is available to be used when creating/updating a Portfolio.

Returns:

a boolean representing whether the PortfolioPageTemplate is available.

setAvailableInd

public void setAvailableInd(boolean val)

Set availability flag for the PortfolioPageTemplate. If the flag is true, the PortfolioPageTemplate is available to be used when creating/updating a Portfolio.

Parameters:

val - true if this PortfolioItem is available, false otherwise.

getHtml

public java.lang.String getHtml()

Get the HTML content for the PortfolioPageTemplate.

Returns:

a String representing the HTML content for the PortfolioPageTemplate.

setHtml

public void setHtml(java.lang.String str)

Set the HTML content for the PortfolioPageTemplate. Currently used for type='page'.

Parameters:

str - a String representing the HTML content for the PortfolioPageTemplate.

getTitle

public java.lang.String getTitle()

Returns the Title for the PortfolioPageTemplate.

Returns:

a String representing the Title for the PortfolioPageTemplate.

setTitle

public void setTitle(java.lang.String str)

Sets the Title for the PortfolioPageTemplate.

Parameters:

str - a String representing the Title for the PortfolioPageTemplate.

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.

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