Package 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 Details

    • abortAugmentationJob

      void abortAugmentationJob(CmsUUID jobId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Tries to abort a content augmentation job with a given id.
      Parameters:
      jobId - the job ID
      callback - the callback
      Throws:
      CmsRpcException - if something goes wrong

    • getAugmentationProgress

      void getAugmentationProgress(CmsUUID jobId, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentAugmentationDetails> callback)
      Gets the status (and potentially results) from an augmentation job.
      Parameters:
      jobId - the id of the augmentation job
      callback - the callback to call with the result
      Throws:
      CmsRpcException - if something goes wrong

    • startAugmentationJob

      void startAugmentationJob(String entityId, String clientId, CmsEntity editedEntity, List<String> deletedEntities, Collection<String> skipPaths, String augmentationType, Map<String,String> params, com.google.gwt.user.client.rpc.AsyncCallback<CmsUUID> callback)
      Sends the edited data back to the server and starts a content augmentation.
      Parameters:
      entityId - the entity id
      clientId - the client id, if available
      editedEntity - the edited entity
      deletedEntities - the deleted entities
      skipPaths - the paths to skip for locale synchronization
      callback - the callback to call with the result
      Throws:
      CmsRpcException - in case anything goes wrong

    • callEditorChangeHandlers

      void callEditorChangeHandlers(String entityId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Collection<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

    • copyLocale

      void copyLocale(Collection<String> locales, CmsEntity sourceLocale, com.google.gwt.user.client.rpc.AsyncCallback<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(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,String> settingPresets, com.google.gwt.user.client.rpc.AsyncCallback<CmsContentDefinition> callback)
      Loads the content definition for a given type.

      Parameters:
      entityId - the entity id/URI
      clientId - the container element client id if available
      editedLocaleEntity - the edited locale entity
      skipPaths - the paths to skip during locale synchronization
      settingPresets - the presets for container element settings
      callback - the asynchronous callback

    • loadInitialDefinition

      void 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, 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
      clientId - the container element client id if available
      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
      editHandlerData - the edit handler data, if an edit handler is used for creating a new resource; null otherwise
      settingPresets - the presets for container element settings
      editorStylesheet - the path of the style sheet to use for the WYSIWYG editor
      callback - the asynchronous callback

    • loadNewDefinition

      void loadNewDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,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/URI
      clientId - the container element client id if available
      editedLocaleEntity - the edited locale entity
      skipPaths - the paths to skip during locale synchronization
      settingPresets - the presets for container element settings
      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, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale, boolean clearOnSuccess, boolean failOnWarnings, 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 entity
      clientId - the container element client id if available
      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
      failOnWarnings - true to prevent saving when there are validation warnings
      callback - the asynchronous callback

    • saveValue

      void saveValue(String contentId, String contentPath, String locale, String value, com.google.gwt.user.client.rpc.AsyncCallback<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

    • validateEntities

      void validateEntities(CmsEntity lastEditedEntity, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale, com.google.gwt.user.client.rpc.AsyncCallback<CmsValidationResult> callback)
      Validates the edited XML content, taking all current changes into account. Returns the validation result.

      Parameters:
      lastEditedEntity - the last edited entity
      clientId - the container element client id if available
      deletedEntities - the entity id's to delete
      skipPaths - the paths to skip during locale synchronization
      lastEditedLocale - the last edited locale
      callback - the asynchronous callback