This project has retired. For details please refer to its Attic page.

org.apache.jetspeed.om.folder
Interface MenuOptionsDefinition

public interface MenuOptionsDefinition

This interface describes the object used to define portal site menu options.

Version:

$Id: MenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $

Author:

Randy Watler

Field Summary

static String

ANY_PROFILE_LOCATOR ANY_PROFILE_LOCATOR - wildcard value for profile locator names

Method Summary

int	getDepth() getDepth - get depth of inclusion for folder options
String	getOptions() getOptions - get comma separated menu options
String	getOrder() getOrder - get comma separated regexp ordering patterns
String	getProfile() getProfile - get profile locator used to filter options
String	getSkin() getSkin - get skin name for options
boolean	isPaths() isPaths - get generate ordered path options
boolean	isRegexp() isRegexp - get regexp flag for interpreting options
void	setDepth(int depth) setDepth - set depth of inclusion for folder options
void	setOptions(String options) setOptions - set comma separated menu options
void	setOrder(String order) setOrder - set comma separated regexp ordering patterns
void	setPaths(boolean paths) setPaths - set generate ordered path options
void	setProfile(String locatorName) setProfile - set profile locator used to filter options
void	setRegexp(boolean regexp) setRegexp - set regexp flag for interpreting options
void	setSkin(String name) setSkin - set skin name for options

Field Detail

ANY_PROFILE_LOCATOR

static final String ANY_PROFILE_LOCATOR

ANY_PROFILE_LOCATOR - wildcard value for profile locator names

See Also:

Constant Field Values

Method Detail

getOptions

String getOptions()

getOptions - get comma separated menu options

Returns:

option paths specification

setOptions

void setOptions(String options)

setOptions - set comma separated menu options

Parameters:

options - option paths specification

getDepth

int getDepth()

getDepth - get depth of inclusion for folder options

Returns:

inclusion depth

setDepth

void setDepth(int depth)

setDepth - set depth of inclusion for folder options

Parameters:

depth - inclusion depth

isPaths

boolean isPaths()

isPaths - get generate ordered path options

Returns:

paths options flag

setPaths

void setPaths(boolean paths)

setPaths - set generate ordered path options

Parameters:

paths - paths options flag

isRegexp

boolean isRegexp()

isRegexp - get regexp flag for interpreting options

Returns:

regexp flag

setRegexp

void setRegexp(boolean regexp)

setRegexp - set regexp flag for interpreting options

Parameters:

regexp - regexp flag

getProfile

String getProfile()

getProfile - get profile locator used to filter options

Returns:

profile locator name

setProfile

void setProfile(String locatorName)

setProfile - set profile locator used to filter options

Parameters:

locatorName - profile locator name

getOrder

String getOrder()

getOrder - get comma separated regexp ordering patterns

Returns:

ordering patterns list

setOrder

void setOrder(String order)

setOrder - set comma separated regexp ordering patterns

Parameters:

order - ordering patterns list

getSkin

String getSkin()

getSkin - get skin name for options

Returns:

skin name

setSkin

void setSkin(String name)

setSkin - set skin name for options

Parameters:

name - skin name