Package com.day.cq.wcm.msm.api
Interface BlueprintManager
- 
public interface BlueprintManagerProvides a Service to access Blueprints. The Object is bound to a ResourceResolver, it my be accesses via the ManagersBlueprintManagerFactory.getBlueprintManager(org.apache.sling.api.resource.ResourceResolver)Factory Method}- Since:
 - 5.4
 - See Also:
 Blueprint,BlueprintManagerFactory
 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BlueprintgetBlueprint(java.lang.String absPath)Access the Blueprint that is stored at the given Path argument.
If a Blueprint can be accessed, theBlueprint's pathmust be the same as the argument.java.util.Collection<Blueprint>getBlueprints()BlueprintgetContainingBlueprint(java.lang.String path)Try to access a Blueprint for a given Resource
A Blueprint is found if the Resource is equal or a descendant of theBlueprint.getSitePath()Blueprint's SitePath}. 
 - 
 
- 
- 
Method Detail
- 
getBlueprints
java.util.Collection<Blueprint> getBlueprints() throws WCMException
- Returns:
 - all Blueprints available int the System
 - Throws:
 WCMException- in case of error
 
- 
getBlueprint
Blueprint getBlueprint(java.lang.String absPath) throws WCMException
Access the Blueprint that is stored at the given Path argument.
If a Blueprint can be accessed, theBlueprint's pathmust be the same as the argument.- Parameters:
 absPath- the absolute Path the blueprint should be stored at- Returns:
 - the Blueprint for the given Path or 
nullif Resource at Path is not a Blueprint - Throws:
 WCMException- in case of error- See Also:
 Page.getPath()
 
- 
getContainingBlueprint
Blueprint getContainingBlueprint(java.lang.String path) throws WCMException
Try to access a Blueprint for a given Resource
A Blueprint is found if the Resource is equal or a descendant of theBlueprint.getSitePath()Blueprint's SitePath}.- Parameters:
 path- to find the Blueprint for- Returns:
 - the Blueprint containing the path or 
nullif no Blueprint is defined for the path - Throws:
 WCMException- in case of error
 
 - 
 
 -