|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.ChannelDefinition
Describes a published channel.
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 |
public ChannelDefinition(int id)
id
- the channel definition IDMethod Detail |
public int getId()
public java.lang.String getFName()
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.String getTitle()
public java.lang.String getJavaClass()
public int getTimeout()
public int getTypeId()
public int getPublisherId()
public int getApproverId()
public java.util.Date getPublishDate()
public java.util.Date getApprovalDate()
public boolean isEditable()
public boolean hasHelp()
public boolean hasAbout()
public boolean isSecure()
public ChannelParameter[] getParameters()
public java.lang.String getLocale()
public java.lang.String getName(java.lang.String locale)
public java.lang.String getDescription(java.lang.String locale)
public java.lang.String getTitle(java.lang.String locale)
public void setFName(java.lang.String fname)
public void setName(java.lang.String name)
public void setDescription(java.lang.String descr)
public void setTitle(java.lang.String title)
public void setJavaClass(java.lang.String javaClass)
public void setTimeout(int timeout)
public void setTypeId(int typeId)
public void setPublisherId(int publisherId)
public void setApproverId(int approvalId)
public void setPublishDate(java.util.Date publishDate)
public void setApprovalDate(java.util.Date approvalDate)
public void setEditable(boolean editable)
public void setHasHelp(boolean hasHelp)
public void setHasAbout(boolean hasAbout)
public void setIsSecure(boolean isSecure)
public void setLocale(java.lang.String locale)
public void clearParameters()
public void setParameters(ChannelParameter[] parameters)
public void replaceParameters(ChannelParameter[] parameters)
public void putChanTitles(java.lang.String locale, java.lang.String chanTitle)
public void putChanNames(java.lang.String locale, java.lang.String chanName)
public void putChanDescs(java.lang.String locale, java.lang.String chanDesc)
public EntityIdentifier getEntityIdentifier()
getEntityIdentifier
in interface IBasicEntity
public void addParameter(ChannelParameter parameter)
parameter
- the channel parameter to addpublic void addParameter(java.lang.String name, java.lang.String value, java.lang.String override)
name
- the channel parameter namevalue
- the channel parameter valueoverride
- the channel parameter override settingpublic void removeParameter(ChannelParameter parameter)
parameter
- the channel parameter to removepublic void removeParameter(java.lang.String name)
name
- the parameter namepublic org.w3c.dom.Element getDocument(org.w3c.dom.Document doc, java.lang.String idTag, java.lang.String statusMsg, int errorId)
public org.w3c.dom.Element getDocument(org.w3c.dom.Document doc, java.lang.String idTag)
public boolean refreshMe()
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |