Interface CmsCockpitService
- All Known Implementing Classes:
CmsCockpitServiceImpl
public interface CmsCockpitService
The Interface CmsCockpitService is responsible for managing approval status, cloning pages and retrieving components,
sites and pages information.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionclonePageFirstLevel(TypedObject page, String name) Creates a new page on base of an already existing page.createRestrictionTooltip(TypedObject restriction) Retrieve the restriction description to be displayed in a tooltipReturn all approval status codesFind the approval status code for a given itemgetApprovalStatusName(String code) Find an approval status name from a given codegetDefaultPage(TypedObject page) Find the default page for a given pageFind all personalized pages for a given pagegetPersonalizedPages(TypedObject page, TypedObject excludePage) Find all personalized pages for a given page without a given excluded pagegetRecentlyEditedPages(int count) Find all pages recently editedgetSites()Find all sitesFind all sitesbooleanisPartOfTemplate(TypedObject cmsComponent) Determine whether a component is part of a templatebooleanisRestricted(TypedObject cmsComponent) Determine whether a component has any associated restrictions or notvoidsetApprovalStatus(TypedObject item, String code) Update an approval status for a given code
-
Field Details
-
CMSITEM_UID
- See Also:
-
ABSTRACTPAGE_UID_PREFIX
- See Also:
-
-
Method Details
-
getAllApprovalStatusCodes
Return all approval status codes- Returns:
- all approval status codes
-
getApprovalStatusName
Find an approval status name from a given code- Parameters:
code- of approval status- Returns:
- the approval status name
-
setApprovalStatus
Update an approval status for a given code- Parameters:
item- requiring an approvalcode- of approval status to be updated
-
getApprovalStatusCode
Find the approval status code for a given item- Parameters:
item- having an approval status- Returns:
- approval status code
-
isPartOfTemplate
Determine whether a component is part of a template- Parameters:
cmsComponent- to be determined if it is contained in a template- Returns:
trueif a component is part of a template;falseotherwise
-
isRestricted
Determine whether a component has any associated restrictions or not- Parameters:
cmsComponent- to be determined if it has any restrictions- Returns:
trueif a component has at least one restriction;falseotherwise
-
clonePageFirstLevel
Creates a new page on base of an already existing page. Also creates new content slots for this page, but components are the same as in the original page.- Parameters:
page- the page to use as templatename- the name for the new page, if null the name of the original page is used- Returns:
- the new page
-
createRestrictionTooltip
Retrieve the restriction description to be displayed in a tooltip- Parameters:
restriction- containing the description to be displayed- Returns:
- the description of a given restriction
-
getWebsites
Collection<CMSSiteModel> getWebsites()Find all sites- Returns:
- collection of sites, user type permission is checked before returning
-
getRecentlyEditedPages
Find all pages recently edited- Parameters:
count- max number of pages to be returned- Returns:
- all pages recently edited
-
getPersonalizedPages
Find all personalized pages for a given page- Parameters:
page- which is personalized- Returns:
- all personalized pages for a given page
-
getPersonalizedPages
Find all personalized pages for a given page without a given excluded page- Parameters:
page- which is personalizedexcludePage- which is excluded- Returns:
- all personalized pages for a given page
-
getDefaultPage
Find the default page for a given page- Parameters:
page- having a default page- Returns:
- a default page for a given page
-
getSites
Collection<CMSSiteModel> getSites()Find all sites- Returns:
- collection of sites, user type permission is checked before returning
-