com.day.cq.wcm.msm.api

Interface Blueprint

All Superinterfaces:

Adaptable, Blueprint, JSONItem, LabeledResource, Page

public interface Blueprint
extends Blueprint, LabeledResource, Adaptable, JSONItem

Defines the interface of a CQ MSM Blueprint. A Blueprint is a Template for a Site, it defines the Pages that are part of a Site and the actions that should be applied upon a rollout of a Page from the Site template. Note:
The support for the Page-Api is deprecated since 5.4.0 The Blueprint is no longer required to be a Page.

Method Summary

Modifier and Type	Method and Description
boolean	canUnlock() Deprecated. since 5.4, Page Blueprint is not required to be a Page
Page	getAbsoluteParent(int level) Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.util.List<RolloutConfig>	getBlueprintRolloutConfig(java.lang.String relPath, boolean exact) Access the Configuration defined for a Page that is part of this Blueprint.
Resource	getContentResource() Deprecated. since 5.4, access page instead
Resource	getContentResource(java.lang.String relPath) Deprecated. since 5.4, access page instead
int	getDepth() Deprecated. since 5.4, access page instead
java.lang.String	getIconPath() Returns the path to an icon for this template or null if this template does not provide an icon.
java.util.Locale	getLanguage(boolean ignoreContent) Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.util.Calendar	getLastModified() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.lang.String	getLastModifiedBy() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.lang.String	getLockOwner() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.lang.String	getNavigationTitle() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.util.Calendar	getOffTime() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.util.Calendar	getOnTime() Deprecated. since 5.4, Page Blueprint is not required to be a Page
PageManager	getPageManager() Deprecated. since 5.4, access page instead
java.lang.String	getPageTitle() Deprecated. since 5.4, Page Blueprint is not required to be a Page
Page	getParent() Deprecated. since 5.4, Page Blueprint is not required to be a Page
Page	getParent(int level) Deprecated. since 5.4, Page Blueprint is not required to be a Page
ValueMap	getProperties() Deprecated. since 5.4, Page Blueprint is not required to be a Page
ValueMap	getProperties(java.lang.String relPath) Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.lang.Long	getRanking() Returns the ranking in the template list.
java.lang.String	getSitePath() Returns the site path of the blueprint
Tag[]	getTags() Deprecated. since 5.4, Page Blueprint is not required to be a Page
Template	getTemplate() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.lang.String	getThumbnailPath() Returns the path to a thumbnail for this template or null if the template does not provide a thumbnail.
java.lang.String	getVanityUrl() Deprecated. since 5.4, Page Blueprint is not required to be a Page
boolean	hasChild(java.lang.String name) Deprecated. since 5.4, access page instead
boolean	hasContent() Deprecated. since 5.4, Page Blueprint is not required to be a Page
boolean	isHideInNav() Deprecated. since 5.4, Page Blueprint is not required to be a Page
boolean	isLocked() Deprecated. since 5.4, Page Blueprint is not required to be a Page
boolean	isValid() Deprecated. since 5.4, Page Blueprint is not required to be a Page
java.util.Iterator<Page>	listChildren() Deprecated. since 5.4, access page instead
java.util.Iterator<Page>	listChildren(Filter<Page> filter) Deprecated. since 5.4, access page instead
void	lock() Deprecated. since 5.4, Page Blueprint is not required to be a Page
long	timeUntilValid() Deprecated. since 5.4, Page Blueprint is not required to be a Page
void	unlock() Deprecated. since 5.4, Page Blueprint is not required to be a Page

Methods inherited from interface com.day.cq.wcm.api.Page

getDeleted, getDeletedBy, getLanguage, getName, getPath, getTitle, listChildren

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Methods inherited from interface com.day.cq.commons.LabeledResource

getDescription

Methods inherited from interface com.day.cq.commons.JSONItem

write

Method Detail

getIconPath

java.lang.String getIconPath()

Returns the path to an icon for this template or null if this template does not provide an icon.

Specified by:

getIconPath in interface Blueprint

Returns:

the path to an icon or null

getThumbnailPath

java.lang.String getThumbnailPath()

Returns the path to a thumbnail for this template or null if the template does not provide a thumbnail.

Specified by:

getThumbnailPath in interface Blueprint

Returns:

the path to a thumbnail or null

getRanking

java.lang.Long getRanking()

Returns the ranking in the template list.

Specified by:

getRanking in interface Blueprint

Returns:

the ranking

getSitePath

java.lang.String getSitePath()

Returns the site path of the blueprint

Specified by:

getSitePath in interface Blueprint

Returns:

path

getBlueprintRolloutConfig

java.util.List<RolloutConfig> getBlueprintRolloutConfig(java.lang.String relPath,
                                                        boolean exact)
                                                 throws WCMException

Access the Configuration defined for a Page that is part of this Blueprint. Give the path path to the Page you are interested in relative to the Blueprints root. If you want to access the configuration for the root itself pass null. The method returns the RolloutConfig that is effective on the given path. If you only want to access the Config that is specified on the given Page set the exact argument to be true.
Note: It is not required that the path exists.

Parameters:

relPath - a Path relative to the Blueprint's Site root.

exact - if false the configuration that is effective is returned, if true only the configuration configured at the path is returned

Returns:

List of RolloutConfigs for the given Path or null if none

Throws:

WCMException - in case of error accessing the Blueprint

Since:

5.4

getPageManager

@Deprecated
PageManager getPageManager()

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Convenience method that returns the manager of this page.

Specified by:

getPageManager in interface Page

Returns:

the page manager.

getContentResource

@Deprecated
Resource getContentResource()

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Returns the resource of the page's content or null if the page has no content.

Specified by:

getContentResource in interface Page

Returns:

resource or null

See Also:

Page.hasContent()

getContentResource

@Deprecated
Resource getContentResource(java.lang.String relPath)

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Returns the addressed resource of the page's content or null if the respective resource does not exist. If relPath is null or an empty string the toplevel content resource is returned.

Specified by:

getContentResource in interface Page

Parameters:

relPath - relative path into content

Returns:

resource or null

listChildren

@Deprecated
java.util.Iterator<Page> listChildren()

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Returns an iterator over all child resources that adapt to a page. other child resources are skipped.

Specified by:

listChildren in interface Page

Returns:

iterator of child pages

listChildren

@Deprecated
java.util.Iterator<Page> listChildren(Filter<Page> filter)

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Returns an iterator over all child resources that adapt to a page and that are included in the given filter. other child resources are skipped.

Specified by:

listChildren in interface Page

Parameters:

filter - for iteration. may be null

Returns:

iterator of child pages

hasChild

@Deprecated
boolean hasChild(java.lang.String name)

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Checks if the page has a child page named name

Specified by:

hasChild in interface Page

Parameters:

name - Name of the child

Returns:

true if the page has this child; false otherwise.

getDepth

@Deprecated
int getDepth()

Deprecated. since 5.4, access page instead

Description copied from interface: Page

Returns the hierarchical depth of the page. The depth is the number of Page.getParent() calls would be needed to reach the root node.

Specified by:

getDepth in interface Page

Returns:

the depth of the page.

getParent

@Deprecated
Page getParent()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the parent page if it's resource adapts to page.

Specified by:

getParent in interface Page

Returns:

the parent page or null

getParent

@Deprecated
Page getParent(int level)

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the relative parent page. If no page exists at that level, null is returned. Example (this path == /content/geometrixx/en/products)

 | level | returned                        |
 |     0 | /content/geometrixx/en/products |
 |     1 | /content/geometrixx/en          |
 |     2 | /content/geometrixx             |
 |     3 | /content                        |
 |     4 | null                            |
 

Specified by:

getParent in interface Page

Parameters:

level - hierarchy level of the parent page to retrieve

Returns:

the respective parent page or null

getAbsoluteParent

@Deprecated
Page getAbsoluteParent(int level)

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the absolute parent page. If no page exists at that level, null is returned. Example (this path == /content/geometrixx/en/products)

 | level | returned                        |
 |     0 | /content                        |
 |     1 | /content/geometrixx             |
 |     2 | /content/geometrixx/en          |
 |     3 | /content/geometrixx/en/products |
 |     4 | null                            |
 

Specified by:

getAbsoluteParent in interface Page

Parameters:

level - hierarchy level of the parent page to retrieve

Returns:

the respective parent page or null

getProperties

@Deprecated
ValueMap getProperties()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns a value map of the page content. If the page has no content an empty map is returned.

Specified by:

getProperties in interface Page

Returns:

a value map

See Also:

Page.hasContent()

getProperties

@Deprecated
ValueMap getProperties(java.lang.String relPath)

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns a value map of the address content of the page. If the addressed content does not exit, null is returned. If relPath is null or an empty string the toplevel content properties are returned.

Specified by:

getProperties in interface Page

Parameters:

relPath - relative path to the content

Returns:

a property map or null

getPageTitle

@Deprecated
java.lang.String getPageTitle()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the page title of the page or null if none defined.

Specified by:

getPageTitle in interface Page

Returns:

page title

getNavigationTitle

@Deprecated
java.lang.String getNavigationTitle()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the navigation title of the page or null if none defined. The navigation title is usually used when drawing navigation links.

Specified by:

getNavigationTitle in interface Page

Returns:

navigation title

isHideInNav

@Deprecated
boolean isHideInNav()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the "hideInNav" flag or false if non defined. The hideInNav flag is usually used to control if a page should be displayed in a navigation.

Specified by:

isHideInNav in interface Page

Returns:

hide in navigation flag

hasContent

@Deprecated
boolean hasContent()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Checks if the page has content attached.

Specified by:

hasContent in interface Page

Returns:

true if the page has content; false otherwise.

isValid

@Deprecated
boolean isValid()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Checks if the page is valid. It is valid if it has content and if the on-/off time range spans the current time.

Specified by:

isValid in interface Page

Returns:

true if the page is valid; false otherwise.

timeUntilValid

@Deprecated
long timeUntilValid()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the number of milliseconds when this page gets valid. If the page is already valid, 0 is returned. If the page is out dated, i.e. the offTime is in the past, a negative number is returned. If this page has no content Long.MIN_VALUE is returned.

Specified by:

timeUntilValid in interface Page

Returns:

milliseconds until page gets valid.

getOnTime

@Deprecated
java.util.Calendar getOnTime()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the onTime of the page. The onTime defines after which time it is valid. If no onTime is specified null is returned and the onTime is not respected in the Page.isValid() calculation.

Specified by:

getOnTime in interface Page

Returns:

onTime or null

getOffTime

@Deprecated
java.util.Calendar getOffTime()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the offTime of the page. The offTime defines before which time it is valid. If no offTime is specified null is returned and the offTime is not respected in the Page.isValid() calculation.

Specified by:

getOffTime in interface Page

Returns:

offTime or null

getLastModifiedBy

@Deprecated
java.lang.String getLastModifiedBy()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Return the user id that last modified the page or null if this information is not available or if the page has no content.

Specified by:

getLastModifiedBy in interface Page

Returns:

user id or null

getLastModified

@Deprecated
java.util.Calendar getLastModified()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the time when the page was last modified or null if this information is not available or if the page has no content.

Specified by:

getLastModified in interface Page

Returns:

last modification date or null

getVanityUrl

@Deprecated
java.lang.String getVanityUrl()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the vanity url.

Specified by:

getVanityUrl in interface Page

Returns:

The vanity url for this page or null

getTags

@Deprecated
Tag[] getTags()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the tags set on this page.

Specified by:

getTags in interface Page

Returns:

The tags set on this page.

lock

@Deprecated
void lock()
               throws WCMException

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Lock a page.

Specified by:

lock in interface Page

Throws:

WCMException - if an error during this operation occurs.

isLocked

@Deprecated
boolean isLocked()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Checks if this page is locked.

Specified by:

isLocked in interface Page

Returns:

true if this page is locked.

getLockOwner

@Deprecated
java.lang.String getLockOwner()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Return the lock owner of a page.

Specified by:

getLockOwner in interface Page

Returns:

lock owner; null if the page is not locked

canUnlock

@Deprecated
boolean canUnlock()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Return a flag indicating whether the current user can unlock a page.

Specified by:

canUnlock in interface Page

Returns:

true if the page can be unlocked; false otherwise

unlock

@Deprecated
void unlock()
                 throws WCMException

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Unlock a page.

Specified by:

unlock in interface Page

Throws:

WCMException - if an error during this operation occurs.

getTemplate

@Deprecated
Template getTemplate()

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the template that was used to create this page or null if none defined or the current user does not have read access to the template resource specified by the path in the page's template property. This is the case on publish instances using default ACL configuration (anonymous cannot read templates).

Specified by:

getTemplate in interface Page

Returns:

template or null

getLanguage

@Deprecated
java.util.Locale getLanguage(boolean ignoreContent)

Deprecated. since 5.4, Page Blueprint is not required to be a Page

Description copied from interface: Page

Returns the content language of the page. The language is usually defined on the page content via a jcr:language property containing the iso codes for language and country. if the property is not defined on this page all ancestors are search for such an property. If no language is defined at all, the path is examined if it contains a iso label. If no language can be found at all, the systems default locale is returned. If ignoreConent is true, only the names of the path is used to determine the language. Note that this has nothing to do with i18n of the cq5 itself.

Specified by:

getLanguage in interface Page

Parameters:

ignoreContent - if true only the path is used to determine the language.

Returns:

the language of the content