org.jboss.shrinkwrap.descriptor.api.portletapp20

Interface PortletPreferencesType<T>

All Superinterfaces:

Child<T>, PortletPortletPreferencesCommonType<T,PortletPreferencesType<T>,PreferenceType<PortletPreferencesType<T>>>

public interface PortletPreferencesType<T>
extends Child<T>, PortletPortletPreferencesCommonType<T,PortletPreferencesType<T>,PreferenceType<PortletPreferencesType<T>>>

This interface defines the contract for the portlet-preferencesType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
PreferenceType<PortletPreferencesType<T>>	createPreference() Creates a new preference element
List<PreferenceType<PortletPreferencesType<T>>>	getAllPreference() Returns all preference elements
String	getId() Returns the id attribute
PreferenceType<PortletPreferencesType<T>>	getOrCreatePreference() If not already created, a new preference element will be created and returned.
String	getPreferencesValidator() Returns the preferences-validator element
PortletPreferencesType<T>	id(String id) Sets the id attribute
PortletPreferencesType<T>	preferencesValidator(String preferencesValidator) Sets the preferences-validator element
PortletPreferencesType<T>	removeAllPreference() Removes all preference elements
PortletPreferencesType<T>	removeId() Removes the id attribute
PortletPreferencesType<T>	removePreferencesValidator() Removes the preferences-validator element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

getOrCreatePreference

PreferenceType<PortletPreferencesType<T>> getOrCreatePreference()

If not already created, a new preference element will be created and returned. Otherwise, the first existing preference element will be returned.

Returns:

the instance defined for the element preference

createPreference

PreferenceType<PortletPreferencesType<T>> createPreference()

Creates a new preference element

Returns:

the new created instance of PreferenceType>

getAllPreference

List<PreferenceType<PortletPreferencesType<T>>> getAllPreference()

Returns all preference elements

Returns:

list of preference

removeAllPreference

PortletPreferencesType<T> removeAllPreference()

Removes all preference elements

Returns:

the current instance of PreferenceType>

preferencesValidator

PortletPreferencesType<T> preferencesValidator(String preferencesValidator)

Sets the preferences-validator element

Parameters:

preferencesValidator - the value for the element preferences-validator

Returns:

the current instance of PortletPreferencesType

getPreferencesValidator

String getPreferencesValidator()

Returns the preferences-validator element

Returns:

the node defined for the element preferences-validator

removePreferencesValidator

PortletPreferencesType<T> removePreferencesValidator()

Removes the preferences-validator element

Returns:

the current instance of PortletPreferencesType

id

PortletPreferencesType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of PortletPreferencesType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

PortletPreferencesType<T> removeId()

Removes the id attribute

Returns:

the current instance of PortletPreferencesType