Package org.opencms.ade.contenteditor.shared

Class CmsContentAugmentationDetails

java.lang.Object
org.opencms.ade.contenteditor.shared.CmsContentAugmentationDetails
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public class CmsContentAugmentationDetails extends Object implements com.google.gwt.user.client.rpc.IsSerializable
Contains status information about a content augmentation that has just been run.

  • Field Details

  • Constructor Details

  • Method Details

    • getException

      public Throwable getException()
      Gets the exception (if any) from the server side.
      Returns:
      the exception from the server side

    • getHtmlMessage

      public String getHtmlMessage()
      Gets the message to display to the user, in HTML format.
      Returns:
      the HTML message

    • getLocales

      public List<String> getLocales()
      Gets the locales that are part of the augmented content (as strings).
      Returns:
      the list of locales

    • getNextLocale

      public String getNextLocale()
      Gets tje next locale to switch to (might be null if we should remain in the current locale).
      Returns:
      the locale to switch to

    • getProgress

      public String getProgress()
      Gets the progress message.
      Returns:
      the progress message

    • getResultCaption

      public String getResultCaption()
      Gets the caption to display on the result dialog.
      Returns:
      the caption to display on the results dialog

    • isAborted

      public boolean isAborted()
      Checks if the augmentation job was aborted.
      Returns:
      true if the augmentation job was aborted.

    • isDone

      public boolean isDone()
      Checks if the content augmentation has sucessfully completed.
      Returns:
      true if the content augmentation has successfully completed

    • setException

      public void setException(Throwable exception)
      Sets the exception to display.
      Parameters:
      exception - the exception to display

    • setHtmlMessage

      public void setHtmlMessage(String htmlMessage)
      Sets the message to display, in HTML format
      Parameters:
      htmlMessage - the message to display

    • setLocales

      public void setLocales(List<String> locales)
      Sets the locales.
      Parameters:
      locales - the locales

    • setNextLocale

      public void setNextLocale(String nextLocale)
      Sets the next locale to switch to (can be null if current locale should be maintained).
      Parameters:
      nextLocale - the next locale to switch to

    • setProgress

      public void setProgress(String progress)
      Sets the progress message.
      Parameters:
      progress - the progress message

    • setResultCaption

      public void setResultCaption(String resultCaption)
      Sets the caption to display on the results dialog.
      Parameters:
      resultCaption - the caption to display on the results dialog