uPortal 2.4.1
API Documentation

org.jasig.portal
Class ChannelDefinition

java.lang.Object
  extended byorg.jasig.portal.ChannelDefinition
All Implemented Interfaces:
IBasicEntity

public class ChannelDefinition
extends java.lang.Object
implements IBasicEntity

Describes a published channel.

Version:
$Revision: 1.22.2.1 $
Author:
George Lindholm, ITServices, UBC

Constructor Summary
ChannelDefinition(int id)
          Constructs a channel definition.
 
Method Summary
 void addParameter(ChannelParameter parameter)
          Adds a parameter to this channel definition
 void addParameter(java.lang.String name, java.lang.String value, java.lang.String override)
          Adds a parameter to this channel definition
 void clearParameters()
           
 java.util.Date getApprovalDate()
           
 int getApproverId()
           
 java.lang.String getDescription()
           
 java.lang.String getDescription(java.lang.String locale)
           
 org.w3c.dom.Element getDocument(org.w3c.dom.Document doc, java.lang.String idTag)
          return an xml representation of this channel
 org.w3c.dom.Element getDocument(org.w3c.dom.Document doc, java.lang.String idTag, java.lang.String statusMsg, int errorId)
          Display a message where this channel should be
 EntityIdentifier getEntityIdentifier()
          Implementation required by IBasicEntity interface.
 java.lang.String getFName()
           
 int getId()
           
 java.lang.String getJavaClass()
           
 java.lang.String getLocale()
           
 java.lang.String getName()
           
 java.lang.String getName(java.lang.String locale)
           
 ChannelParameter[] getParameters()
           
 java.util.Date getPublishDate()
           
 int getPublisherId()
           
 int getTimeout()
           
 java.lang.String getTitle()
           
 java.lang.String getTitle(java.lang.String locale)
           
 int getTypeId()
           
 boolean hasAbout()
           
 boolean hasHelp()
           
 boolean isEditable()
           
 boolean isSecure()
           
 void putChanDescs(java.lang.String locale, java.lang.String chanDesc)
           
 void putChanNames(java.lang.String locale, java.lang.String chanName)
           
 void putChanTitles(java.lang.String locale, java.lang.String chanTitle)
           
 boolean refreshMe()
          Is it time to reload me from the data store
 void removeParameter(ChannelParameter parameter)
          Removes a parameter from this channel definition
 void removeParameter(java.lang.String name)
          Removes a parameter from this channel definition
 void replaceParameters(ChannelParameter[] parameters)
           
 void setApprovalDate(java.util.Date approvalDate)
           
 void setApproverId(int approvalId)
           
 void setDescription(java.lang.String descr)
           
 void setEditable(boolean editable)
           
 void setFName(java.lang.String fname)
           
 void setHasAbout(boolean hasAbout)
           
 void setHasHelp(boolean hasHelp)
           
 void setIsSecure(boolean isSecure)
           
 void setJavaClass(java.lang.String javaClass)
           
 void setLocale(java.lang.String locale)
           
 void setName(java.lang.String name)
           
 void setParameters(ChannelParameter[] parameters)
           
 void setPublishDate(java.util.Date publishDate)
           
 void setPublisherId(int publisherId)
           
 void setTimeout(int timeout)
           
 void setTitle(java.lang.String title)
           
 void setTypeId(int typeId)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChannelDefinition

public ChannelDefinition(int id)
Constructs a channel definition.

Parameters:
id - the channel definition ID
Method Detail

getId

public int getId()

getFName

public java.lang.String getFName()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getTitle

public java.lang.String getTitle()

getJavaClass

public java.lang.String getJavaClass()

getTimeout

public int getTimeout()

getTypeId

public int getTypeId()

getPublisherId

public int getPublisherId()

getApproverId

public int getApproverId()

getPublishDate

public java.util.Date getPublishDate()

getApprovalDate

public java.util.Date getApprovalDate()

isEditable

public boolean isEditable()

hasHelp

public boolean hasHelp()

hasAbout

public boolean hasAbout()

isSecure

public boolean isSecure()

getParameters

public ChannelParameter[] getParameters()

getLocale

public java.lang.String getLocale()

getName

public java.lang.String getName(java.lang.String locale)

getDescription

public java.lang.String getDescription(java.lang.String locale)

getTitle

public java.lang.String getTitle(java.lang.String locale)

setFName

public void setFName(java.lang.String fname)

setName

public void setName(java.lang.String name)

setDescription

public void setDescription(java.lang.String descr)

setTitle

public void setTitle(java.lang.String title)

setJavaClass

public void setJavaClass(java.lang.String javaClass)

setTimeout

public void setTimeout(int timeout)

setTypeId

public void setTypeId(int typeId)

setPublisherId

public void setPublisherId(int publisherId)

setApproverId

public void setApproverId(int approvalId)

setPublishDate

public void setPublishDate(java.util.Date publishDate)

setApprovalDate

public void setApprovalDate(java.util.Date approvalDate)

setEditable

public void setEditable(boolean editable)

setHasHelp

public void setHasHelp(boolean hasHelp)

setHasAbout

public void setHasAbout(boolean hasAbout)

setIsSecure

public void setIsSecure(boolean isSecure)

setLocale

public void setLocale(java.lang.String locale)

clearParameters

public void clearParameters()

setParameters

public void setParameters(ChannelParameter[] parameters)

replaceParameters

public void replaceParameters(ChannelParameter[] parameters)

putChanTitles

public void putChanTitles(java.lang.String locale,
                          java.lang.String chanTitle)

putChanNames

public void putChanNames(java.lang.String locale,
                         java.lang.String chanName)

putChanDescs

public void putChanDescs(java.lang.String locale,
                         java.lang.String chanDesc)

getEntityIdentifier

public EntityIdentifier getEntityIdentifier()
Implementation required by IBasicEntity interface.

Specified by:
getEntityIdentifier in interface IBasicEntity
Returns:
EntityIdentifier

addParameter

public void addParameter(ChannelParameter parameter)
Adds a parameter to this channel definition

Parameters:
parameter - the channel parameter to add

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value,
                         java.lang.String override)
Adds a parameter to this channel definition

Parameters:
name - the channel parameter name
value - the channel parameter value
override - the channel parameter override setting

removeParameter

public void removeParameter(ChannelParameter parameter)
Removes a parameter from this channel definition

Parameters:
parameter - the channel parameter to remove

removeParameter

public void removeParameter(java.lang.String name)
Removes a parameter from this channel definition

Parameters:
name - the parameter name

getDocument

public org.w3c.dom.Element getDocument(org.w3c.dom.Document doc,
                                       java.lang.String idTag,
                                       java.lang.String statusMsg,
                                       int errorId)
Display a message where this channel should be


getDocument

public org.w3c.dom.Element getDocument(org.w3c.dom.Document doc,
                                       java.lang.String idTag)
return an xml representation of this channel


refreshMe

public boolean refreshMe()
Is it time to reload me from the data store


uPortal 2.4.1
API Documentation