public interface Blueprint extends Blueprint, LabeledResource, Adaptable, JSONItem
actions
that should be applied upon a
rollout of a Page from the Site template.
Note: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
|
getDeleted, getDeletedBy, getLanguage, getName, getPath, getTitle, listChildren
getDescription
java.lang.String getIconPath()
null
if
this template does not provide an icon.getIconPath
in interface Blueprint
null
java.lang.String getThumbnailPath()
null
if the template does not provide a thumbnail.getThumbnailPath
in interface Blueprint
null
java.lang.Long getRanking()
getRanking
in interface Blueprint
java.lang.String getSitePath()
getSitePath
in interface Blueprint
java.util.List<RolloutConfig> getBlueprintRolloutConfig(java.lang.String relPath, boolean exact) throws WCMException
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.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 returnedRolloutConfigs
for the given Path or null
if noneWCMException
- in case of error accessing the Blueprint@Deprecated PageManager getPageManager()
Page
getPageManager
in interface Page
@Deprecated Resource getContentResource()
Page
null
if
the page has no content.getContentResource
in interface Page
null
Page.hasContent()
@Deprecated Resource getContentResource(java.lang.String relPath)
Page
null
if the respective resource does not exist. If relPath
is
null
or an empty string the toplevel content resource is
returned.getContentResource
in interface Page
relPath
- relative path into contentnull
@Deprecated java.util.Iterator<Page> listChildren()
Page
listChildren
in interface Page
@Deprecated java.util.Iterator<Page> listChildren(Filter<Page> filter)
Page
listChildren
in interface Page
filter
- for iteration. may be null
@Deprecated boolean hasChild(java.lang.String name)
Page
name
@Deprecated int getDepth()
Page
Page.getParent()
calls would be needed to reach the root node.@Deprecated Page getParent()
Page
@Deprecated Page getParent(int level)
Page
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 |
@Deprecated Page getAbsoluteParent(int level)
Page
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 |
getAbsoluteParent
in interface Page
level
- hierarchy level of the parent page to retrievenull
@Deprecated ValueMap getProperties()
Page
getProperties
in interface Page
Page.hasContent()
@Deprecated ValueMap getProperties(java.lang.String relPath)
Page
null
is returned. If relPath
is
null
or an empty string the toplevel content properties are
returned.getProperties
in interface Page
relPath
- relative path to the contentnull
@Deprecated java.lang.String getPageTitle()
Page
null
if none defined.getPageTitle
in interface Page
@Deprecated java.lang.String getNavigationTitle()
Page
null
if none
defined. The navigation title is usually used when drawing navigation
links.getNavigationTitle
in interface Page
@Deprecated boolean isHideInNav()
Page
false
if non defined.
The hideInNav flag is usually used to control if a page should be
displayed in a navigation.isHideInNav
in interface Page
@Deprecated boolean hasContent()
Page
hasContent
in interface Page
true
if the page has content;
false
otherwise.@Deprecated boolean isValid()
Page
@Deprecated long timeUntilValid()
Page
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.timeUntilValid
in interface Page
@Deprecated java.util.Calendar getOnTime()
Page
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.@Deprecated java.util.Calendar getOffTime()
Page
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.getOffTime
in interface Page
null
@Deprecated java.lang.String getLastModifiedBy()
Page
null
if this
information is not available or if the page has no content.getLastModifiedBy
in interface Page
null
@Deprecated java.util.Calendar getLastModified()
Page
null
if
this information is not available or if the page has no content.getLastModified
in interface Page
null
@Deprecated java.lang.String getVanityUrl()
Page
getVanityUrl
in interface Page
null
@Deprecated Tag[] getTags()
Page
@Deprecated void lock() throws WCMException
Page
lock
in interface Page
WCMException
- if an error during this operation occurs.@Deprecated boolean isLocked()
Page
@Deprecated java.lang.String getLockOwner()
Page
getLockOwner
in interface Page
null
if the page is not locked@Deprecated boolean canUnlock()
Page
@Deprecated void unlock() throws WCMException
Page
unlock
in interface Page
WCMException
- if an error during this operation occurs.@Deprecated Template getTemplate()
Page
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).getTemplate
in interface Page
null
@Deprecated java.util.Locale getLanguage(boolean ignoreContent)
Page
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.getLanguage
in interface Page
ignoreContent
- if true
only the path is used to
determine the language.Copyright © 2010 - 2020 Adobe. All Rights Reserved