org.springframework.extensions.surf.types

Interface Page

All Superinterfaces:

ModelObject, Serializable

All Known Implementing Classes:

PageImpl

public interface Page
extends ModelObject

Interface for a Page object type

Author:

muzquiano

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_FORMAT_ID
static String	DEFAULT_PAGE_TYPE_ID
static String	PROP_AUTHENTICATION
static String	PROP_PAGE_TYPE_ID
static String	PROP_TEMPLATE_INSTANCE
static String	TYPE_ID

Fields inherited from interface org.springframework.extensions.surf.ModelObject

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.webscripts.Description.RequiredAuthentication	getAuthentication()
Page[]	getChildPages(RequestContext context) Gets the child pages.
PageType	getPageType(RequestContext context) Gets the page type.
String	getPageTypeId() Gets the page type id.
TemplateInstance	getTemplate(RequestContext context) Gets the template.
TemplateInstance	getTemplate(RequestContext context, String formatId) Gets the template.
String	getTemplateId() Gets the template id.
String	getTemplateId(String formatId) Gets the template id.
Map<String,TemplateInstance>	getTemplates(RequestContext context) Gets the templates.
void	removeTemplateId(String formatId) Removes the template id.
void	setAuthentication(String authentication)
void	setPageTypeId(String pageTypeId) Sets the page type id.
void	setTemplateId(String templateId) Sets the template id.
void	setTemplateId(String templateId, String formatId) Sets the template id.

Methods inherited from interface org.springframework.extensions.surf.ModelObject

getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getStoragePath, getTitle, getTitleId, getTypeId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Field Detail

TYPE_ID

static final String TYPE_ID

See Also:

Constant Field Values

PROP_TEMPLATE_INSTANCE

static final String PROP_TEMPLATE_INSTANCE

See Also:

Constant Field Values

ATTR_FORMAT_ID

static final String ATTR_FORMAT_ID

See Also:

Constant Field Values

PROP_PAGE_TYPE_ID

static final String PROP_PAGE_TYPE_ID

See Also:

Constant Field Values

PROP_AUTHENTICATION

static final String PROP_AUTHENTICATION

See Also:

Constant Field Values

DEFAULT_PAGE_TYPE_ID

static final String DEFAULT_PAGE_TYPE_ID

See Also:

Constant Field Values

Method Detail

getTemplateId

String getTemplateId()

Gets the template id.

Returns:

the template id

getTemplateId

String getTemplateId(String formatId)

Gets the template id.

Parameters:

formatId - the format id

Returns:

the template id

setTemplateId

void setTemplateId(String templateId)

Sets the template id.

Parameters:

templateId - the new template id

setTemplateId

void setTemplateId(String templateId,
                 String formatId)

Sets the template id.

Parameters:

templateId - the template id

formatId - the format id

removeTemplateId

void removeTemplateId(String formatId)

Removes the template id.

Parameters:

formatId - the format id

getTemplates

Map<String,TemplateInstance> getTemplates(RequestContext context)

Gets the templates.

Parameters:

context - the context

Returns:

the templates

getTemplate

TemplateInstance getTemplate(RequestContext context)

Gets the template.

Parameters:

context - the context

Returns:

the template

getTemplate

TemplateInstance getTemplate(RequestContext context,
                           String formatId)

Gets the template.

Parameters:

context - the context

formatId - the format id

Returns:

the template

getChildPages

Page[] getChildPages(RequestContext context)

Gets the child pages.

Parameters:

context - the context

Returns:

the child pages

getPageTypeId

String getPageTypeId()

Gets the page type id.

Returns:

the page type id

setPageTypeId

void setPageTypeId(String pageTypeId)

Sets the page type id.

Parameters:

pageTypeId - the new page type id

getAuthentication

org.springframework.extensions.webscripts.Description.RequiredAuthentication getAuthentication()

Returns:

the Authentication required for this page

setAuthentication

void setAuthentication(String authentication)

Parameters:

authentication - the authentication level to set

getPageType

PageType getPageType(RequestContext context)

Gets the page type.

Parameters:

context - the context

Returns:

the page type