|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.ChannelDefinition
public class ChannelDefinition
Describes a published channel.
Field Summary | |
---|---|
private java.util.Date |
chanApvlDt
|
private int |
chanApvlId
|
private java.lang.String |
chanClass
|
private java.lang.String |
chanDesc
|
private java.util.Hashtable |
chanDescs
|
private boolean |
chanEditable
|
private java.lang.String |
chanFName
|
private boolean |
chanHasAbout
|
private boolean |
chanHasHelp
|
private boolean |
chanIsSecure
|
private java.lang.String |
chanLocale
|
private java.lang.String |
chanName
|
private java.util.Hashtable |
chanNames
|
private java.util.Date |
chanPublDt
|
private int |
chanPupblUsrId
|
private int |
chanTimeout
|
private java.lang.String |
chanTitle
|
private java.util.Hashtable |
chanTitles
|
private int |
chanTypeId
|
private int |
id
|
private static org.apache.commons.logging.Log |
log
|
private java.util.Map |
parameters
|
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 |
private void |
addParameters(org.w3c.dom.Document doc,
org.w3c.dom.Element channel)
|
void |
clearParameters()
|
java.util.Date |
getApprovalDate()
|
int |
getApproverId()
|
private org.w3c.dom.Element |
getBase(org.w3c.dom.Document doc,
java.lang.String idTag,
java.lang.String chanClassArg,
boolean editable,
boolean hasHelp,
boolean hasAbout)
Get an Element expressing the minimum attributes necessary to represent a channel. |
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 |
isPortlet()
Returns true if this channel definition defines a portlet. |
boolean |
isSecure()
|
private org.w3c.dom.Element |
nodeParameter(org.w3c.dom.Document doc,
java.lang.String name,
int value)
|
private org.w3c.dom.Element |
nodeParameter(org.w3c.dom.Document doc,
java.lang.String name,
java.lang.String value)
|
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 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final org.apache.commons.logging.Log log
private int id
private java.lang.String chanFName
private java.lang.String chanName
private java.lang.String chanDesc
private java.lang.String chanTitle
private java.lang.String chanClass
private int chanTimeout
private int chanTypeId
private int chanPupblUsrId
private int chanApvlId
private java.util.Date chanPublDt
private java.util.Date chanApvlDt
private boolean chanEditable
private boolean chanHasHelp
private boolean chanHasAbout
private boolean chanIsSecure
private java.util.Map parameters
private java.lang.String chanLocale
private java.util.Hashtable chanDescs
private java.util.Hashtable chanTitles
private java.util.Hashtable chanNames
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 boolean isPortlet()
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 nameprivate org.w3c.dom.Element getBase(org.w3c.dom.Document doc, java.lang.String idTag, java.lang.String chanClassArg, boolean editable, boolean hasHelp, boolean hasAbout)
doc
- Document that will be the owner of the Element returnedidTag
- Value of the identifier for the channelchanClassArg
- fully qualified class name of the channeleditable
- true if the channel handles the Edit eventhasHelp
- true if the channel handles the Help eventhasAbout
- true if the channel handles the About event
private final org.w3c.dom.Element nodeParameter(org.w3c.dom.Document doc, java.lang.String name, int value)
private final org.w3c.dom.Element nodeParameter(org.w3c.dom.Document doc, java.lang.String name, java.lang.String value)
private final void addParameters(org.w3c.dom.Document doc, org.w3c.dom.Element channel)
public 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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |