org.nuxeo.webengine.sites

Class AbstractSiteDocumentObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.core.rest.DocumentObject

org.nuxeo.webengine.sites.AbstractSiteDocumentObject

All Implemented Interfaces:

Resource, Adaptable

Direct Known Subclasses:

Page, Site

public abstract class AbstractSiteDocumentObject
extends DocumentObject

The basic web object implementation. It holds the web object back methods.

Author:

rux

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLASH_WELCOME_MEDIA
static int	IMAGE_WELCOME_MEDIA
static int	NO_WELCOME_MEDIA

Constructor Summary

Constructors

Constructor and Description
AbstractSiteDocumentObject()

Method Summary

Methods

Modifier and Type	Method and Description
Object	_getSearchParameters() JAX-RS specs doesn't allow multiple REST designator on a single method so we need to use another method to do a POST.
Object	createWebPage() Creates a new web page object.
Response	doDelete()
Object	doGet() Executes the GET requests on the current web object
Object	getHomePagePath() Method used to retrieve the path to the current web container.
Response	getLogo() Retrieves the logo of the current web object.
Object	getSearchParameters() Method called before a search operation is made for the context of the current web object.
Response	getWelcomeMedia() Returns the welcome media of the current web object.
int	getWelcomeMediaHeight()
int	getWelcomeMediaIsImage()
int	getWelcomeMediaWidth()
Response	remove() Method used to delete pages in the current container
Resource	traverse(String path)

Methods inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doHead, doPost, doPut, getAdapter, getCoreSession, getDelete, getDocument, getPut, getTitle, initialize, newDocument, newDocument, newDocument, search

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_WELCOME_MEDIA

public static final int NO_WELCOME_MEDIA

See Also:

Constant Field Values

IMAGE_WELCOME_MEDIA

public static final int IMAGE_WELCOME_MEDIA

See Also:

Constant Field Values

FLASH_WELCOME_MEDIA

public static final int FLASH_WELCOME_MEDIA

See Also:

Constant Field Values

Constructor Detail

AbstractSiteDocumentObject

public AbstractSiteDocumentObject()

Method Detail

doGet

public Object doGet()

Executes the GET requests on the current web object

Overrides:

doGet in class DocumentObject

getLogo

public Response getLogo()

Retrieves the logo of the current web object.

getWelcomeMedia

public Response getWelcomeMedia()

Returns the welcome media of the current web object.

getWelcomeMediaWidth

public int getWelcomeMediaWidth()

getWelcomeMediaHeight

public int getWelcomeMediaHeight()

getWelcomeMediaIsImage

public int getWelcomeMediaIsImage()
                           throws Exception

Throws:

Exception

getSearchParameters

public Object getSearchParameters()

Method called before a search operation is made for the context of the current web object.

_getSearchParameters

public Object _getSearchParameters()

JAX-RS specs doesn't allow multiple REST designator on a single method so we need to use another method to do a POST.

traverse

public Resource traverse(String path)

Overrides:

traverse in class DocumentObject

createWebPage

public Object createWebPage()

Creates a new web page object.

getHomePagePath

public Object getHomePagePath()

Method used to retrieve the path to the current web container.

Returns:

the path to the current web container

remove

public Response remove()

Method used to delete pages in the current container

Returns:

the path to the current web container

doDelete

public Response doDelete()

Overrides:

doDelete in class DocumentObject