Interface ReportingService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
Defines related methods for usage reporting within collaboration.
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 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 TypeMethodDescriptionDeprecated.use getCommunitiesWithMostUploadsPaginggetCommunitiesWithMostUploadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the communities with the most uploadsgetCommunityAdminReport
(Long commid_) Deprecated.use getCommunityAdminReportPaginggetCommunityAdminReportPaging
(Long commid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets information about a specified community and all its sub communitiesGets the general usage statistics and patterns of the collaboration application (eg the number of folders created).Gets user statistics in the collaboration application (eg the number of users who have uploaded documents).Deprecated.use getKnowledgeCentersWithMostUploadsPaginggetKnowledgeCentersWithMostUploadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the knowledge centers with the most uploadsDocument[]
getMoreWhatsNewSubscriptions
(String sortColumn_, Integer sortOrder_, Integer sortLength_) Deprecated.use getMoreWhatsNewSubscriptionsPaginggetMoreWhatsNewSubscriptionsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribedgetNumberUploads
(Long days_) Deprecated.user getNumberUploadsPaginggetNumberUploadsPaging
(Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads in the last N daysGets the total number of uploads to the collaboration applicationDeprecated.use getUploadsByHourPaginggetUploadsByHourPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads for each hourDeprecated.use getUploadsByTypePaginggetUploadsByTypePaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads by document extensionDeprecated.use getUploadsByWeekDaysPaginggetUploadsByWeekDaysPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads by weekdaysDocument[]
getWhatsNewCommunity
(Long coid_, Long num_) Deprecated.use getWhatsNewCommunityPagingDocument[]
getWhatsNewCommunityForUser
(Long communityId_, Long num_) Deprecated.use getWhatsNewCommunityForUserPaginggetWhatsNewCommunityForUserPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the latest documents (that the user can access) added/updated in the application in a specific community and its sub-communtiesgetWhatsNewCommunityPaging
(Long coid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the latest documents added/updated in the application in a specific community and its sub-communties (regardless of user)Document[]
getWhatsNewKnowledgeCenter
(Long kcid_, Integer sortOrder_, String sortColumn_) Deprecated.use getWhatsNewKnowledgeCenterPaginggetWhatsNewKnowledgeCenterPaging
(Long kcid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Retrieves the top N latest documents added or updated in a specified knowledge centerDocument[]
Deprecated.use getWhatsNewSubscriptionsPaginggetWhatsNewSubscriptionsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribedDocument[]
getWhatsNewTopLevelCommunity
(Long coid_, Long num_) Deprecated.use getWhatsNewTopLevelCommunityPagingDocument[]
getWhatsNewTopLevelCommunityForUser
(Long communityId_, Long num_) Deprecated.use getWhatsNewTopLevelCommunityForUserPagingDocument[]
getWhatsNewTopLevelCommunityForUserPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the latest documents added/updated in the application in a specific community (but not its sub-communties) that the user can accessgetWhatsNewTopLevelCommunityPaging
(Long coid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Retrieves the the latest documents added or updated in a specified community, but not its sub-communities (regardless of user)Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
getTotalUploads$UPDATES
static final boolean getTotalUploads$UPDATES- See Also:
-
getNumberUploads$UPDATES
static final boolean getNumberUploads$UPDATES- See Also:
-
getNumberUploadsPaging$UPDATES
static final boolean getNumberUploadsPaging$UPDATES- See Also:
-
getGeneralStatistics$UPDATES
static final boolean getGeneralStatistics$UPDATES- See Also:
-
getGeneralUserStatistics$UPDATES
static final boolean getGeneralUserStatistics$UPDATES- See Also:
-
getCommunitiesWithMostUploads$UPDATES
static final boolean getCommunitiesWithMostUploads$UPDATES- See Also:
-
getCommunitiesWithMostUploadsPaging$UPDATES
static final boolean getCommunitiesWithMostUploadsPaging$UPDATES- See Also:
-
getKnowledgeCentersWithMostUploads$UPDATES
static final boolean getKnowledgeCentersWithMostUploads$UPDATES- See Also:
-
getKnowledgeCentersWithMostUploadsPaging$UPDATES
static final boolean getKnowledgeCentersWithMostUploadsPaging$UPDATES- See Also:
-
getUploadsByHour$UPDATES
static final boolean getUploadsByHour$UPDATES- See Also:
-
getUploadsByHourPaging$UPDATES
static final boolean getUploadsByHourPaging$UPDATES- See Also:
-
getUploadsByType$UPDATES
static final boolean getUploadsByType$UPDATES- See Also:
-
getUploadsByTypePaging$UPDATES
static final boolean getUploadsByTypePaging$UPDATES- See Also:
-
getUploadsByWeekDays$UPDATES
static final boolean getUploadsByWeekDays$UPDATES- See Also:
-
getUploadsByWeekDaysPaging$UPDATES
static final boolean getUploadsByWeekDaysPaging$UPDATES- See Also:
-
getCommunityAdminReport$UPDATES
static final boolean getCommunityAdminReport$UPDATES- See Also:
-
getCommunityAdminReportPaging$UPDATES
static final boolean getCommunityAdminReportPaging$UPDATES- See Also:
-
getWhatsNewSubscriptions$UPDATES
static final boolean getWhatsNewSubscriptions$UPDATES- See Also:
-
getWhatsNewSubscriptionsPaging$UPDATES
static final boolean getWhatsNewSubscriptionsPaging$UPDATES- See Also:
-
getMoreWhatsNewSubscriptions$UPDATES
static final boolean getMoreWhatsNewSubscriptions$UPDATES- See Also:
-
getMoreWhatsNewSubscriptionsPaging$UPDATES
static final boolean getMoreWhatsNewSubscriptionsPaging$UPDATES- See Also:
-
getWhatsNewCommunityForUser$UPDATES
static final boolean getWhatsNewCommunityForUser$UPDATES- See Also:
-
getWhatsNewCommunityForUserPaging$UPDATES
static final boolean getWhatsNewCommunityForUserPaging$UPDATES- See Also:
-
getWhatsNewTopLevelCommunityForUser$UPDATES
static final boolean getWhatsNewTopLevelCommunityForUser$UPDATES- See Also:
-
getWhatsNewTopLevelCommunityForUserPaging$UPDATES
static final boolean getWhatsNewTopLevelCommunityForUserPaging$UPDATES- See Also:
-
getWhatsNewCommunityPaging$UPDATES
static final boolean getWhatsNewCommunityPaging$UPDATES- See Also:
-
getWhatsNewCommunity$UPDATES
static final boolean getWhatsNewCommunity$UPDATES- See Also:
-
getWhatsNewTopLevelCommunity$UPDATES
static final boolean getWhatsNewTopLevelCommunity$UPDATES- See Also:
-
getWhatsNewTopLevelCommunityPaging$UPDATES
static final boolean getWhatsNewTopLevelCommunityPaging$UPDATES- See Also:
-
getWhatsNewKnowledgeCenter$UPDATES
static final boolean getWhatsNewKnowledgeCenter$UPDATES- See Also:
-
getWhatsNewKnowledgeCenterPaging$UPDATES
static final boolean getWhatsNewKnowledgeCenterPaging$UPDATES- See Also:
-
-
Method Details
-
getTotalUploads
Long getTotalUploads()Gets the total number of uploads to the collaboration application- Returns:
- the total number of uploads
- Throws:
ServiceException
- if any system-level error occurs
-
getNumberUploads
Deprecated.user getNumberUploadsPagingGets the number of uploads in the last N days- Parameters:
days_
- the number of days in the query- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents one day of upload information. The fieldsuploadDate
andnumberOfUploads
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getNumberUploadsPaging
ResultPage getNumberUploadsPaging(Long days_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidDataFormatException Gets the number of uploads in the last N 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - uploadDate
- 1 - numberOfUploads
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents one day of upload information. The fieldsuploadDate
andnumberOfUploads
are the only fields populated. - Throws:
ServiceException
- if any system-level error occursInvalidDataFormatException
- ifdays_
isnull
-
getGeneralStatistics
Statistics getGeneralStatistics()Gets the general usage statistics and patterns of the collaboration application (eg the number of folders created).- Returns:
- a
Statistics
object encapsulating the general usage statistics - Throws:
ServiceException
- if any system-level error occurs
-
getGeneralUserStatistics
UserStatistics getGeneralUserStatistics()Gets user statistics in the collaboration application (eg the number of users who have uploaded documents).- Returns:
- a
UserStatistics
object encapsulating the usage statistics - Throws:
ServiceException
- if any system-level error occurs
-
getCommunitiesWithMostUploads
Deprecated.use getCommunitiesWithMostUploadsPagingGets the top num_ communities with the most uploads- Parameters:
num_
- the top number of communities to return- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents a community's upload information. The fieldscommunityName
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getCommunitiesWithMostUploadsPaging
ResultPage getCommunitiesWithMostUploadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the communities with the most uploads- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - communityName
- 1 - numberOfDocumentsUploaded
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents a community's upload information. The fieldscommunityName
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersWithMostUploads
Deprecated.use getKnowledgeCentersWithMostUploadsPagingGets the top num_ knowledge centers with the most uploads- Parameters:
num_
- the top number of knowledge centers to return- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents a knowledge center's upload information. The fieldsknowledgeCenterName
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersWithMostUploadsPaging
ResultPage getKnowledgeCentersWithMostUploadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the knowledge centers with the most uploads- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - knowledgeCenterName
- 1 - numberOfDocumentsUploaded
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents a knowledge center's upload information. The fieldsknowledgeCenterName
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByHour
UploadStatistics[] getUploadsByHour()Deprecated.use getUploadsByHourPagingGets the number of uploads for each hour- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents upload information for an hour. The fieldsuploadHourOfDay
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByHourPaging
ResultPage getUploadsByHourPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - uploadHourOfDay
- 1 - numberOfDocumentsUploaded
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents upload information for an hour. The fieldsuploadHourOfDay
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByType
UploadStatistics[] getUploadsByType()Deprecated.use getUploadsByTypePagingGets the number of uploads by document extension- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents upload information for a document extension. The fieldsdocumentExtension
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByTypePaging
ResultPage getUploadsByTypePaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads by document extension- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - documentExtension
- 1 - numberOfDocumentsUploaded
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents upload information for a document extension. The fieldsdocumentExtension
andnumberOfDocumensUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByWeekDays
UploadStatistics[] getUploadsByWeekDays()Deprecated.use getUploadsByWeekDaysPagingGets the number of uploads by weekdays- Returns:
- a list of
UploadStatistics
objects. EachUploadStatistics
object represents upload information for a weekday. The fieldsuploadDayOfWeek
andnumberOfDocumentsUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getUploadsByWeekDaysPaging
ResultPage getUploadsByWeekDaysPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the number of uploads 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted:- 0 - uploadDayOfWeek
- 1 - numberOfDocumentsUploaded
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofUploadStatistics
objects. EachUploadStatistics
object represents upload information for a weekday. The fieldsuploadDayOfWeek
andnumberOfDocumentsUploaded
are the only fields populated. - Throws:
ServiceException
- if any system-level error occurs
-
getCommunityAdminReport
Community[] getCommunityAdminReport(Long commid_) throws InvalidUserException, InvalidCommunityException Deprecated.use getCommunityAdminReportPagingGets information about a specified community and all its sub communities- Parameters:
commid_
- the unique ID of the community- Returns:
- a list of
Community
objects which represent the community and sub-communities - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the given community does not exist
-
getCommunityAdminReportPaging
ResultPage getCommunityAdminReportPaging(Long commid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Gets information about a specified community and all its sub communities- Parameters:
commid_
- the unique ID of the communitystartIndex_
- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inCommunity
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofCommunity
objects which represent the community and sub-communities - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the community does not exist
-
getWhatsNewSubscriptions
Deprecated.use getWhatsNewSubscriptionsPagingGets the latest documents 10 documents added/updated in the application in knowledge centers to which the user is subscribed- Returns:
- a list of
Document
objects that represent the top 10 latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.
-
getWhatsNewSubscriptionsPaging
ResultPage getWhatsNewSubscriptionsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribed- 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. Use ofConstants.COUNT_ALL
will result in the entire collection up to the minimum of config property WHATS_NEW_LIMIT (if set, default 500 in collaboration.properties, Integer.MAX_VALUE if not set) and WHATS_NEW_SECURITY_LIMIT (if set, default 1000 in collaboration.properties) from collaboration.properties being returned.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represent the latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.
-
getMoreWhatsNewSubscriptions
Document[] getMoreWhatsNewSubscriptions(String sortColumn_, Integer sortOrder_, Integer sortLength_) throws InvalidUserException Deprecated.use getMoreWhatsNewSubscriptionsPagingGets the latest documents added/updated in the application in knowledge centers to which the user is subscribed- Parameters:
sortColumn_
- the field of theDocument
by which to sort the returned list of documents. This is one of theSORT_COLUMN_XXX
inDocument
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending ordersortLength_
- the maximum number of documents to return- Returns:
- a list of
Document
objects, of maximum lengthsortLength_
which represent the latest documents in a users subscriptions - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.
-
getMoreWhatsNewSubscriptionsPaging
ResultPage getMoreWhatsNewSubscriptionsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribed- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects that represent the latest documents in a user's subscriptions - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.
-
getWhatsNewCommunityForUser
Document[] getWhatsNewCommunityForUser(Long communityId_, Long num_) throws InvalidUserException, InvalidCommunityException Deprecated.use getWhatsNewCommunityForUserPagingGets the latest documents (that the user can access) added/updated in the application in a specific community and its sub-communties- Parameters:
communityId_
- the unique ID of the communitynum_
- the top number of documents to return- Returns:
- a list of
Document
objects which represent the top N latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the community does not exist
-
getWhatsNewCommunityForUserPaging
ResultPage getWhatsNewCommunityForUserPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Gets the latest documents (that the user can access) added/updated in the application in a specific community and its sub-communties- Parameters:
communityId_
- the unique ID of the communitystartIndex_
- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represent the top N latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the community does not exist
-
getWhatsNewTopLevelCommunityForUser
Document[] getWhatsNewTopLevelCommunityForUser(Long communityId_, Long num_) throws InvalidUserException, InvalidCommunityException Deprecated.use getWhatsNewTopLevelCommunityForUserPagingGets the latest documents (that the user can access) added/updated in the application in a specific community (but not its sub-communties)- Parameters:
communityId_
- the unique ID of the communitynum_
- the top number of documents to return- Returns:
- a list of
Document
objects which represent the top num_ latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the community does not exist
-
getWhatsNewTopLevelCommunityForUserPaging
Document[] getWhatsNewTopLevelCommunityForUserPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Gets the latest documents added/updated in the application in a specific community (but not its sub-communties) that the user can access- Parameters:
communityId_
- the unique ID of the communitystartIndex_
- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represents the latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidCommunityException
- if the community does not exist
-
getWhatsNewCommunityPaging
ResultPage getWhatsNewCommunityPaging(Long coid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException Gets the latest documents added/updated in the application in a specific community and its sub-communties (regardless of user)- Parameters:
coid_
- the unique ID of the communitystartIndex_
- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represent the top N latest documents - Throws:
InvalidCommunityException
- if the community does not existServiceException
- if any system-level error occurs
-
getWhatsNewCommunity
Document[] getWhatsNewCommunity(Long coid_, Long num_) throws InvalidCommunityException, InvalidDataFormatException Deprecated.use getWhatsNewCommunityPagingGets the latest documents added/updated in the application in a specific community and its sub-communties (regardless of user)- Parameters:
coid_
- the unique ID of the communitynum_
- the top number of documents to return- Returns:
- a list of
Document
objects which represent the top N latest documents - Throws:
InvalidCommunityException
- if the community does not existServiceException
- if any system-level error occursInvalidDataFormatException
-
getWhatsNewTopLevelCommunity
Deprecated.use getWhatsNewTopLevelCommunityPagingRetrieves the the top N latest documents added or updated in a specified community, but not its sub-communities (regardless of user)- Parameters:
coid_
- the unique ID of the communitynum_
- the top number of documents to return- Returns:
- a list of
Document
objects which represent the documents - Throws:
ServiceException
- if any system-level error occursInvalidCommunityException
- if the community does not exist
-
getWhatsNewTopLevelCommunityPaging
ResultPage getWhatsNewTopLevelCommunityPaging(Long coid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException Retrieves the the latest documents added or updated in a specified community, but not its sub-communities (regardless of user)- Parameters:
coid_
- the unique ID of the communitystartIndex_
- 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represents the documents - Throws:
ServiceException
- if any system-level error occursInvalidCommunityException
- if the community does not exist
-
getWhatsNewKnowledgeCenter
Document[] getWhatsNewKnowledgeCenter(Long kcid_, Integer sortOrder_, String sortColumn_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.use getWhatsNewKnowledgeCenterPagingRetrieves the top N latest documents added or updated in a specified knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centersortColumn_
- the field of theDocument
by which to sort the returned list of documents. This is one of theSORT_COLUMN_XXX
inDocument
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a list of
Document
objects which represent the top N latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the current user service context is invalid.InvalidKnowledgeCenterException
- if theKnowledgeCenter
does not exist
-
getWhatsNewKnowledgeCenterPaging
ResultPage getWhatsNewKnowledgeCenterPaging(Long kcid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Retrieves the top N latest documents added or updated in a specified 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. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing a list ofDocument
objects which represent the top N latest documents - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the logged in user does not have accessInvalidKnowledgeCenterException
- if theKnowledgeCenter
does not exist
-