Interface SitesService
-
- All Known Implementing Classes:
SitesServiceImpl
,SitesServiceInternalImpl
public interface SitesService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearPublishingLock(String siteId)
Clear publishing lock for siteList<org.craftercms.commons.plugin.model.PluginDescriptor>
getAvailableBlueprints()
Get list of available blueprintsorg.craftercms.commons.plugin.model.PluginDescriptor
getBlueprintDescriptor(String id)
Get the blueprint descriptor from the global repoString
getBlueprintLocation(String blueprintId)
Get blueprint locationPublishStatus
getPublishingStatus(String siteId)
Get publishing status for siteorg.craftercms.commons.plugin.model.PluginDescriptor
getSiteBlueprintDescriptor(String id)
Get the blueprint descriptor from a site repovoid
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:
- list 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, InvalidParametersException
Updates the name and description for the given site- Parameters:
siteId
- the id of the sitename
- the name of the sitedescription
- the description of the site- Throws:
SiteNotFoundException
- if the site doesn't existSiteAlreadyExistsException
InvalidParametersException
-
getPublishingStatus
PublishStatus getPublishingStatus(String siteId) throws SiteNotFoundException
Get publishing status for site- Parameters:
siteId
- site identifier- Returns:
- publishing status
- Throws:
SiteNotFoundException
-
clearPublishingLock
void clearPublishingLock(String siteId) throws SiteNotFoundException
Clear publishing lock for site- Parameters:
siteId
- site identifier- Throws:
SiteNotFoundException
-
-