Blueprint ("The Adobe AEM Quickstart and Web Application.")

All Superinterfaces:

Adaptable, JSONItem, LabeledResource
```
public interface Blueprint
extends 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

All Methods Instance Methods Abstract Methods Deprecated Methods
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.commons.LabeledResource
getDescription, getName, getPath, getTitle

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

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.
    
    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.
    
    Returns:
    
    the path to a thumbnail or null
  - getRanking
```
java.lang.Long getRanking()
```
    Returns the ranking in the template list.
    
    Returns:
    
    the ranking
  - getSitePath
```
java.lang.String getSitePath()
```
    Returns the site path of the 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
  - getContentResource
```
@Deprecated
Resource getContentResource()
```
    Deprecated. since 5.4, access page instead
  - getContentResource
```
@Deprecated
Resource getContentResource(java.lang.String relPath)
```
    Deprecated. since 5.4, access page instead
  - listChildren
```
@Deprecated
java.util.Iterator<Page> listChildren()
```
    Deprecated. since 5.4, access page instead
  - listChildren
```
@Deprecated
java.util.Iterator<Page> listChildren(Filter<Page> filter)
```
    Deprecated. since 5.4, access page instead
  - hasChild
```
@Deprecated
boolean hasChild(java.lang.String name)
```
    Deprecated. since 5.4, access page instead
  - getDepth
```
@Deprecated
int getDepth()
```
    Deprecated. since 5.4, access page instead
  - getParent
```
@Deprecated
Page getParent()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getParent
```
@Deprecated
Page getParent(int level)
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getAbsoluteParent
```
@Deprecated
Page getAbsoluteParent(int level)
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getProperties
```
@Deprecated
ValueMap getProperties()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getProperties
```
@Deprecated
ValueMap getProperties(java.lang.String relPath)
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getPageTitle
```
@Deprecated
java.lang.String getPageTitle()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getNavigationTitle
```
@Deprecated
java.lang.String getNavigationTitle()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - isHideInNav
```
@Deprecated
boolean isHideInNav()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - hasContent
```
@Deprecated
boolean hasContent()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - isValid
```
@Deprecated
boolean isValid()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - timeUntilValid
```
@Deprecated
long timeUntilValid()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getOnTime
```
@Deprecated
java.util.Calendar getOnTime()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getOffTime
```
@Deprecated
java.util.Calendar getOffTime()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getLastModifiedBy
```
@Deprecated
java.lang.String getLastModifiedBy()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getLastModified
```
@Deprecated
java.util.Calendar getLastModified()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getVanityUrl
```
@Deprecated
java.lang.String getVanityUrl()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getTags
```
@Deprecated
Tag[] getTags()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - lock
```
@Deprecated
void lock()
               throws WCMException
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
    
    Throws:
    
    WCMException
  - isLocked
```
@Deprecated
boolean isLocked()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getLockOwner
```
@Deprecated
java.lang.String getLockOwner()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - canUnlock
```
@Deprecated
boolean canUnlock()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - unlock
```
@Deprecated
void unlock()
                 throws WCMException
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
    
    Throws:
    
    WCMException
  - getTemplate
```
@Deprecated
Template getTemplate()
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page
  - getLanguage
```
@Deprecated
java.util.Locale getLanguage(boolean ignoreContent)
```
    Deprecated. since 5.4, Page Blueprint is not required to be a Page

Interface Blueprint

Method Summary

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

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

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

Method Detail

getIconPath

getThumbnailPath

getRanking

getSitePath

getBlueprintRolloutConfig

getPageManager

getContentResource

getContentResource

listChildren

listChildren

hasChild

getDepth

getParent

getParent

getAbsoluteParent

getProperties

getProperties

getPageTitle

getNavigationTitle

isHideInNav

hasContent

isValid

timeUntilValid

getOnTime

getOffTime

getLastModifiedBy

getLastModified

getVanityUrl

getTags

lock

isLocked

getLockOwner

canUnlock

unlock

getTemplate

getLanguage