Package com.xwiki.admintools.usage

Interface WikiUsageResult

@Unstable public interface WikiUsageResult
General interface for gathering info about a wiki.
Since:
1.0
Version:
$Id$

  • Method Details

    • getWikiName

      String getWikiName()
      Get the name of the wiki.
      Returns:
      the name of the wiki.

    • setWikiName

      void setWikiName(String wikiName)
      Set the name of the wiki.
      Parameters:
      wikiName - representing the name of the wiki.

    • getDocumentsCount

      Long getDocumentsCount()
      Get the number of documents in this wiki.
      Returns:
      number of documents in wiki.

    • setDocumentsCount

      void setDocumentsCount(Long documentsCount)
      Set the number of documents in this wiki.
      Parameters:
      documentsCount - number of documents for wiki.

    • getAttachmentsCount

      Long getAttachmentsCount()
      Get the number of attachments in this wiki.
      Returns:
      number of attachments in wiki.

    • setAttachmentsCount

      void setAttachmentsCount(Long attachmentsCount)
      Set the number attachments in this wiki.
      Parameters:
      attachmentsCount - number of attachments for wiki.

    • getTotal

      default Long getTotal()
      Get the total number of documents and attachments.
      Returns:
      the total number of documents and attachments.

    • getUserCount

      default Long getUserCount()
      Get the number of users registered in the wiki.
      Returns:
      Long representing the number of users in the wiki.

    • setUserCount

      default void setUserCount(Long userCount)
      Set the number of users registered in the wiki.
      Parameters:
      userCount - the number of users in the wiki.

    • getAttachmentsSize

      default Long getAttachmentsSize()
      Get the total size of the attachments.
      Returns:
      Long with the size of the attachments in the wiki.

    • setAttachmentsSize

      default void setAttachmentsSize(Long attachmentsSize)
      Set the total size of the attachments.
      Parameters:
      attachmentsSize - the size of the attachments in the wiki.