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

Fields

Modifier and Type	Field and Description
static boolean	getContentMegabytesUsed$UPDATES
static boolean	getContentStatistics$UPDATES
static boolean	getTotal$UPDATES
static boolean	getTotalByDayOfWeek$UPDATES
static boolean	getTotalByExtension$UPDATES
static boolean	getTotalByHour$UPDATES
static boolean	getTotalFiles$UPDATES
static boolean	getTotalModified$UPDATES
static boolean	getUserStatistics$UPDATES

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getContentMegabytesUsed() Get the amount of space used by all leaf content.
TotalByType[]	getContentStatistics() Get a count of content items by type.
java.lang.Integer	getTotal(ContentFilter filter) This returns the total number of content items matching the typemask.
TotalByDayOfWeek[]	getTotalByDayOfWeek(ContentFilter filter) Get a count of content items modified by day of week.
TotalByExtension[]	getTotalByExtension() Get a count of content items by extension.
TotalByHour[]	getTotalByHour(ContentFilter filter) Get a count of content items modified by hour.
java.lang.Integer	getTotalFiles(java.lang.Boolean includingVersions) Get a count of the total number of content items.
java.lang.Integer	getTotalModified(ContentFilter filter, java.lang.Integer days) Get the total number of Content items modified in the given number of days.
UserStatistics	getUserStatistics() Get user statistics for content.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

getTotal$UPDATES

static final boolean getTotal$UPDATES

See Also:

Constant Field Values

getTotalModified$UPDATES

static final boolean getTotalModified$UPDATES

See Also:

Constant Field Values

getTotalByHour$UPDATES

static final boolean getTotalByHour$UPDATES

See Also:

Constant Field Values

getTotalByDayOfWeek$UPDATES

static final boolean getTotalByDayOfWeek$UPDATES

See Also:

Constant Field Values

getTotalByExtension$UPDATES

static final boolean getTotalByExtension$UPDATES

See Also:

Constant Field Values

getTotalFiles$UPDATES

static final boolean getTotalFiles$UPDATES

See Also:

Constant Field Values

getContentStatistics$UPDATES

static final boolean getContentStatistics$UPDATES

See Also:

Constant Field Values

getContentMegabytesUsed$UPDATES

static final boolean getContentMegabytesUsed$UPDATES

See Also:

Constant Field Values

getUserStatistics$UPDATES

static final boolean getUserStatistics$UPDATES

See Also:

Constant Field Values

Method Detail

getTotal

java.lang.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

java.lang.Integer getTotalModified(ContentFilter filter,
                                   java.lang.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

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

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

TotalByExtension[] getTotalByExtension()

Get a count of content items by extension.

Returns:

bean with extension and count fields

getTotalFiles

java.lang.Integer getTotalFiles(java.lang.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

TotalByType[] getContentStatistics()

Get a count of content items by type.

Returns:

bean of type and count

getContentMegabytesUsed

java.lang.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