public class CmsContainerpageService extends CmsGwtService implements I_CmsContainerpageService
限定符和类型 | 字段和说明 |
---|---|
static java.lang.String |
ADDINFO_EDIT_SMALL_ELEMENTS
Additional info key for storing the "edit small elements" setting on the user.
|
构造器和说明 |
---|
CmsContainerpageService() |
限定符和类型 | 方法和说明 |
---|---|
void |
addToFavoriteList(java.lang.String clientId)
Adds an element specified by it's id to the favorite list.
|
void |
addToRecentList(java.lang.String clientId)
Adds an element specified by it's id to the recent list.
|
boolean |
checkContainerpageOrElementsChanged(CmsUUID structureId,
CmsUUID detailContentId)
Check if a page or its elements have been changed.
|
CmsCreateElementData |
checkCreateNewElement(CmsUUID pageStructureId,
java.lang.String clientId,
java.lang.String resourceType,
java.lang.String locale)
To create a new element of the given type this method will check if a model resource needs to be selected, otherwise creates the new element.
|
boolean |
checkNewWidgetsAvailable(CmsUUID structureId)
Checks whether the Acacia widgets are available for all fields of the content.
|
CmsUUID |
convertToServerId(java.lang.String id)
Parses an element id.
|
CmsUUID |
copyElement(CmsUUID pageId,
CmsUUID originalElementId)
Creates a new element with a given model element and returns the copy'S structure id.
|
CmsContainerElement |
createNewElement(CmsUUID pageStructureId,
java.lang.String clientId,
java.lang.String resourceType,
CmsUUID modelResourceStructureId,
java.lang.String locale)
Creates a new element of the given type and returns the new element data containing structure id and site path.
|
static java.util.List<CmsModelResourceInfo> |
generateModelResourceList(CmsObject cms,
java.lang.String resourceType,
java.util.List<CmsResource> modelResources,
java.util.Locale contentLocale)
Generates the model resource data list.
|
CmsContainerElement |
getElementInfo()
This method is used for serialization purposes only.
|
java.util.Map<java.lang.String,CmsContainerElementData> |
getElementsData(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.lang.String reqParams,
java.util.Collection<java.lang.String> clientIds,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Returns container element data by client id.
|
CmsContainerElementData |
getElementWithSettings(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.lang.String uriParams,
java.lang.String clientId,
java.util.Map<java.lang.String,java.lang.String> settings,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Gets the element data for an id and a map of settings.
|
java.util.List<CmsContainerElementData> |
getFavoriteList(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Returns the container element data of the favorite list.
|
CmsContainerElementData |
getNewElementData(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.lang.String reqParams,
java.lang.String resourceType,
java.util.Collection<CmsContainer> containers,
java.lang.String localeName)
Returns new container element data for the given resource type name.
|
java.util.List<CmsContainerElementData> |
getRecentList(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Returns the container element data of the recent list.
|
CmsRemovedElementStatus |
getRemovedElementStatus(java.lang.String id,
CmsUUID containerpageId)
Gets the status of a removed element.
|
static java.lang.String |
getSerializedElementInfo(CmsObject cms,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
CmsContainerElementBean elementBean)
Returns the serialized element data.
|
CmsRemovedElementStatus |
internalGetRemovedElementStatus(CmsUUID structureId,
CmsUUID containerpageId)
Internal helper method to get the status of a removed element.
|
CmsCntPageData |
prefetch()
Returns the initialization data.
|
static CmsCntPageData |
prefetch(javax.servlet.http.HttpServletRequest request)
Fetches the container page data.
|
void |
saveContainerpage(CmsUUID pageStructureId,
java.util.List<CmsContainer> containers,
java.lang.String locale)
Saves the container-page.
|
void |
saveDetailContainers(java.lang.String detailContainerResource,
java.util.List<CmsContainer> containers,
java.lang.String locale)
Saves the detail containers.
|
void |
saveFavoriteList(java.util.List<java.lang.String> clientIds)
Saves the favorite list.
|
CmsGroupContainerSaveResult |
saveGroupContainer(CmsUUID pageStructureId,
CmsUUID detailContentId,
java.lang.String reqParams,
CmsGroupContainer groupContainer,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Saves a group-container element.
|
java.util.Map<java.lang.String,CmsContainerElementData> |
saveInheritanceContainer(CmsUUID pageStructureId,
CmsUUID detailContentId,
CmsInheritanceContainer inheritanceContainer,
java.util.Collection<CmsContainer> containers,
java.lang.String locale)
Saves an inheritance container.
|
void |
saveRecentList(java.util.List<java.lang.String> clientIds)
Saves the recent list.
|
void |
setEditSmallElements(boolean editSmallElements)
Enables or disables editing for small elements on page load.
|
void |
syncSaveContainerpage(CmsUUID pageStructureId,
java.util.List<CmsContainer> containers,
java.lang.String locale)
Saves the container-page in a synchronized RPC call.
|
void |
syncSaveDetailContainers(java.lang.String detailContainerResource,
java.util.List<CmsContainer> containers,
java.lang.String locale)
Saves the detail containers.
|
checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, setResponse, tryUnlock
checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse
doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent
doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service
public static final java.lang.String ADDINFO_EDIT_SMALL_ELEMENTS
public static java.util.List<CmsModelResourceInfo> generateModelResourceList(CmsObject cms, java.lang.String resourceType, java.util.List<CmsResource> modelResources, java.util.Locale contentLocale) throws CmsException
cms
- the cms contextresourceType
- the resource type namemodelResources
- the model resourcecontentLocale
- the content localeCmsException
- if something goes wrong reading the resource informationpublic static java.lang.String getSerializedElementInfo(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsContainerElementBean elementBean) throws java.lang.Exception
cms
- the cms contextrequest
- the servlet requestresponse
- the servlet responseelementBean
- the element to serializejava.lang.Exception
- if something goes wrongpublic static CmsCntPageData prefetch(javax.servlet.http.HttpServletRequest request) throws CmsRpcException
request
- the current requestCmsRpcException
- if something goes wrongpublic void addToFavoriteList(java.lang.String clientId) throws CmsRpcException
I_CmsContainerpageService
addToFavoriteList
在接口中 I_CmsContainerpageService
clientId
- the element idCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.addToFavoriteList(java.lang.String)
public void addToRecentList(java.lang.String clientId) throws CmsRpcException
I_CmsContainerpageService
addToRecentList
在接口中 I_CmsContainerpageService
clientId
- the element idCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.addToRecentList(java.lang.String)
public boolean checkContainerpageOrElementsChanged(CmsUUID structureId, CmsUUID detailContentId) throws CmsRpcException
I_CmsContainerpageService
checkContainerpageOrElementsChanged
在接口中 I_CmsContainerpageService
structureId
- the structure id of the resourcedetailContentId
- the structure id of the detail content (may be null)CmsRpcException
- if the RPC call failsI_CmsContainerpageService.checkContainerpageOrElementsChanged(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
public CmsCreateElementData checkCreateNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
checkCreateNewElement
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure idclientId
- the client id of the new element (this will be the structure id of the configured new resource)resourceType
- the resource tape of the new elementlocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.checkCreateNewElement(org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.lang.String)
public boolean checkNewWidgetsAvailable(CmsUUID structureId) throws CmsRpcException
I_CmsContainerpageService
checkNewWidgetsAvailable
在接口中 I_CmsContainerpageService
structureId
- the structure id of the contentCmsRpcException
- if something goes wrongI_CmsContainerpageService.checkNewWidgetsAvailable(org.opencms.util.CmsUUID)
public CmsUUID convertToServerId(java.lang.String id) throws CmsIllegalArgumentException
id
- the element idCmsIllegalArgumentException
- if the id has not the right formatpublic CmsUUID copyElement(CmsUUID pageId, CmsUUID originalElementId) throws CmsRpcException
I_CmsContainerpageService
copyElement
在接口中 I_CmsContainerpageService
pageId
- the container page idoriginalElementId
- the model element idCmsRpcException
- if something goes wrongI_CmsContainerpageService.copyElement(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
public CmsContainerElement createNewElement(CmsUUID pageStructureId, java.lang.String clientId, java.lang.String resourceType, CmsUUID modelResourceStructureId, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
createNewElement
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure idclientId
- the client id of the new element (this will be the structure id of the configured new resource)resourceType
- the resource tape of the new elementmodelResourceStructureId
- the model resource structure idlocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.createNewElement(org.opencms.util.CmsUUID, java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String)
public CmsContainerElement getElementInfo()
I_CmsContainerpageService
getElementInfo
在接口中 I_CmsContainerpageService
I_CmsContainerpageService.getElementInfo()
public java.util.Map<java.lang.String,CmsContainerElementData> getElementsData(CmsUUID pageStructureId, CmsUUID detailContentId, java.lang.String reqParams, java.util.Collection<java.lang.String> clientIds, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
getElementsData
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure idreqParams
- optional request parametersclientIds
- the requested element id'scontainers
- the containers of the current pagelocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.getElementsData(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, java.util.Collection, java.util.Collection, java.lang.String)
public CmsContainerElementData getElementWithSettings(CmsUUID pageStructureId, CmsUUID detailContentId, java.lang.String uriParams, java.lang.String clientId, java.util.Map<java.lang.String,java.lang.String> settings, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
getElementWithSettings
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure iduriParams
- optional request parametersclientId
- the requested element idssettings
- the settings for which the element data should be loadedcontainers
- the containers of the current pagelocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.getElementWithSettings(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.util.Map, java.util.Collection, java.lang.String)
public java.util.List<CmsContainerElementData> getFavoriteList(CmsUUID pageStructureId, CmsUUID detailContentId, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
getFavoriteList
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure idcontainers
- the containers of the current pagelocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.getFavoriteList(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.util.Collection, java.lang.String)
public CmsContainerElementData getNewElementData(CmsUUID pageStructureId, CmsUUID detailContentId, java.lang.String reqParams, java.lang.String resourceType, java.util.Collection<CmsContainer> containers, java.lang.String localeName) throws CmsRpcException
I_CmsContainerpageService
getNewElementData
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure idreqParams
- optional request parametersresourceType
- the requested element resource type namecontainers
- the containers of the current pagelocaleName
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.getNewElementData(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.util.Collection, java.lang.String)
public java.util.List<CmsContainerElementData> getRecentList(CmsUUID pageStructureId, CmsUUID detailContentId, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
getRecentList
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure idcontainers
- the containers of the current pagelocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.getRecentList(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.util.Collection, java.lang.String)
public CmsRemovedElementStatus getRemovedElementStatus(java.lang.String id, CmsUUID containerpageId) throws CmsRpcException
I_CmsContainerpageService
getRemovedElementStatus
在接口中 I_CmsContainerpageService
id
- the client id of the removed elementcontainerpageId
- the id of the page which should be excluded from the relation check, or null if no page should be excludedCmsRpcException
I_CmsContainerpageService.getRemovedElementStatus(java.lang.String, org.opencms.util.CmsUUID)
public CmsRemovedElementStatus internalGetRemovedElementStatus(CmsUUID structureId, CmsUUID containerpageId) throws CmsException, CmsLoaderException
structureId
- the structure id of the removed elementcontainerpageId
- the id of the page to exclude from the relation check, or null if no page should be excludedCmsException
CmsLoaderException
public CmsCntPageData prefetch() throws CmsRpcException
I_CmsContainerpageService
prefetch
在接口中 I_CmsContainerpageService
CmsRpcException
- if something goes wrongI_CmsContainerpageService.prefetch()
public void saveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
saveContainerpage
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure idcontainers
- the container-page's containerslocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.saveContainerpage(org.opencms.util.CmsUUID, java.util.List, java.lang.String)
public void saveDetailContainers(java.lang.String detailContainerResource, java.util.List<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
saveDetailContainers
在接口中 I_CmsContainerpageService
detailContainerResource
- the detail container resource pathcontainers
- the container-page's containerslocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.saveDetailContainers(java.lang.String, java.util.List, java.lang.String)
public void saveFavoriteList(java.util.List<java.lang.String> clientIds) throws CmsRpcException
I_CmsContainerpageService
saveFavoriteList
在接口中 I_CmsContainerpageService
clientIds
- favorite list element id'sCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.saveFavoriteList(java.util.List)
public CmsGroupContainerSaveResult saveGroupContainer(CmsUUID pageStructureId, CmsUUID detailContentId, java.lang.String reqParams, CmsGroupContainer groupContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
saveGroupContainer
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure iddetailContentId
- the detail content structure idreqParams
- optional request parametersgroupContainer
- the group-container to savecontainers
- the containers of the current pagelocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.saveGroupContainer(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, java.lang.String, org.opencms.ade.containerpage.shared.CmsGroupContainer, java.util.Collection, java.lang.String)
public java.util.Map<java.lang.String,CmsContainerElementData> saveInheritanceContainer(CmsUUID pageStructureId, CmsUUID detailContentId, CmsInheritanceContainer inheritanceContainer, java.util.Collection<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
saveInheritanceContainer
在接口中 I_CmsContainerpageService
pageStructureId
- the current page's structure iddetailContentId
- the detail content structure idinheritanceContainer
- the inheritance container to savecontainers
- the containers of the current pagelocale
- the requested localeCmsRpcException
- if something goes wrongI_CmsContainerpageService.saveInheritanceContainer(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, org.opencms.ade.containerpage.shared.CmsInheritanceContainer, java.util.Collection, java.lang.String)
public void saveRecentList(java.util.List<java.lang.String> clientIds) throws CmsRpcException
I_CmsContainerpageService
saveRecentList
在接口中 I_CmsContainerpageService
clientIds
- recent list element id'sCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.saveRecentList(java.util.List)
public void setEditSmallElements(boolean editSmallElements) throws CmsRpcException
I_CmsContainerpageService
setEditSmallElements
在接口中 I_CmsContainerpageService
editSmallElements
- the defautl setting for the small element editabilityCmsRpcException
- if something goes wrongI_CmsContainerpageService.setEditSmallElements(boolean)
public void syncSaveContainerpage(CmsUUID pageStructureId, java.util.List<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
syncSaveContainerpage
在接口中 I_CmsContainerpageService
pageStructureId
- the container page structure idcontainers
- the container-page's containerslocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.syncSaveContainerpage(org.opencms.util.CmsUUID, java.util.List, java.lang.String)
public void syncSaveDetailContainers(java.lang.String detailContainerResource, java.util.List<CmsContainer> containers, java.lang.String locale) throws CmsRpcException
I_CmsContainerpageService
syncSaveDetailContainers
在接口中 I_CmsContainerpageService
detailContainerResource
- the detail container resource pathcontainers
- the container-page's containerslocale
- the content localeCmsRpcException
- if something goes wrong processing the requestI_CmsContainerpageService.syncSaveDetailContainers(java.lang.String, java.util.List, java.lang.String)