org.hippoecm.hst.configuration.channel
Interface Blueprint

All Known Implementing Classes:

BlueprintService

public interface Blueprint

A Blueprint is a "node" provided by the developers that is used to create and manage channels by the ChannelManager, and is defined by the node type hst:blueprint. Please see the hst.cnd for the node type definition.

Method Summary

Channel	createChannel() Creates a new channel with ID 'null'.
String	getContentRoot() The contentRoot must start with a / and be a valid jcr path
String	getDescription()
String	getId() Unique id for this blueprint
String	getName() The name of the blue print as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name.
boolean	hasContentPrototype() Does the blueprint have a content prototype.

Method Detail

getId

String getId()

Unique id for this blueprint

Returns:

The node name

getName

String getName()

The name of the blue print as provided in the property hst:name, if the property doesn't exist, the id (node name) is returned as the name.

Returns:

the name of the blue print.

getDescription

String getDescription()

Returns:

value of hst:description of the blueprint node, returns null if the property doesn't exist.

getContentRoot

String getContentRoot()

The contentRoot must start with a / and be a valid jcr path

Returns:

absolute path of the hst:contentRoot of the blueprint node, returns null if the property doesn't exist.

createChannel

Channel createChannel()

Creates a new channel with ID 'null'. The channel can be persisted using ChannelManager.persist(java.lang.String, org.hippoecm.hst.configuration.channel.Channel).

Returns:

a new, unpersisted channel

hasContentPrototype

boolean hasContentPrototype()

Does the blueprint have a content prototype. If so, it will be used to create a content structure.

Returns:

true if a prototype exists