Interface StatisticsService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
This interface provides services for other applications using methods related to collaboration download statistics
Methods of service classes can all throw the unchecked exception
ServiceException
if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException
) when an entity
to be retrieved is inaccessible, instead of returning null
.
Exceptions to this paradigm (including the use of ResultList
as
described below) are noted. All checked exceptions extend
AppianException
.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage
are provided in certain
instances for this purpose. The ResultPage
will contain the
sorted subset of results
(via Result.getResults()
), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()
).
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList
are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()
) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList
for details.
-
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
static 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
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final Integer
Code to use communityName as the sort propertystatic final Integer
Code to use documentExtension as the sort propertystatic final Integer
Code to use downloadDate as the sort property (for all methods exceptgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
)static final Integer
Code to use downloadDate as the sort property (forgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
)static final Integer
Code to use downloadDaysOfWeek as the sort propertystatic final Integer
Code to use downloadHourOfDay as the sort propertystatic final Integer
Code to use downloader as the sort propertystatic final Integer
Code to use knowledgeCenterName as the sort propertystatic final Integer
Code to use numberOfDownloads as the sort property (for all methods exceptgetPopularDocumentsKnowledgeCenter(java.lang.Long, java.lang.Long)
,getPopularDocumentsKnowledgeCenterPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
,getTopDocumentsByDownloads(java.lang.Long)
,getTopDocumentsByDownloadsPaging(int, int, java.lang.Integer, java.lang.Integer)
,getNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
)static final Integer
Code to use numberOfDownloads as the sort property (forgetPopularDocumentsKnowledgeCenter(java.lang.Long, java.lang.Long)
,getPopularDocumentsKnowledgeCenterPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
,getTopDocumentsByDownloads(java.lang.Long)
, andgetTopDocumentsByDownloadsPaging(int, int, java.lang.Integer, java.lang.Integer)
)static final Integer
Code to use numberOfDownloads as the sort property (forgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
)Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.getCommunitiesWithMostDownloadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the communities with the most downloadsgetDownloadsByDayForKnowledgeCenter
(Long kcid_, Long days_) getDownloadsByDayForKnowledgeCenterPaging
(Long kcid_, Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads for the last N day for a specified knowledge centergetDownloadsByHourPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads for each hourgetDownloadsByTypePaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads by document typegetDownloadsByWeekDaysPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads by weekdaysGets application download statisticsgetKnowledgeCentersWithMostDownloadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the knowledge centers with the most downloadsgetNumberDownloads
(Long days) getNumberDownloadsPaging
(Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads in the last days_ daysgetPopularDocumentsKnowledgeCenter
(Long kcid_, Long number_) getPopularDocumentsKnowledgeCenterPaging
(Long kcid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the most popular documents in a specific knowledge centergetTopDocumentsByDownloadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the top N documents with the most downloadsGets the total number of downloads from the collaboration application to dategetUsersByDownloadedContent
(Long contentId_) getUsersByDownloadedContentPaging
(Long contentId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the users who have downloaded a specific document, expressed by content id.getUsersByDownloadedDocument
(Long doid_) getUsersByDownloadedDocumentPaging
(Long docId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the users who have downloaded a specific documentMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
SORT_BY_NUMBER_OF_DOWNLOADS
Code to use numberOfDownloads as the sort property (for all methods exceptgetPopularDocumentsKnowledgeCenter(java.lang.Long, java.lang.Long)
,getPopularDocumentsKnowledgeCenterPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
,getTopDocumentsByDownloads(java.lang.Long)
,getTopDocumentsByDownloadsPaging(int, int, java.lang.Integer, java.lang.Integer)
,getNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
) -
SORT_BY_NUMBER_OF_DOWNLOADS_DOCUMENTS
Code to use numberOfDownloads as the sort property (forgetPopularDocumentsKnowledgeCenter(java.lang.Long, java.lang.Long)
,getPopularDocumentsKnowledgeCenterPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
,getTopDocumentsByDownloads(java.lang.Long)
, andgetTopDocumentsByDownloadsPaging(int, int, java.lang.Integer, java.lang.Integer)
) -
SORT_BY_NUMBER_OF_DOWNLOADS_NUMDOWNLOADS
Code to use numberOfDownloads as the sort property (forgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
) -
SORT_BY_COMMUNITY_NAME
Code to use communityName as the sort property -
SORT_BY_DOWNLOAD_DATE
Code to use downloadDate as the sort property (for all methods exceptgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
) -
SORT_BY_DOWNLOAD_DATE_NUMDOWNLOADS
Code to use downloadDate as the sort property (forgetNumberDownloads(java.lang.Long)
, andgetNumberDownloadsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
) -
SORT_BY_DOWNLOAD_HOUR_OF_DAY
Code to use downloadHourOfDay as the sort property -
SORT_BY_DOCUMENT_EXTENSION
Code to use documentExtension as the sort property -
SORT_BY_DOWNLOAD_DAY_OF_WEEK
Code to use downloadDaysOfWeek as the sort property -
SORT_BY_KNOWLEDGE_CENTER_NAME
Code to use knowledgeCenterName as the sort property -
SORT_BY_DOWNLOADER
Code to use downloader as the sort property -
getTotalDownloads$UPDATES
static final boolean getTotalDownloads$UPDATES- See Also:
-
getNumberDownloads$UPDATES
static final boolean getNumberDownloads$UPDATES- See Also:
-
getNumberDownloadsPaging$UPDATES
static final boolean getNumberDownloadsPaging$UPDATES- See Also:
-
getGeneralUserDownloadStatistics$UPDATES
static final boolean getGeneralUserDownloadStatistics$UPDATES- See Also:
-
getCommunitiesWithMostDownloads$UPDATES
static final boolean getCommunitiesWithMostDownloads$UPDATES- See Also:
-
getCommunitiesWithMostDownloadsPaging$UPDATES
static final boolean getCommunitiesWithMostDownloadsPaging$UPDATES- See Also:
-
getKnowledgeCentersWithMostDownloads$UPDATES
static final boolean getKnowledgeCentersWithMostDownloads$UPDATES- See Also:
-
getKnowledgeCentersWithMostDownloadsPaging$UPDATES
static final boolean getKnowledgeCentersWithMostDownloadsPaging$UPDATES- See Also:
-
getDownloadsByHour$UPDATES
static final boolean getDownloadsByHour$UPDATES- See Also:
-
getDownloadsByHourPaging$UPDATES
static final boolean getDownloadsByHourPaging$UPDATES- See Also:
-
getDownloadsByType$UPDATES
static final boolean getDownloadsByType$UPDATES- See Also:
-
getDownloadsByTypePaging$UPDATES
static final boolean getDownloadsByTypePaging$UPDATES- See Also:
-
getTopDocumentsByDownloads$UPDATES
static final boolean getTopDocumentsByDownloads$UPDATES- See Also:
-
getTopDocumentsByDownloadsPaging$UPDATES
static final boolean getTopDocumentsByDownloadsPaging$UPDATES- See Also:
-
getDownloadsByWeekDays$UPDATES
static final boolean getDownloadsByWeekDays$UPDATES- See Also:
-
getDownloadsByWeekDaysPaging$UPDATES
static final boolean getDownloadsByWeekDaysPaging$UPDATES- See Also:
-
getUsersByDownloadedDocument$UPDATES
static final boolean getUsersByDownloadedDocument$UPDATES- See Also:
-
getUsersByDownloadedContent$UPDATES
static final boolean getUsersByDownloadedContent$UPDATES- See Also:
-
getUsersByDownloadedDocumentPaging$UPDATES
static final boolean getUsersByDownloadedDocumentPaging$UPDATES- See Also:
-
getUsersByDownloadedContentPaging$UPDATES
static final boolean getUsersByDownloadedContentPaging$UPDATES- See Also:
-
getPopularDocumentsKnowledgeCenter$UPDATES
static final boolean getPopularDocumentsKnowledgeCenter$UPDATES- See Also:
-
getPopularDocumentsKnowledgeCenterPaging$UPDATES
static final boolean getPopularDocumentsKnowledgeCenterPaging$UPDATES- See Also:
-
getDownloadsByDayForKnowledgeCenter$UPDATES
static final boolean getDownloadsByDayForKnowledgeCenter$UPDATES- See Also:
-
getDownloadsByDayForKnowledgeCenterPaging$UPDATES
static final boolean getDownloadsByDayForKnowledgeCenterPaging$UPDATES- See Also:
-
-
Method Details
-
getTotalDownloads
Long getTotalDownloads()Gets the total number of downloads from the collaboration application to date- Returns:
- the total number of downloads
- Throws:
ServiceException
- if any system-level error occurs
-
getNumberDownloads
Deprecated.Gets the number of downloads in the last days_ days- Parameters:
days
- the number of days in the query- Returns:
- a list of
DownloadStatistics
objects, with thedownloadDate
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents one day of download information. - Throws:
ServiceException
- if any system-level error occurs
-
getNumberDownloadsPaging
ResultPage getNumberDownloadsPaging(Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads in the last days_ days- Parameters:
days_
- the number of days in the querystartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_NUMBER_OF_DOWNLOADS_NUMDOWNLOADS
orSORT_BY_DOWNLOAD_DATE_NUMDOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloadDate
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents one day of download information. - Throws:
ServiceException
- if any system-level error occurs
-
getGeneralUserDownloadStatistics
UserStatistics getGeneralUserDownloadStatistics()Gets application download statistics- Returns:
- a
UserStatistics
object encapsulating application download statistics, with thenumberOfUsersWhoHaveDownloaded
field populated. - Throws:
ServiceException
- if any system-level error occurs
-
getCommunitiesWithMostDownloads
Deprecated.Gets the top num_ communities with the most downloads- Parameters:
num_
- the top number of communities to return- Returns:
- a list of
DownloadStatistics
objects, with thecommunityName
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents a community's download information - Throws:
ServiceException
- if any system-level error occurs
-
getCommunitiesWithMostDownloadsPaging
ResultPage getCommunitiesWithMostDownloadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the communities with the most downloads- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_COMMUNITY_NAME
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thecommunityName
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents a community's download information. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersWithMostDownloads
Deprecated.Gets the top num_ knowledge centers with the most downloads- Parameters:
num_
- the top number of knowledge centers to return- Returns:
- a list of
DownloadStatistics
objects, with theknowledgeCenterName
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents a knowledge center's download information. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersWithMostDownloadsPaging
ResultPage getKnowledgeCentersWithMostDownloadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the knowledge centers with the most downloads- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_KNOWLEDGE_CENTER_NAME
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with theknowledgeCenterName
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents a knowledge center's download information. - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByHour
DownloadStatistics[] getDownloadsByHour()Gets the number of downloads for each hour- Returns:
- a list of
DownloadStatistics
objects. EachDownloadStatistics
object represents download information for an hour, with thedownloadHourOfDay
andnumberOfDownloads
fields populated - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByHourPaging
ResultPage getDownloadsByHourPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads for each hour- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOWNLOAD_HOUR_OF_DAY
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloadHourOfDay
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents download information for an hour. - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByType
DownloadStatistics[] getDownloadsByType()Gets the number of downloads by document type- Returns:
- a list of
DownloadStatistics
objects, with thedocumentExtension
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents download information for a document extension. - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByTypePaging
ResultPage getDownloadsByTypePaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads by document type- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOCUMENT_EXTENSION
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedocumentExtension
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents download information for a document extension. - Throws:
ServiceException
- if any system-level error occurs
-
getTopDocumentsByDownloads
Gets the top num_ documents in terms of how often they have been downloaded- Parameters:
num_
- the top number of documents to return- Returns:
- a list of
DocumentStatistics
objects which represent the most downloaded documents, with the normalDocumentService.getDocuments(java.lang.Long[])
fields and thenumberOfDownloads
field populated - Throws:
ServiceException
- if any system-level error occurs
-
getTopDocumentsByDownloadsPaging
ResultPage getTopDocumentsByDownloadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the top N documents with the most downloads- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_NUMBER_OF_DOWNLOADS_DOCUMENTS
or any of theSORT_BY_XXX
fields underDocument
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDocumentStatistics
objects which represent the most downloaded documents, with the normalDocumentService.getDocuments(java.lang.Long[])
fields and thenumberOfDownloads
field populated - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByWeekDays
DownloadStatistics[] getDownloadsByWeekDays()Gets the number of downloads by weekdays- Returns:
- a list of
DownloadStatistics
objects, with thedownloadDayOfWeek
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents download information for a weekday. - Throws:
ServiceException
- if any system-level error occurs
-
getDownloadsByWeekDaysPaging
ResultPage getDownloadsByWeekDaysPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of downloads by weekdays- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOWNLOAD_DAY_OF_WEEK
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloadDayOfWeek
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents download information for a weekday. - Throws:
ServiceException
- if any system-level error occurs
-
getUsersByDownloadedDocument
Deprecated.Gets the users who have downloaded a specific document- Parameters:
doid_
- the unique ID of the document- Returns:
- a list of
DownloadStatistics
objects, with thedownloader
field populated. EachDownloadStatistics
object represents one user who downloaded the document - Throws:
ServiceException
- if any system-level error occursInvalidDocumentException
- if the document does not exist
-
getUsersByDownloadedContent
Deprecated.Gets the users who have downloaded a specific document, expressed by content id. This allows one particular version of a document to be examined (use ContentService's getVersionId for this id).- Parameters:
contentId_
- the unique content ID of the document- Returns:
- a list of
DownloadStatistics
objects, with thedownloader
field populated. EachDownloadStatistics
object represents one user who downloaded the document - Throws:
ServiceException
- if any system-level error occursInvalidDocumentException
- if the document does not exist
-
getUsersByDownloadedDocumentPaging
ResultPage getUsersByDownloadedDocumentPaging(Long docId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidDocumentException Gets the users who have downloaded a specific document- Parameters:
docId_
- the unique ID of the documentstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOWNLOADER
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloader
field populated. EachDownloadStatistics
object represents one user who downloaded the document - Throws:
ServiceException
- if any system-level error occursInvalidDocumentException
- if the document does not exist
-
getUsersByDownloadedContentPaging
ResultPage getUsersByDownloadedContentPaging(Long contentId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidDocumentException Gets the users who have downloaded a specific document, expressed by content id. This allows one particular version of a document to be examined (use ContentService's getVersionId for this id).- Parameters:
docId_
- the unique ID of the documentstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOWNLOADER
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloader
field populated. EachDownloadStatistics
object represents one user who downloaded the document - Throws:
ServiceException
- if any system-level error occursInvalidDocumentException
- if the document does not exist
-
getPopularDocumentsKnowledgeCenter
DocumentStatistics[] getPopularDocumentsKnowledgeCenter(Long kcid_, Long number_) throws InvalidKnowledgeCenterException Deprecated.Gets the number_ most popular documents in a specific knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centernumber_
- the top number to documents to return- Returns:
- an array of
DocumentStatistics
objects representing the most popular documents, with the normalDocumentService.getDocuments(java.lang.Long[])
fields and thenumberOfDownloads
field populated - Throws:
ServiceException
- if any system-level error occursInvalidKnowledgeCenterException
- Never thrown. Is only declared for backwards compatibility.
-
getPopularDocumentsKnowledgeCenterPaging
ResultPage getPopularDocumentsKnowledgeCenterPaging(Long kcid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException Gets the most popular documents in a specific knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_NUMBER_OF_DOWNLOADS_DOCUMENTS
or any of theSORT_BY_XXX
fields underDocument
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDocumentStatistics
objects representing the most popular documents, with the normalDocumentService.getDocuments(java.lang.Long[])
fields and thenumberOfDownloads
field populated - Throws:
ServiceException
- if any system-level error occursInvalidKnowledgeCenterException
- Never thrown. Is only declared for backwards compatibility.
-
getDownloadsByDayForKnowledgeCenter
DownloadStatistics[] getDownloadsByDayForKnowledgeCenter(Long kcid_, Long days_) throws InvalidKnowledgeCenterException Deprecated.Gets the number of downloads for the last days_ day for a specified knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerdays_
- the number of days in the query- Returns:
- a list of
DownloadStatistics
objects, with thedownloadDate
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents one day of download information for the knowledge center - Throws:
ServiceException
- if any system-level error occursInvalidKnowledgeCenterException
- Never thrown. Is only declared for backwards compatibility.
-
getDownloadsByDayForKnowledgeCenterPaging
ResultPage getDownloadsByDayForKnowledgeCenterPaging(Long kcid_, Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException Gets the number of downloads for the last N day for a specified knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerdays_
- the number of days in the querystartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted (SORT_BY_DOWNLOAD_DATE
orSORT_BY_NUMBER_OF_DOWNLOADS
)sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDownloadStatistics
objects, with thedownloadDate
andnumberOfDownloads
fields populated. EachDownloadStatistics
object represents one day of download information for the knowledge center - Throws:
ServiceException
- if any system-level error occursInvalidKnowledgeCenterException
- Never thrown. Is only declared for backwards compatibility.
-
getCommunitiesWithMostDownloadsPaging(int, int, java.lang.Integer, java.lang.Integer)