org.apache.lenya.cms.publication
Interface Area

public interface Area

An area.

Method Summary

boolean	contains(java.lang.String uuid, java.lang.String language) Checks if a document is contained.
Document	getDocument(java.lang.String uuid, java.lang.String language)
Document[]	getDocuments()
java.lang.String	getName()
Publication	getPublication()
SiteStructure	getSite()

Method Detail

getName

java.lang.String getName()

Returns:

The name of the area ("authoring", "live", etc.).

getPublication

Publication getPublication()

Returns:

The publication the area belongs to.

getSite

SiteStructure getSite()

Returns:

The site structure of the area.

getDocument

Document getDocument(java.lang.String uuid,
                     java.lang.String language)
                     throws PublicationException

Parameters:

uuid - The UUID.

language - The language.

Returns:

A document.

Throws:

PublicationException - if the document is not contained.

contains

boolean contains(java.lang.String uuid,
                 java.lang.String language)

Checks if a document is contained.

Parameters:

uuid - The UUID.

language - The language.

Returns:

A boolean value.

getDocuments

Document[] getDocuments()

Returns:

All documents in this area.