blackboard.cms.portfolio
Class PortfolioPass

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

All Implemented Interfaces:

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

public class PortfolioPass
extends blackboard.data.BbObject

The PortfolioPass class provides a representation of a Portfolio Pass within the Blackboard application. Portfolio Passes are generally used to provide access to a Portfolio for user that don't have an account on the system.

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

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

Method Summary

blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getEmailAddresses() Returns the email address for the PortfolioPass.
java.util.Calendar	getExpireDate() Returns date that the PortfolioPass will expire.
java.lang.String	getPassword() Returns the password for the PortfolioPass.
boolean	getPasswordInd() Returns password flag for the PortfolioPass.
blackboard.persist.Id	getPortfolioId() Returns the Id for the PortfolioPass.
java.util.Calendar	getSentDate() Returns date that the PortfolioPass was sent.
java.lang.String	getTitle() Returns the Title for the PortfolioPass.
void	setEmailAddresses(java.lang.String str) Sets the email address for the PortfolioPass.
void	setExpireDate(java.util.Calendar cal) Set the date that the PortfolioPass will expire.
void	setPassword(java.lang.String str) Sets the password for the PortfolioPass.
void	setPasswordInd(boolean val) Set password flag for the PortfolioPass.
void	setPortfolioId(blackboard.persist.Id id) Sets the Id for the PortfolioPass.
void	setSentDate(java.util.Calendar cal) Set the date that the PortfolioPass was sent.
void	setTitle(java.lang.String str) Sets the Title for the PortfolioPass.

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

PortfolioPass

public PortfolioPass()

Creates an instance of PortfolioPass with default property values.

Method Detail

getPortfolioId

public blackboard.persist.Id getPortfolioId()

Returns the Id for the PortfolioPass.

Returns:

a Id representing the Id for the PortfolioPass.

setPortfolioId

public void setPortfolioId(blackboard.persist.Id id)

Sets the Id for the PortfolioPass.

Parameters:

id - an Id representing the Id for the PortfolioPass.

getEmailAddresses

public java.lang.String getEmailAddresses()

Returns the email address for the PortfolioPass. The email address represents the recipient of the PortfolioPass.

Returns:

a String representing the email address for the PortfolioPass.

setEmailAddresses

public void setEmailAddresses(java.lang.String str)

Sets the email address for the PortfolioPass. The email address represents the recipient of the PortfolioPass.

Parameters:

str - a String representing the email address for the PortfolioPass.

getTitle

public java.lang.String getTitle()

Returns the Title for the PortfolioPass.

Returns:

a String representing the Title for the PortfolioPass.

setTitle

public void setTitle(java.lang.String str)

Sets the Title for the PortfolioPass.

Parameters:

str - a String representing the Title for the PortfolioPass.

getPassword

public java.lang.String getPassword()

Returns the password for the PortfolioPass.

Returns:

a String representing the password for the PortfolioPass.

setPassword

public void setPassword(java.lang.String str)

Sets the password for the PortfolioPass.

Parameters:

str - a String representing the password for the PortfolioPass.

getPasswordInd

public boolean getPasswordInd()

Returns password flag for the PortfolioPass. If the flag is true, the PortfolioPass is password protected.

Returns:

a boolean representing whether the PortfolioPass is password protected.

setPasswordInd

public void setPasswordInd(boolean val)

Set password flag for the PortfolioPass. If the flag is true, the PortfolioPass is password protected.

Parameters:

val - true if the PortfolioPass is password protected, false otherwise

getSentDate

public java.util.Calendar getSentDate()

Returns date that the PortfolioPass was sent.

Returns:

a Calendar object representing the date the PortfolioPass is sent.

setSentDate

public void setSentDate(java.util.Calendar cal)

Set the date that the PortfolioPass was sent.

Parameters:

cal - a Calendar object representing the date the PortfolioPass is sent.

getExpireDate

public java.util.Calendar getExpireDate()

Returns date that the PortfolioPass will expire.

Returns:

a Calendar object representing the date the PortfolioPass is set to expire.

setExpireDate

public void setExpireDate(java.util.Calendar cal)

Set the date that the PortfolioPass will expire.

Parameters:

cal - a Calendar object representing the date the PortfolioPass is set to expire.

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