Package com.appiancorp.suiteapi.content

Interface ContentStatisticsService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
public interface ContentStatisticsService extends com.appiancorp.services.ContextSensitiveService
This interface provides access to the Content Statistics service. NOTE: This is the Content server, NOT the Collab Statistics server.

  • Field Details

    • getTotal$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotal$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTotalModified$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotalModified$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTotalByHour$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotalByHour$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTotalByDayOfWeek$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotalByDayOfWeek$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTotalByExtension$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotalByExtension$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTotalFiles$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTotalFiles$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getContentStatistics$UPDATES

      @Deprecated(forRemoval=true) static final boolean getContentStatistics$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getContentMegabytesUsed$UPDATES

      @Deprecated(forRemoval=true) static final boolean getContentMegabytesUsed$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getUserStatistics$UPDATES

      @Deprecated(forRemoval=true) static final boolean getUserStatistics$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • getTotal

      @Read(K_CONTENT) Integer getTotal(ContentFilter filter) throws InvalidTypeMaskException
      This returns the total number of content items matching the typemask. (getTotalNumber(TYPE_DOCUMENT) returns the total number of uploads.)
      Parameters:
      filter - only count contents matching this filter
      Returns:
      integer count
      Throws:
      InvalidTypeMaskException - if an invalid typemask is specified in the filter

    • getTotalModified

      @Read(K_CONTENT) Integer getTotalModified(ContentFilter filter, Integer days) throws InvalidTypeMaskException
      Get the total number of Content items modified in the given number of days. (getTotalModified(TYPE_DOCUMENT,days) returns the total number uploaded in the last so many days.)
      Parameters:
      filter - only count contents matching this filter
      days - number of days
      Returns:
      integer count
      Throws:
      InvalidTypeMaskException - if an invalid typemask is specified in the filter

    • getTotalByHour

      @Read(K_CONTENT) TotalByHour[] getTotalByHour(ContentFilter filter) throws InvalidTypeMaskException
      Get a count of content items modified by hour.
      Parameters:
      filter - only count contents matching this filter
      Returns:
      bean with hour and count fields
      Throws:
      InvalidTypeMaskException - if an invalid typemask is specified in the filter

    • getTotalByDayOfWeek

      @Read(K_CONTENT) TotalByDayOfWeek[] getTotalByDayOfWeek(ContentFilter filter) throws InvalidTypeMaskException
      Get a count of content items modified by day of week.
      Parameters:
      filter - only count contents matching this filter
      Returns:
      bean with dayOfWeek and count fields
      Throws:
      InvalidTypeMaskException - if an invalid typemask is specified in the filter

    • getTotalByExtension

      @Read(K_CONTENT) TotalByExtension[] getTotalByExtension()
      Get a count of content items by extension.
      Returns:
      bean with extension and count fields

    • getTotalFiles

      @Read(K_CONTENT) Integer getTotalFiles(Boolean includingVersions)
      Get a count of the total number of content items. This includes active and inactive content.
      Parameters:
      includingVersions - true if including version, false otherwise
      Returns:
      total count

    • getContentStatistics

      @Read(K_CONTENT) TotalByType[] getContentStatistics()
      Get a count of content items by type.
      Returns:
      bean of type and count

    • getContentMegabytesUsed

      @Read(K_CONTENT) Double getContentMegabytesUsed()
      Get the amount of space used by all leaf content.
      Returns:
      number of megabytes used by all leaf content (floating-point)

    • getUserStatistics

      @Read(K_CONTENT) UserStatistics getUserStatistics()
      Get user statistics for content.
      Returns:
      UserStatistics