Interface I_CmsContentServiceAsync
-
- All Superinterfaces:
I_CmsContentServiceAsync
public interface I_CmsContentServiceAsync extends I_CmsContentServiceAsync
The content editor asynchronous service interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
callEditorChangeHandlers(java.lang.String entityId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Collection<java.lang.String> changedScopes, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Calls the editor change handlers.void
copyLocale(java.util.Collection<java.lang.String> locales, CmsEntity sourceLocale, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
Copies the given source locale to the target locales.void
loadDefinition(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,java.lang.String> settingPresets, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads the content definition for a given type.void
loadInitialDefinition(java.lang.String entityId, java.lang.String clientId, java.lang.String newLink, CmsUUID modelFileId, java.lang.String editContext, java.lang.String mainLocale, java.lang.String mode, java.lang.String postCreateHandler, CmsEditHandlerData editHandlerData, java.util.Map<java.lang.String,java.lang.String> settingPresets, java.lang.String editorStylesheet, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads the content definition for a given type creating a new resource according to the new link and model file parameter.void
loadNewDefinition(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,java.lang.String> settingPresets, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads new entity definition.void
prefetch(com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Returns the content definition of the resource requested through parameter 'resource'.void
saveAndDeleteEntities(CmsEntity lastEditedEntity, java.lang.String clientId, java.util.List<java.lang.String> deletedEntities, java.util.Collection<java.lang.String> skipPaths, java.lang.String lastEditedLocale, boolean clearOnSuccess, com.google.gwt.user.client.rpc.AsyncCallback<CmsSaveResult> callback)
Saves and deletes the given entities.void
saveValue(java.lang.String contentId, java.lang.String contentPath, java.lang.String locale, java.lang.String value, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback)
Saves a value in an existing XML content.-
Methods inherited from interface org.opencms.acacia.shared.rpc.I_CmsContentServiceAsync
loadContentDefinition, saveEntities, saveEntity, updateEntityHtml, validateEntity
-
-
-
-
Method Detail
-
callEditorChangeHandlers
void callEditorChangeHandlers(java.lang.String entityId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Collection<java.lang.String> changedScopes, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Calls the editor change handlers.- Parameters:
entityId
- the edited entity ideditedLocaleEntity
- the edited entityskipPaths
- the locale synchronization value paths to skipchangedScopes
- the changed content value pathscallback
- the asynchronous callback
-
copyLocale
void copyLocale(java.util.Collection<java.lang.String> locales, CmsEntity sourceLocale, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)
Copies the given source locale to the target locales.- Parameters:
locales
- the target localessourceLocale
- the source localecallback
- the asynchronous callback
-
loadDefinition
void loadDefinition(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,java.lang.String> settingPresets, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads the content definition for a given type.- Parameters:
entityId
- the entity id/URIclientId
- the container element client id if availableeditedLocaleEntity
- the edited locale entityskipPaths
- the paths to skip during locale synchronizationsettingPresets
- the presets for container element settingscallback
- the asynchronous callback
-
loadInitialDefinition
void loadInitialDefinition(java.lang.String entityId, java.lang.String clientId, java.lang.String newLink, CmsUUID modelFileId, java.lang.String editContext, java.lang.String mainLocale, java.lang.String mode, java.lang.String postCreateHandler, CmsEditHandlerData editHandlerData, java.util.Map<java.lang.String,java.lang.String> settingPresets, java.lang.String editorStylesheet, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads the content definition for a given type creating a new resource according to the new link and model file parameter.- Parameters:
entityId
- the entity id/URIclientId
- the container element client id if availablenewLink
- the new linkmodelFileId
- the optional model file ideditContext
- the container page currently being edited (may be null)mainLocale
- the main language to copy in case the element language node does not exist yetmode
- the content creation modepostCreateHandler
- the post-create handler class nameeditHandlerData
- the edit handler data, if an edit handler is used for creating a new resource; null otherwisesettingPresets
- the presets for container element settingseditorStylesheet
- the path of the style sheet to use for the WYSIWYG editorcallback
- the asynchronous callback
-
loadNewDefinition
void loadNewDefinition(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,java.lang.String> settingPresets, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Loads new entity definition.This will load the entity representation of a new locale node.
- Parameters:
entityId
- the entity id/URIclientId
- the container element client id if availableeditedLocaleEntity
- the edited locale entityskipPaths
- the paths to skip during locale synchronizationsettingPresets
- the presets for container element settingscallback
- the asynchronous callback
-
prefetch
void prefetch(com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
Returns the content definition of the resource requested through parameter 'resource'.- Parameters:
callback
- the callback
-
saveAndDeleteEntities
void saveAndDeleteEntities(CmsEntity lastEditedEntity, java.lang.String clientId, java.util.List<java.lang.String> deletedEntities, java.util.Collection<java.lang.String> skipPaths, java.lang.String lastEditedLocale, boolean clearOnSuccess, com.google.gwt.user.client.rpc.AsyncCallback<CmsSaveResult> callback)
Saves and deletes the given entities. Returns the editor save result information.- Parameters:
lastEditedEntity
- the last edited entityclientId
- the container element client id if availabledeletedEntities
- the entity id's to deleteskipPaths
- the paths to skip during locale synchronizationlastEditedLocale
- the last edited localeclearOnSuccess
-true
to unlock resource after savingcallback
- the asynchronous callback
-
saveValue
void saveValue(java.lang.String contentId, java.lang.String contentPath, java.lang.String locale, java.lang.String value, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback)
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 setcallback
- the callback to call with the result
-
-