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 Summary
Modifier and TypeFieldDescriptionstatic final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionGet the amount of space used by all leaf content.Get a count of content items by type.getTotal
(ContentFilter filter) This returns the total number of content items matching the typemask.getTotalByDayOfWeek
(ContentFilter filter) Get a count of content items modified by day of week.Get a count of content items by extension.getTotalByHour
(ContentFilter filter) Get a count of content items modified by hour.getTotalFiles
(Boolean includingVersions) Get a count of the total number of content items.getTotalModified
(ContentFilter filter, Integer days) Get the total number of Content items modified in the given number of days.Get user statistics for content.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
getTotal$UPDATES
static final boolean getTotal$UPDATES- See Also:
-
getTotalModified$UPDATES
static final boolean getTotalModified$UPDATES- See Also:
-
getTotalByHour$UPDATES
static final boolean getTotalByHour$UPDATES- See Also:
-
getTotalByDayOfWeek$UPDATES
static final boolean getTotalByDayOfWeek$UPDATES- See Also:
-
getTotalByExtension$UPDATES
static final boolean getTotalByExtension$UPDATES- See Also:
-
getTotalFiles$UPDATES
static final boolean getTotalFiles$UPDATES- See Also:
-
getContentStatistics$UPDATES
static final boolean getContentStatistics$UPDATES- See Also:
-
getContentMegabytesUsed$UPDATES
static final boolean getContentMegabytesUsed$UPDATES- See Also:
-
getUserStatistics$UPDATES
static final boolean getUserStatistics$UPDATES- See Also:
-
-
Method Details
-
getTotal
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
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 filterdays
- number of days- Returns:
- integer count
- Throws:
InvalidTypeMaskException
- if an invalid typemask is specified in the filter
-
getTotalByHour
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
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
TotalByExtension[] getTotalByExtension()Get a count of content items by extension.- Returns:
- bean with extension and count fields
-
getTotalFiles
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
TotalByType[] getContentStatistics()Get a count of content items by type.- Returns:
- bean of type and count
-
getContentMegabytesUsed
Double getContentMegabytesUsed()Get the amount of space used by all leaf content.- Returns:
- number of megabytes used by all leaf content (floating-point)
-
getUserStatistics
UserStatistics getUserStatistics()Get user statistics for content.- Returns:
- UserStatistics
-