blackboard.cms.portfolio
Class PortfolioItem

java.lang.Object
  extended by blackboard.data.BbObject
      extended by blackboard.cms.portfolio.PortfolioItem
All Implemented Interfaces:
IBbObject, Identifiable, java.io.Serializable, java.lang.Cloneable

public class PortfolioItem
extends BbObject

The PortfolioItem class provides a representation of a portfolio item within the Blackboard application. A PortfolioItem can currently be one of three types:

- entry: An existing item already in the Content System
- url: A valid web URL
- page: An item that contains HTML, that is generated from user input

Each of these types require that different attributes be set.

Since:
Bb CS 1.0
See Also:
Serialized Form

Field Summary
static DataType DATA_TYPE
          Object data type constant used in brokering loaders and persisters
 
Fields inherited from class blackboard.data.BbObject
_bbAttributes
 
Constructor Summary
PortfolioItem()
          Creates an instance of PortfolioItem with default property values.
 
Method Summary
 boolean getAvailableInd()
          Get availability flag for the PortfolioItem.
 DataType getDataType()
          Returns the DataType identifier for this object.
 java.lang.String getFileEntryPath()
          Returns the file path for item for the PortfolioItem
 java.lang.String getHref()
          Get the URL for the PortfolioItem.
 java.lang.String getHtml()
          Get the HTML content for the PortfolioItem.
 Id getPortfolioId()
          Returns the Id for the PortfolioItem.
 int getPosition()
          Returns the position for the PortfolioItem.
 java.lang.String getTitle()
          Returns the Title for the PortfolioItem.
 java.lang.String getType()
          Returns the type for the PortfolioItem.
 void setAvailableInd(boolean val)
          Set availability flag for the PortfolioItem.
 void setFileEntryPath(java.lang.String path)
          Sets the file path for item for the PortfolioItem
 void setHref(java.lang.String str)
          Set the URL for the PortfolioItem.
 void setHtml(java.lang.String str)
          Set the HTML content for the PortfolioItem.
 void setPortfolioId(Id id)
          Sets the Id for the PortfolioItem.
 void setPosition(int val)
          Sets the position for the PortfolioItem.
 void setTitle(java.lang.String str)
          Sets the Title for the PortfolioItem.
 void setType(java.lang.String str)
          Sets the type for the PortfolioItem.
 
Methods inherited from class blackboard.data.BbObject
clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, matches, 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 DataType DATA_TYPE
Object data type constant used in brokering loaders and persisters

Constructor Detail

PortfolioItem

public PortfolioItem()
Creates an instance of PortfolioItem with default property values.

Method Detail

getAvailableInd

public boolean getAvailableInd()
Get availability flag for the PortfolioItem. If the flag is true, the PortfolioItem is available in the Portfolio/code>.

Returns:
a boolean representing whether the PortfolioItem is available.

setAvailableInd

public void setAvailableInd(boolean val)
Set availability flag for the PortfolioItem. If the flag is true, the PortfolioItem is available in the Portfolio/code>.

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

getFileEntryPath

public java.lang.String getFileEntryPath()
Returns the file path for item for the PortfolioItem

Returns:
a String representing the file path for the PortfolioItem.

setFileEntryPath

public void setFileEntryPath(java.lang.String path)
Sets the file path for item for the PortfolioItem

Parameters:
path - a String representing the file path for the PortfolioItem.

getHref

public java.lang.String getHref()
Get the URL for the PortfolioItem. Currently used for type='url'

Returns:
a String representing the URL for the PortfolioItem.

setHref

public void setHref(java.lang.String str)
Set the URL for the PortfolioItem. Currently used for type='url'

Parameters:
str - a String representing the URL for the PortfolioItem.

getHtml

public java.lang.String getHtml()
Get the HTML content for the PortfolioItem. Currently used for type='page'.

Returns:
a String representing the HTML content for the PortfolioItem.

setHtml

public void setHtml(java.lang.String str)
Set the HTML content for the PortfolioItem. Currently used for type='page'.

Parameters:
str - a String representing the HTML content for the PortfolioItem.

getPortfolioId

public Id getPortfolioId()
Returns the Id for the PortfolioItem.

Returns:
a Id representing the Id for the PortfolioItem.

setPortfolioId

public void setPortfolioId(Id id)
Sets the Id for the PortfolioItem.

Parameters:
id - an Id representing the Id for the PortfolioItem.

getPosition

public int getPosition()
Returns the position for the PortfolioItem. The position represents the PortfolioItem location in the navigation links.

Returns:
an integer representing the position for the PortfolioItem in the Portfolio.

setPosition

public void setPosition(int val)
Sets the position for the PortfolioItem. The position represents the PortfolioItem location in the navigation links.

Parameters:
val - an integer representing the position for the PortfolioItem in the Portfolio.

getTitle

public java.lang.String getTitle()
Returns the Title for the PortfolioItem.

Returns:
a String representing the Title for the PortfolioItem.

setTitle

public void setTitle(java.lang.String str)
Sets the Title for the PortfolioItem.

Parameters:
str - a String representing the Title for the PortfolioItem.

getType

public java.lang.String getType()
Returns the type for the PortfolioItem. Types can be 'item','url', or 'entry'.

Returns:
a String representing the type for the PortfolioItem.

setType

public void setType(java.lang.String str)
Sets the type for the PortfolioItem. Types should be 'item','url', or 'entry'.

Parameters:
str - a String representing the type for the PortfolioItem.

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


Copyright © 2012 Blackboard, Inc. All Rights Reserved.