Package org.ametys.cms.content

Class CopyReport

java.lang.Object
org.ametys.cms.content.CopyReport
public final class CopyReport extends Object
The report object, used internally to provide useful informations once the whole duplication process has ended.

  • Constructor Details

    • CopyReport

      public CopyReport(String baseContentId, Boolean baseContentIsRefTable, String viewName, String fallbackViewName, CopyReport.CopyMode copyMode)
      Constructor. If the title of the base content if available, should be used.
      Parameters:
      baseContentId - The content id of the base content
      baseContentIsRefTable - Indicates if the base content is a reference table's entry (can be null if unavailable)
      viewName - The view name
      fallbackViewName - The fallback view name. Use for legacy purpose.
      copyMode - The mode of copy

    • CopyReport

      public CopyReport(String baseContentId, String baseContentTitle, Boolean baseContentIsRefTable, String viewName, String fallbackViewName, CopyReport.CopyMode copyMode)
      Constructor.
      Parameters:
      baseContentId - The content id of the base content
      baseContentTitle - The title of the base content
      baseContentIsRefTable - Indicates if the base content is a reference table's entry
      viewName - The view name
      fallbackViewName - The fallback view name. Use for legacy purpose.
      copyMode - The mode of copy

  • Method Details

    • setReferenceTable

      public void setReferenceTable(boolean isRefTable)
      Set whether the base content is a reference table's entry.
      Parameters:
      isRefTable - true for reference table's entry.

    • setTargetContentTitle

      public void setTargetContentTitle(String title)
      Set the target content title.
      Parameters:
      title - The target content title.

    • notifyContentCreation

      public void notifyContentCreation(String id, String title, boolean isRefTable)
      Notify information about the target content to the report.
      Parameters:
      id - The content id
      title - The content title
      isRefTable - Indicates if the target content is a reference table's entry.

    • notifyContentCopySuccess

      public void notifyContentCopySuccess()
      Notify a copy success

    • notifyContentCopyError

      public void notifyContentCopyError()
      Notify that the copy ended with an error

    • setErrorMessage

      public void setErrorMessage(I18nizableText errorMsg)
      Set the error message
      Parameters:
      errorMsg - the error message

    • getErrorMessage

      public I18nizableText getErrorMessage()
      Get the error message
      Returns:
      the error message. Can be null.

    • addAttachment

      public void addAttachment(String relPath)
      Add an attachments to the copied attachments report list
      Parameters:
      relPath - The relative path where to copy

    • getStatus

      public CopyReport.CopyState getStatus()
      Get the status of the copy
      Returns:
      A copy state enum value

    • getMode

      public CopyReport.CopyMode getMode()
      Get the mode of the copy
      Returns:
      A cope mode enum value

    • getViewName

      public String getViewName()
      Get the name of the view used for the copy.
      Returns:
      the view name

    • getFallbackViewName

      public String getFallbackViewName()
      Get the name of the fallback view used for the copy.
      Returns:
      the fallback view name

    • getBaseContentId

      public String getBaseContentId()
      /** Get the base content identifier
      Returns:
      The identifier

    • getBaseContentTitle

      public String getBaseContentTitle()
      Get the base content title.
      Returns:
      The title or null (if unavailable)

    • getBaseContentIsReferenceTable

      public Boolean getBaseContentIsReferenceTable()
      Is the base content a reference table entry ?
      Returns:
      true if it is, null if unknown.

    • getTargetContentId

      public String getTargetContentId()
      Get the target content identifier
      Returns:
      The identifier

    • getTargetContentTitle

      public String getTargetContentTitle()
      Get the target content title
      Returns:
      The title

    • getTargetContentIsReferenceTable

      public boolean getTargetContentIsReferenceTable()
      Is the target content a reference table entry?
      Returns:
      true if it is.

    • getChildReports

      public List<CopyReport> getChildReports()
      Get the list of child copy reports. Each child report denotes an inner copy
      Returns:
      The list of copy reports.

    • getCopiedAttachments

      public List<String> getCopiedAttachments()
      Get the list of the copied attachments.
      Returns:
      List of paths (relative to the root attachment node of the target content)

    • addReport

      public void addReport(CopyReport report)
      Add a child report to the report. This must be done when an copy is requested
      Parameters:
      report - The report of the copy to add