org.jasig.portal.channel.dao.jpa
Class ChannelDefinitionImpl

java.lang.Object
  org.jasig.portal.channel.XmlGeneratingBaseChannelDefinition
      org.jasig.portal.channel.dao.jpa.ChannelDefinitionImpl

All Implemented Interfaces:

Serializable, IChannelDefinition, IBasicEntity

public class ChannelDefinitionImpl
extends XmlGeneratingBaseChannelDefinition
implements IChannelDefinition, IBasicEntity, Serializable

JPA/Hibernate implementation of the IChannelDefinition interface.

Author:

Jen Bourey, jbourey@unicon.net

See Also:

Serialized Form

Method Summary

void	addLocalizedDescription(String locale, String chanDesc)
void	addLocalizedName(String locale, String chanName)
void	addLocalizedTitle(String locale, String chanTitle)
void	addParameter(ChannelParameterImpl newParameter)
void	addParameter(IChannelParameter parameter) Adds a parameter to this channel definition
void	addParameter(String name, String value, boolean override) Adds a parameter to this channel definition
void	addParameter(String name, String value, String override)
void	clearParameters()
boolean	equals(Object object)
Date	getApprovalDate()
int	getApproverId()
String	getDescription()
String	getDescription(String locale)
EntityIdentifier	getEntityIdentifier() Implementation required by IBasicEntity interface.
Date	getExpirationDate()
int	getExpirerId()
String	getFName()
int	getId()
String	getJavaClass()
ChannelLifecycleState	getLifecycleState()
String	getLocale()
String	getName()
String	getName(String locale)
IChannelParameter	getParameter(String key)
Set<IChannelParameter>	getParameters()
Map<String,IChannelParameter>	getParametersAsUnmodifiableMap()
Date	getPublishDate()
int	getPublisherId()
int	getTimeout()
String	getTitle()
String	getTitle(String locale)
IChannelType	getType()
int	getTypeId() Deprecated.
boolean	hasAbout()
int	hashCode()
boolean	hasHelp()
boolean	isEditable()
boolean	isPortlet() Returns true if this channel definition defines a portlet.
boolean	isSecure()
void	removeParameter(IChannelParameter parameter) Removes a parameter from this channel definition
void	removeParameter(String name) Removes a parameter from this channel definition
void	replaceParameters(Set<IChannelParameter> parameters)
void	setApprovalDate(Date approvalDate)
void	setApproverId(int approvalId)
void	setDescription(String descr)
void	setEditable(boolean editable)
void	setExpirationDate(Date expirationDate)
void	setExpirerId(int expirerId)
void	setFName(String fname)
void	setHasAbout(boolean hasAbout)
void	setHasHelp(boolean hasHelp)
void	setIsSecure(boolean isSecure)
void	setJavaClass(String javaClass)
void	setLocale(String locale)
void	setName(String name)
void	setParameters(Set<IChannelParameter> parameters)
void	setPublishDate(Date publishDate)
void	setPublisherId(int publisherId)
void	setTimeout(int timeout)
void	setTitle(String title)
void	setType(IChannelType channelType)
String	toString()

Methods inherited from class org.jasig.portal.channel.XmlGeneratingBaseChannelDefinition

getDocument, getDocument

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.portal.channel.IChannelDefinition

getDocument, getDocument

Method Detail

getLifecycleState

public ChannelLifecycleState getLifecycleState()

Specified by:

getLifecycleState in interface IChannelDefinition

setFName

public void setFName(String fname)

Specified by:

setFName in interface IChannelDefinition

setJavaClass

public void setJavaClass(String javaClass)

Specified by:

setJavaClass in interface IChannelDefinition

setName

public void setName(String name)

Specified by:

setName in interface IChannelDefinition

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface IChannelDefinition

setType

public void setType(IChannelType channelType)

Specified by:

setType in interface IChannelDefinition

addParameter

public void addParameter(IChannelParameter parameter)

Description copied from interface: IChannelDefinition

Adds a parameter to this channel definition

Specified by:

addParameter in interface IChannelDefinition

Parameters:

parameter - the channel parameter to add

addParameter

public void addParameter(String name,
                         String value,
                         String override)

Specified by:

addParameter in interface IChannelDefinition

addParameter

public void addParameter(String name,
                         String value,
                         boolean override)

Description copied from interface: IChannelDefinition

Adds a parameter to this channel definition

Specified by:

addParameter in interface IChannelDefinition

Parameters:

name - the channel parameter name

value - the channel parameter value

override - the channel parameter override setting

addParameter

public void addParameter(ChannelParameterImpl newParameter)

clearParameters

public void clearParameters()

Specified by:

clearParameters in interface IChannelDefinition

getApprovalDate

public Date getApprovalDate()

Specified by:

getApprovalDate in interface IChannelDefinition

getApproverId

public int getApproverId()

Specified by:

getApproverId in interface IChannelDefinition

getDescription

public String getDescription()

Specified by:

getDescription in interface IChannelDefinition

getDescription

public String getDescription(String locale)

Specified by:

getDescription in interface IChannelDefinition

getExpirationDate

public Date getExpirationDate()

Specified by:

getExpirationDate in interface IChannelDefinition

getExpirerId

public int getExpirerId()

Specified by:

getExpirerId in interface IChannelDefinition

getEntityIdentifier

public EntityIdentifier getEntityIdentifier()

Description copied from interface: IChannelDefinition

Implementation required by IBasicEntity interface.

Specified by:

getEntityIdentifier in interface IChannelDefinition

Specified by:

getEntityIdentifier in interface IBasicEntity

Returns:

EntityIdentifier

getFName

public String getFName()

Specified by:

getFName in interface IChannelDefinition

getId

public int getId()

Specified by:

getId in interface IChannelDefinition

getJavaClass

public String getJavaClass()

Specified by:

getJavaClass in interface IChannelDefinition

getLocale

public String getLocale()

Specified by:

getLocale in interface IChannelDefinition

getName

public String getName()

Specified by:

getName in interface IChannelDefinition

getName

public String getName(String locale)

Specified by:

getName in interface IChannelDefinition

getParameter

public IChannelParameter getParameter(String key)

Specified by:

getParameter in interface IChannelDefinition

getParameters

public Set<IChannelParameter> getParameters()

Specified by:

getParameters in interface IChannelDefinition

getParametersAsUnmodifiableMap

public Map<String,IChannelParameter> getParametersAsUnmodifiableMap()

Specified by:

getParametersAsUnmodifiableMap in interface IChannelDefinition

getPublishDate

public Date getPublishDate()

Specified by:

getPublishDate in interface IChannelDefinition

getPublisherId

public int getPublisherId()

Specified by:

getPublisherId in interface IChannelDefinition

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface IChannelDefinition

getTitle

public String getTitle()

Specified by:

getTitle in interface IChannelDefinition

getTitle

public String getTitle(String locale)

Specified by:

getTitle in interface IChannelDefinition

getTypeId

@Deprecated
public int getTypeId()

Deprecated.

Specified by:

getTypeId in interface IChannelDefinition

getType

public IChannelType getType()

Specified by:

getType in interface IChannelDefinition

hasAbout

public boolean hasAbout()

Specified by:

hasAbout in interface IChannelDefinition

hasHelp

public boolean hasHelp()

Specified by:

hasHelp in interface IChannelDefinition

isEditable

public boolean isEditable()

Specified by:

isEditable in interface IChannelDefinition

isPortlet

public boolean isPortlet()

Description copied from interface: IChannelDefinition

Returns true if this channel definition defines a portlet. Returns false if this channel definition does not define a portlet or whether this channel definition defines a portlet or not cannot be determined because this definition's channel class is not set or cannot be loaded.

Specified by:

isPortlet in interface IChannelDefinition

Returns:

true if we know we're a portlet, false otherwise

isSecure

public boolean isSecure()

Specified by:

isSecure in interface IChannelDefinition

addLocalizedDescription

public void addLocalizedDescription(String locale,
                                    String chanDesc)

Specified by:

addLocalizedDescription in interface IChannelDefinition

addLocalizedName

public void addLocalizedName(String locale,
                             String chanName)

Specified by:

addLocalizedName in interface IChannelDefinition

addLocalizedTitle

public void addLocalizedTitle(String locale,
                              String chanTitle)

Specified by:

addLocalizedTitle in interface IChannelDefinition

removeParameter

public void removeParameter(IChannelParameter parameter)

Description copied from interface: IChannelDefinition

Removes a parameter from this channel definition

Specified by:

removeParameter in interface IChannelDefinition

Parameters:

parameter - the channel parameter to remove

removeParameter

public void removeParameter(String name)

Description copied from interface: IChannelDefinition

Removes a parameter from this channel definition

Specified by:

removeParameter in interface IChannelDefinition

Parameters:

name - the parameter name

replaceParameters

public void replaceParameters(Set<IChannelParameter> parameters)

Specified by:

replaceParameters in interface IChannelDefinition

setApprovalDate

public void setApprovalDate(Date approvalDate)

Specified by:

setApprovalDate in interface IChannelDefinition

setApproverId

public void setApproverId(int approvalId)

Specified by:

setApproverId in interface IChannelDefinition

setDescription

public void setDescription(String descr)

Specified by:

setDescription in interface IChannelDefinition

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface IChannelDefinition

setExpirationDate

public void setExpirationDate(Date expirationDate)

Specified by:

setExpirationDate in interface IChannelDefinition

setExpirerId

public void setExpirerId(int expirerId)

Specified by:

setExpirerId in interface IChannelDefinition

setHasAbout

public void setHasAbout(boolean hasAbout)

Specified by:

setHasAbout in interface IChannelDefinition

setHasHelp

public void setHasHelp(boolean hasHelp)

Specified by:

setHasHelp in interface IChannelDefinition

setIsSecure

public void setIsSecure(boolean isSecure)

Specified by:

setIsSecure in interface IChannelDefinition

setLocale

public void setLocale(String locale)

Specified by:

setLocale in interface IChannelDefinition

setParameters

public void setParameters(Set<IChannelParameter> parameters)

Specified by:

setParameters in interface IChannelDefinition

setPublishDate

public void setPublishDate(Date publishDate)

Specified by:

setPublishDate in interface IChannelDefinition

setPublisherId

public void setPublisherId(int publisherId)

Specified by:

setPublisherId in interface IChannelDefinition

setTimeout

public void setTimeout(int timeout)

Specified by:

setTimeout in interface IChannelDefinition

equals

public boolean equals(Object object)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()