org.apache.jetspeed.om.registry
Interface ParameterStyle

All Known Implementing Classes:

BaseParameterStyle

public interface ParameterStyle

Interface describing a parameter style for a portlet parameter.

Version:

$Id: ParameterStyle.java,v 1.1 2005/05/04 20:26:37 morciuch Exp $

Author:

Mark Orciuch

Method Summary

void	addOption(StyleOption option) Adds a new parameter style option
java.lang.String	getName() Returns parameter style name
StyleOption	getOption(java.lang.String name) Returns specific style option
java.util.Vector	getOptions() Returns a vector of parameter style options
java.lang.String	getTemplate() Returns optional parameter style template.
boolean	hasOption(java.lang.String name) Returns true if specific style option exists
void	removeOption(java.lang.String name) Remove specific parameter style option
void	setName(java.lang.String value) Sets the parameter style name
void	setOptions(java.util.Vector options) Sets parameter style options to a vector of options
void	setTemplate(java.lang.String value) Sets the optional parameter style template

Method Detail

getName

public java.lang.String getName()

Returns parameter style name

Returns:

parameter style name

setName

public void setName(java.lang.String value)

Sets the parameter style name

Parameters:

value -

getTemplate

public java.lang.String getTemplate()

Returns optional parameter style template. If not specified it is assumed to be [parameter style name].vm or .jsp depending on the style name.

Returns:

parameter style template

setTemplate

public void setTemplate(java.lang.String value)

Sets the optional parameter style template

Parameters:

value -

getOptions

public java.util.Vector getOptions()

Returns a vector of parameter style options

Returns:

parameter style options

getOption

public StyleOption getOption(java.lang.String name)

Returns specific style option

Parameters:

name -

Returns:

option

addOption

public void addOption(StyleOption option)

Adds a new parameter style option

Parameters:

option - to add

removeOption

public void removeOption(java.lang.String name)

Remove specific parameter style option

Parameters:

name - of style option

setOptions

public void setOptions(java.util.Vector options)

Sets parameter style options to a vector of options

Parameters:

options -

hasOption

public boolean hasOption(java.lang.String name)

Returns true if specific style option exists

Parameters:

name - of the option

Returns:

true or false