Package org.craftercms.studio.api.v2.service.site.internal

Interface SitesServiceInternal

All Known Implementing Classes:

SitesServiceInternalImpl

public interface SitesServiceInternal

Method Summary

Modifier and Type	Method	Description
void	clearPublishingLock(String siteId)	Clear publishing lock for site
List<org.craftercms.commons.plugin.model.PluginDescriptor>	getAvailableBlueprints()	Get list of available blueprints
org.craftercms.commons.plugin.model.PluginDescriptor	getBlueprintDescriptor(String id)	Get the blueprint descriptor from the global repo
String	getBlueprintLocation(String blueprintId)	Get blueprint location
PublishStatus	getPublishingStatus(String siteId)	Get publishing status for site
org.craftercms.commons.plugin.model.PluginDescriptor	getSiteBlueprintDescriptor(String id)	Get the blueprint descriptor from a site repo
void	updateSite(String siteId, String name, String description)	Updates the name and description for the given site

Method Detail

getAvailableBlueprints

List<org.craftercms.commons.plugin.model.PluginDescriptor> getAvailableBlueprints()

Get list of available blueprints

Returns:

lost of blueprints

getBlueprintDescriptor

org.craftercms.commons.plugin.model.PluginDescriptor getBlueprintDescriptor(String id)

Get the blueprint descriptor from the global repo

Parameters:

id - the id of the blueprint

Returns:

the descriptor object or null if not found

getBlueprintLocation

String getBlueprintLocation(String blueprintId)

Get blueprint location

Parameters:

blueprintId - blueprint id

Returns:

blueprint location

getSiteBlueprintDescriptor

org.craftercms.commons.plugin.model.PluginDescriptor getSiteBlueprintDescriptor(String id)

Get the blueprint descriptor from a site repo

Parameters:

id - the id of the site

Returns:

the blueprint object or null if not found

updateSite

void updateSite(String siteId,
                String name,
                String description)
         throws SiteNotFoundException,
                SiteAlreadyExistsException

Updates the name and description for the given site

Parameters:

siteId - the id of the site

name - the name of the site

description - the description of the site

Throws:

SiteNotFoundException - if the site doesn't exist

SiteAlreadyExistsException

getPublishingStatus

PublishStatus getPublishingStatus(String siteId)

Get publishing status for site

Parameters:

siteId - site identifier

Returns:

publishing status

clearPublishingLock

void clearPublishingLock(String siteId)

Clear publishing lock for site

Parameters:

siteId - site identifier