org.opencms.ade.contenteditor.shared.rpc

Interface I_CmsContentServiceAsync

All Superinterfaces:

I_CmsContentServiceAsync

public interface I_CmsContentServiceAsync
extends I_CmsContentServiceAsync

The content editor asynchronous service interface.

Method Summary

Modifier and Type	Method and 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	cancelEdit(CmsUUID structureId, boolean delete, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Cancels the editing session.
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, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, 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 newLink, CmsUUID modelFileId, java.lang.String editContext, java.lang.String mainLocale, java.lang.String mode, java.lang.String postCreateHandler, 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, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, 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.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<CmsValidationResult> 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, validateEntities

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 id

editedLocaleEntity - the edited entity

skipPaths - the locale synchronization value paths to skip

changedScopes - the changed content value paths

callback - the asynchronous callback

cancelEdit

@SynchronizedRpcRequest
void cancelEdit(CmsUUID structureId,
                                        boolean delete,
                                        com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Cancels the editing session.

Will unlock the resource and delete it if required.

Parameters:

structureId - the resource structure id

delete - true to delete the edited resource

callback - 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 locales

sourceLocale - the source locale

callback - the asynchronous callback

loadDefinition

void loadDefinition(java.lang.String entityId,
                    CmsEntity editedLocaleEntity,
                    java.util.Collection<java.lang.String> skipPaths,
                    com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)

Loads the content definition for a given type.

Parameters:

entityId - the entity id/URI

editedLocaleEntity - the edited locale entity

skipPaths - the paths to skip during locale synchronization

callback - the asynchronous callback

loadInitialDefinition

void loadInitialDefinition(java.lang.String entityId,
                           java.lang.String newLink,
                           CmsUUID modelFileId,
                           java.lang.String editContext,
                           java.lang.String mainLocale,
                           java.lang.String mode,
                           java.lang.String postCreateHandler,
                           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/URI

newLink - the new link

modelFileId - the optional model file id

editContext - the container page currently being edited (may be null)

mainLocale - the main language to copy in case the element language node does not exist yet

mode - the content creation mode

postCreateHandler - the post-create handler class name

callback - the asynchronous callback

loadNewDefinition

void loadNewDefinition(java.lang.String entityId,
                       CmsEntity editedLocaleEntity,
                       java.util.Collection<java.lang.String> skipPaths,
                       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/URI

editedLocaleEntity - the edited locale entity

skipPaths - the paths to skip during locale synchronization

callback - 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.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<CmsValidationResult> callback)

Saves and deletes the given entities. Returns a validation result in case of invalid entities.

Parameters:

lastEditedEntity - the last edited entity

deletedEntities - the entity id's to delete

skipPaths - the paths to skip during locale synchronization

lastEditedLocale - the last edited locale

clearOnSuccess - true to unlock resource after saving

callback - 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 content

contentPath - the xpath of the value to set

locale - the locale in which to set the value

value - the value to set

callback - the callback to call with the result