Interface I_CmsContentService
- All Superinterfaces:
I_CmsContentService,com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
CmsContentService
The content editor service interface.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidabortAugmentationJob(CmsUUID jobId) Tries to abort a content augmentation job with a given id.callEditorChangeHandlers(String entityId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Collection<String> changedScopes) Calls the editor change handlers.voidcopyLocale(Collection<String> locales, CmsEntity sourceLocale) Copies the given source locale to the target locales.getAugmentationProgress(CmsUUID jobId) Gets the status (and potentially results) from an augmentation job.loadDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String, String> settingPresets) Loads the content definition for a given entity.loadInitialDefinition(String entityId, String clientId, String newLink, CmsUUID modelFileId, String editContext, String mainLocale, String mode, String postCreateHandler, CmsEditHandlerData editHandlerData, Map<String, String> settingPresets, String editorStylesheet) Loads the content definition for a given entity.loadNewDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String, String> settingPresets) Loads new entity definition.prefetch()Returns the content definition of the resource requested through parameter 'resource'.saveAndDeleteEntities(CmsEntity lastEditedEntity, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale, boolean clearOnSuccess, boolean failOnWarnings) Saves and deletes the given entities.Saves a value in an existing XML content.startAugmentationJob(String entityId, String clientId, CmsEntity editedEntity, List<String> deletedEntities, Collection<String> skipPaths, String augmentationType, Map<String, String> params) Sends the edited data back to the server and starts a content augmentation.validateEntities(CmsEntity lastEditedEntity, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale) Validates the edited XML content, taking all current changes into account.Methods inherited from interface org.opencms.acacia.shared.rpc.I_CmsContentService
loadContentDefinition, saveEntities, saveEntity, updateEntityHtml, validateEntity
-
Field Details
-
DICT_CONTENT_DEFINITION
The content definition dictionary name.- See Also:
-
PARAM_BACKLINK
The back-link parameter.- See Also:
-
-
Method Details
-
abortAugmentationJob
Tries to abort a content augmentation job with a given id.- Parameters:
jobId- the job ID- Throws:
CmsRpcException- if something goes wrong
-
getAugmentationProgress
Gets the status (and potentially results) from an augmentation job.- Parameters:
jobId- the id of the augmentation job- Returns:
- the status and possibly results of the content augmentation
- Throws:
CmsRpcException- if something goes wrong
-
prefetch
Returns the content definition of the resource requested through parameter 'resource'.- Returns:
- the content definition
- Throws:
CmsRpcException- if something goes wrong
-
saveValue
String saveValue(String contentId, String contentPath, String locale, String value) throws CmsRpcException Saves a value in an existing XML content.- Parameters:
contentId- the structure id of the contentcontentPath- the xpath of the value to setlocale- the locale in which to set the valuevalue- the value to set- Returns:
- not used
- Throws:
CmsRpcException- if something goes wrong
-