Java Doc for IUserLayoutChannelDescription.java in » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » layout » node » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.layout.node

Source Cross Reference Class Diagram Java Document (Java Doc)

org.jasig.portal.layout.node .IUserLayoutChannelDescription

All known Subclasses:   org.jasig.portal.layout.node .UserLayoutChannelDescription,
IUserLayoutChannelDescription
public interface IUserLayoutChannelDescription extends IUserLayoutNodeDescription(Code)
An interface managing information contained in a user layout channel node.
author:
   Peter Kharchenko pkharchenko@interactivebusiness.com"
version:
   1.0

Method Summary
public boolean canOverrideParameter(String parameterName)
     Determine if a given parameter can be overriden by the user.
public void clearParameters()
     Clears all of the channel parameters.
public boolean containsParameter(String parameterName)
     Determines if a certain parameter name is present.
Parameters:
  parameterName - a String parameter name.
public String getChannelPublishId()
     Get the value of channelPublishId for this channel.
public String getChannelSubscribeId()
     Get the value of channelSubscribeId.
public String getChannelTypeId()
     Get the value of channelTypeId.
public String getClassName()
     Get the value of className implementing this channel.
public String getDescription()
     Get the value of description.
public String getFunctionalName()
     Get the value of functionalName.
public Map getParameterMap()
     Returns an entire mapping of parameters.
public Enumeration getParameterNames()
     Obtain a set of channel parameter names.
public boolean getParameterOverrideValue(String parameterName)
     Obtain a channel parameter override value.
public String getParameterValue(String parameterName)
     Obtain a channel parameter value.
public Collection getParameterValues()
     Obtain values of all existing channel parameters.
public long getTimeout()
     Get the value of channel timeout in milliseconds.
public String getTitle()
     Get the value of title.
public Element getXML(Document root)
     Creates a org.w3c.dom.Element representation of the current channel.
Parameters:
  root - a Document for which the Element should be created.
public boolean hasAbout()
     Determine if the channel supports "about" action.
public boolean hasHelp()
     Determine if the channel supports "help" action.
public boolean hasParameters()
     Determine if the channel has any parameters.
public boolean isEditable()
     Determine if the channel is editable.
public boolean isPortlet()
     Return true if the described channel is a JSR-168 portlet, false otherwise.
public boolean isSecure()
     Get the value of secure.
public int numberOfParameters()
     Determines the number of existing channel parameters.
public String remove(String parameterName)
     Remove a channel parameter.
Parameters:
  parameterName - a String parameter name.
public void resetParameter(String parameterName)
     Reset a channel parameter value.
public void setChannelPublishId(String v)
     Set the value of channelPublishId for this channel.
public void setChannelSubscribeId(String v)
     Set the value of channelSubscribeId.
public void setChannelTypeId(String v)
     Set the value of channelTypeId.
public void setClassName(String v)
     Set the value of className implementing this channel.
public void setDescription(String v)
     Set the value of description.
public void setEditable(boolean v)
     Specify whether the channel is editable.
public void setFunctionalName(String v)
     Set the value of functionalName.
public void setHasAbout(boolean v)
     Specify whether the channel supports "about" action.
public void setHasHelp(boolean v)
     Specify whether the channel supports "help" action.
public void setIsSecure(boolean v)
     Set the value of secure.
public void setParameterOverride(String parameterName, boolean canOverride)
     Set parameter override flag.
public String setParameterValue(String parameterName, String parameterValue)
     Set a channel parameter value.
public void setTimeout(long v)
     Set the value of channel timeout in milliseconds.
public void setTitle(String v)
     Set the value of title.

Method Detail
canOverrideParameter
public boolean canOverrideParameter(String parameterName)(Code)
Determine if a given parameter can be overriden by the user. (defaults to true)
Parameters:
  parameterName - a String value a boolean value

clearParameters
public void clearParameters()(Code)
Clears all of the channel parameters.

containsParameter
public boolean containsParameter(String parameterName)(Code)
Determines if a certain parameter name is present.
Parameters:
  parameterName - a String parameter name. a boolean value

getChannelPublishId
public String getChannelPublishId()(Code)
Get the value of channelPublishId for this channel. value of channelPublishId.

getChannelSubscribeId
public String getChannelSubscribeId()(Code)
Get the value of channelSubscribeId. value of channelSubscribeId.

getChannelTypeId
public String getChannelTypeId()(Code)
Get the value of channelTypeId. value of channelTypeId.

getClassName
public String getClassName()(Code)
Get the value of className implementing this channel. value of className.

getDescription
public String getDescription()(Code)
Get the value of description. value of description.

getFunctionalName
public String getFunctionalName()(Code)
Get the value of functionalName. value of functionalName.

getParameterMap
public Map getParameterMap()(Code)
Returns an entire mapping of parameters. a Map of parameter names on parameter values.

getParameterNames
public Enumeration getParameterNames()(Code)
Obtain a set of channel parameter names. a Set of String parameter names.

getParameterOverrideValue
public boolean getParameterOverrideValue(String parameterName)(Code)
Obtain a channel parameter override value.
Parameters:
  parameterName - a String value a boolean value

getParameterValue
public String getParameterValue(String parameterName)(Code)
Obtain a channel parameter value.
Parameters:
  parameterName - a String value a String value

getParameterValues
public Collection getParameterValues()(Code)
Obtain values of all existing channel parameters. a Collection of String parameter values.

getTimeout
public long getTimeout()(Code)
Get the value of channel timeout in milliseconds. value of timeout.

getTitle
public String getTitle()(Code)
Get the value of title. value of title.

getXML
public Element getXML(Document root)(Code)
Creates a org.w3c.dom.Element representation of the current channel.
Parameters:
  root - a Document for which the Element should be created. a Node value

hasAbout
public boolean hasAbout()(Code)
Determine if the channel supports "about" action. value of hasAbout.

hasHelp
public boolean hasHelp()(Code)
Determine if the channel supports "help" action. value of hasHelp.

hasParameters
public boolean hasParameters()(Code)
Determine if the channel has any parameters. a boolean value

isEditable
public boolean isEditable()(Code)
Determine if the channel is editable. value of editable.

isPortlet
public boolean isPortlet()(Code)
Return true if the described channel is a JSR-168 portlet, false otherwise. true if the described channel is a JSR-168 portlet, false otherwise

isSecure
public boolean isSecure()(Code)
Get the value of secure. value of secure.

numberOfParameters
public int numberOfParameters()(Code)
Determines the number of existing channel parameters. an int value

remove
public String remove(String parameterName)(Code)
Remove a channel parameter.
Parameters:
  parameterName - a String parameter name. an old parameter value.

resetParameter
public void resetParameter(String parameterName) throws PortalException(Code)
Reset a channel parameter value. Since parameter changes by channels can be persisted if override is allowed this method enables resetting to the original value or, if the parameter is ad-hoc meaning that the channel definition does not provide a value for this parameter, then the parameter value is removed.
Parameters:
  parameterName - a String value
throws:
  PortalException -

setChannelPublishId
public void setChannelPublishId(String v)(Code)
Set the value of channelPublishId for this channel.
Parameters:
  v - Value to assign to channelPublishId.

setChannelSubscribeId
public void setChannelSubscribeId(String v)(Code)
Set the value of channelSubscribeId.
Parameters:
  v - Value to assign to channelSubscribeId.

setChannelTypeId
public void setChannelTypeId(String v)(Code)
Set the value of channelTypeId.
Parameters:
  v - Value to assign to channelTypeId.

setClassName
public void setClassName(String v)(Code)
Set the value of className implementing this channel.
Parameters:
  v - Value to assign to className.

setDescription
public void setDescription(String v)(Code)
Set the value of description.
Parameters:
  v - Value to assign to description.

setEditable
public void setEditable(boolean v)(Code)
Specify whether the channel is editable.
Parameters:
  v - Value to assign to editable.

setFunctionalName
public void setFunctionalName(String v)(Code)
Set the value of functionalName.
Parameters:
  v - Value to assign to functionalName.

setHasAbout
public void setHasAbout(boolean v)(Code)
Specify whether the channel supports "about" action.
Parameters:
  v - Value to assign to hasAbout.

setHasHelp
public void setHasHelp(boolean v)(Code)
Specify whether the channel supports "help" action.
Parameters:
  v - Value to assign to hasHelp.

setIsSecure
public void setIsSecure(boolean v)(Code)
Set the value of secure.
Parameters:
  v - Value to assign to secure.

setParameterOverride
public void setParameterOverride(String parameterName, boolean canOverride)(Code)
Set parameter override flag.
Parameters:
  parameterName - a String value
Parameters:
  canOverride - a boolean flag.

setParameterValue
public String setParameterValue(String parameterName, String parameterValue)(Code)
Set a channel parameter value.
Parameters:
  parameterValue - a String value
Parameters:
  parameterName - a String value a String value that was set.

setTimeout
public void setTimeout(long v)(Code)
Set the value of channel timeout in milliseconds.
Parameters:
  v - Value to assign to timeout.

setTitle
public void setTitle(String v)(Code)
Set the value of title.
Parameters:
  v - Value to assign to title.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.