Package org.craftercms.studio.api.v2.service.dependency

Interface DependencyService

All Known Implementing Classes:

DependencyServiceImpl

public interface DependencyService

Method Summary

Modifier and Type	Method	Description
List<String>	getDependentItems(String siteId, String path)	Get list of paths of content items that are dependant on given path
List<String>	getDependentItems(String siteId, List<String> paths)	Get list of paths of content items that are dependant on given paths
List<String>	getHardDependencies(String site, String path)	Get a hard dependencies of a item.
List<String>	getHardDependencies(String site, List<String> paths)	Get a hard dependencies of a item.
List<String>	getSoftDependencies(String site, String path)	Get a soft dependencies of a item.
List<String>	getSoftDependencies(String site, List<String> paths)	Get a soft dependencies of a list of items.

Method Detail

getSoftDependencies

List<String> getSoftDependencies(String site,
                                 String path)
                          throws SiteNotFoundException,
                                 ServiceLayerException

Get a soft dependencies of a item. A soft dependency is: * an edited, shared (not item specific) dependency

Parameters:

site - Site to operate on

path - Paths to item to retrieve deps for

Returns:

list of soft dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ServiceLayerException - Internal error, see exception details

getSoftDependencies

List<String> getSoftDependencies(String site,
                                 List<String> paths)
                          throws SiteNotFoundException,
                                 ServiceLayerException

Get a soft dependencies of a list of items. A soft dependency is: * an edited, shared (not item specific) dependency

Parameters:

site - Site to operate on

paths - List of paths to items to retrieve deps for

Returns:

list of soft dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ServiceLayerException - Internal error, see exception details

getHardDependencies

List<String> getHardDependencies(String site,
                                 String path)
                          throws SiteNotFoundException,
                                 ServiceLayerException

Get a hard dependencies of a item. A hard dependency is: * Never-published item that this item depends on * Item-specific dependency that has been modified but not published

Parameters:

site - Site to operate on

path - Paths to item to retrieve deps for

Returns:

list of hard dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ServiceLayerException - Internal error, see exception details

getHardDependencies

List<String> getHardDependencies(String site,
                                 List<String> paths)
                          throws SiteNotFoundException,
                                 ServiceLayerException

Get a hard dependencies of a item. A hard dependency is: * Never-published item that this item depends on * Item-specific dependency that has been modified but not published

Parameters:

site - Site to operate on

paths - List of paths to items to retrieve deps for

Returns:

list of hard dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ServiceLayerException - Internal error, see exception details

getDependentItems

List<String> getDependentItems(String siteId,
                               String path)

Get list of paths of content items that are dependant on given path

Parameters:

siteId - site identifier

path - path to get dependent items for

Returns:

list of paths dependent on given

getDependentItems

List<String> getDependentItems(String siteId,
                               List<String> paths)

Get list of paths of content items that are dependant on given paths

Parameters:

siteId - site identifier

paths - list of paths to get dependent items for

Returns:

list of paths dependent on given paths