public interface CMSAdminSiteService
| Modifier and Type | Method and Description |
|---|---|
CatalogVersionModel |
getActiveCatalogVersion() |
CMSSiteModel |
getActiveSite()
Returns the active site (the site the current user is working on).
|
Collection<CatalogModel> |
getAllCatalogs(CMSSiteModel site)
Returns all catalogs for the specified site
site. |
Collection<ComposedTypeModel> |
getAllPageTypes()
returns all composed type which extend the AbstractPage
|
CMSSiteModel |
getSiteById(String id)
Deprecated.
use
getSiteForId(String) instead. |
CMSSiteModel |
getSiteForId(String id)
Returns a site with the given ID
|
Collection<CMSSiteModel> |
getSites()
Get all sites which are defined in the CMS
|
boolean |
hasActiveCatalogVersion()
checks if the current user has set an active catalog version
|
boolean |
hasActiveSite()
checks if the current user has set an active site
|
boolean |
hasPreviewURL()
check if the active site has a preview url
|
boolean |
hasPreviewURL(CMSSiteModel site)
check if the given site has a preview url
|
void |
setActiveCatalogVersion(CatalogVersionModel catalogVersion)
Set a catalog version as active.
|
void |
setActiveCatalogVersion(String catalogId,
String versionId)
Set a catalog version (via catalog id and version id) as active.
|
void |
setActiveSite(CMSSiteModel site)
Sets a site as active (the site the current user is working on)
|
void |
setActiveSiteById(String id)
Deprecated.
use
setActiveSiteForId(String) instead. |
void |
setActiveSiteForId(String id)
Sets a site as active (the site the current user is working on)
|
Collection<CMSSiteModel> getSites()
@Deprecated CMSSiteModel getSiteById(String id) throws CMSItemNotFoundException
getSiteForId(String) instead.id - the id of the siteCMSItemNotFoundException - when no site is found with the given idCMSSiteModel getSiteForId(String id) throws AmbiguousIdentifierException, UnknownIdentifierException
id - the id of the siteAmbiguousIdentifierException - thrown when more than one object has been found.UnknownIdentifierException - thrown when no object has been found@Deprecated void setActiveSiteById(String id) throws CMSItemNotFoundException
setActiveSiteForId(String) instead.id - id of the siteCMSItemNotFoundException - when no site is found with the given idvoid setActiveSiteForId(String id) throws AmbiguousIdentifierException, UnknownIdentifierException
id - id of the siteAmbiguousIdentifierException - thrown when more than one object has been found.UnknownIdentifierException - thrown when no object has been foundvoid setActiveSite(CMSSiteModel site)
site - CMSSiteModel getActiveSite()
boolean hasActiveSite()
void setActiveCatalogVersion(String catalogId, String versionId) throws CMSItemNotFoundException
catalogId - versionId - CMSItemNotFoundException - if no catalog version with the given parameters is foundvoid setActiveCatalogVersion(CatalogVersionModel catalogVersion)
catalogVersion - CatalogVersionModel getActiveCatalogVersion()
boolean hasActiveCatalogVersion()
Collection<ComposedTypeModel> getAllPageTypes()
boolean hasPreviewURL()
boolean hasPreviewURL(CMSSiteModel site)
site - the site to checkCollection<CatalogModel> getAllCatalogs(CMSSiteModel site)
site. This means all the content catalogs of the
site as well as the product and classification system catalogs which belong to the stores associated
with the site.site - the CMS siteCopyright © 2017 SAP SE. All Rights Reserved.