com.appiancorp.suiteapi.collaboration

Interface ReportingService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

public interface ReportingService
extends com.appiancorp.services.ContextSensitiveService

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.

See Also:

AdministrationService, CollaborationSearchService, CommunityService, DocumentService, FolderService, KnowledgeCenterService, StatisticsService

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	getCommunitiesWithMostUploads$UPDATES
static boolean	getCommunitiesWithMostUploadsPaging$UPDATES
static boolean	getCommunityAdminReport$UPDATES
static boolean	getCommunityAdminReportPaging$UPDATES
static boolean	getGeneralStatistics$UPDATES
static boolean	getGeneralUserStatistics$UPDATES
static boolean	getKnowledgeCentersWithMostUploads$UPDATES
static boolean	getKnowledgeCentersWithMostUploadsPaging$UPDATES
static boolean	getMoreWhatsNewSubscriptions$UPDATES
static boolean	getMoreWhatsNewSubscriptionsPaging$UPDATES
static boolean	getNumberUploads$UPDATES
static boolean	getNumberUploadsPaging$UPDATES
static boolean	getTotalUploads$UPDATES
static boolean	getUploadsByHour$UPDATES
static boolean	getUploadsByHourPaging$UPDATES
static boolean	getUploadsByType$UPDATES
static boolean	getUploadsByTypePaging$UPDATES
static boolean	getUploadsByWeekDays$UPDATES
static boolean	getUploadsByWeekDaysPaging$UPDATES
static boolean	getWhatsNewCommunity$UPDATES
static boolean	getWhatsNewCommunityForUser$UPDATES
static boolean	getWhatsNewCommunityForUserPaging$UPDATES
static boolean	getWhatsNewCommunityPaging$UPDATES
static boolean	getWhatsNewKnowledgeCenter$UPDATES
static boolean	getWhatsNewKnowledgeCenterPaging$UPDATES
static boolean	getWhatsNewSubscriptions$UPDATES
static boolean	getWhatsNewSubscriptionsPaging$UPDATES
static boolean	getWhatsNewTopLevelCommunity$UPDATES
static boolean	getWhatsNewTopLevelCommunityForUser$UPDATES
static boolean	getWhatsNewTopLevelCommunityForUserPaging$UPDATES
static boolean	getWhatsNewTopLevelCommunityPaging$UPDATES

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
UploadStatistics[]	getCommunitiesWithMostUploads(java.lang.Long num_) Deprecated. use getCommunitiesWithMostUploadsPaging
ResultPage	getCommunitiesWithMostUploadsPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the communities with the most uploads
Community[]	getCommunityAdminReport(java.lang.Long commid_) Deprecated. use getCommunityAdminReportPaging
ResultPage	getCommunityAdminReportPaging(java.lang.Long commid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets information about a specified community and all its sub communities
Statistics	getGeneralStatistics() Gets the general usage statistics and patterns of the collaboration application (eg the number of folders created).
UserStatistics	getGeneralUserStatistics() Gets user statistics in the collaboration application (eg the number of users who have uploaded documents).
UploadStatistics[]	getKnowledgeCentersWithMostUploads(java.lang.Long num_) Deprecated. use getKnowledgeCentersWithMostUploadsPaging
ResultPage	getKnowledgeCentersWithMostUploadsPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the knowledge centers with the most uploads
Document[]	getMoreWhatsNewSubscriptions(java.lang.String sortColumn_, java.lang.Integer sortOrder_, java.lang.Integer sortLength_) Deprecated. use getMoreWhatsNewSubscriptionsPaging
ResultPage	getMoreWhatsNewSubscriptionsPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribed
UploadStatistics[]	getNumberUploads(java.lang.Long days_) Deprecated. user getNumberUploadsPaging
ResultPage	getNumberUploadsPaging(java.lang.Long days_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the number of uploads in the last N days
java.lang.Long	getTotalUploads() Gets the total number of uploads to the collaboration application
UploadStatistics[]	getUploadsByHour() Deprecated. use getUploadsByHourPaging
ResultPage	getUploadsByHourPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the number of uploads for each hour
UploadStatistics[]	getUploadsByType() Deprecated. use getUploadsByTypePaging
ResultPage	getUploadsByTypePaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the number of uploads by document extension
UploadStatistics[]	getUploadsByWeekDays() Deprecated. use getUploadsByWeekDaysPaging
ResultPage	getUploadsByWeekDaysPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the number of uploads by weekdays
Document[]	getWhatsNewCommunity(java.lang.Long coid_, java.lang.Long num_) Deprecated. use getWhatsNewCommunityPaging
Document[]	getWhatsNewCommunityForUser(java.lang.Long communityId_, java.lang.Long num_) Deprecated. use getWhatsNewCommunityForUserPaging
ResultPage	getWhatsNewCommunityForUserPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the latest documents (that the user can access) added/updated in the application in a specific community and its sub-communties
ResultPage	getWhatsNewCommunityPaging(java.lang.Long coid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the latest documents added/updated in the application in a specific community and its sub-communties (regardless of user)
Document[]	getWhatsNewKnowledgeCenter(java.lang.Long kcid_, java.lang.Integer sortOrder_, java.lang.String sortColumn_) Deprecated. use getWhatsNewKnowledgeCenterPaging
ResultPage	getWhatsNewKnowledgeCenterPaging(java.lang.Long kcid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Retrieves the top N latest documents added or updated in a specified knowledge center
Document[]	getWhatsNewSubscriptions() Deprecated. use getWhatsNewSubscriptionsPaging
ResultPage	getWhatsNewSubscriptionsPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribed
Document[]	getWhatsNewTopLevelCommunity(java.lang.Long coid_, java.lang.Long num_) Deprecated. use getWhatsNewTopLevelCommunityPaging
Document[]	getWhatsNewTopLevelCommunityForUser(java.lang.Long communityId_, java.lang.Long num_) Deprecated. use getWhatsNewTopLevelCommunityForUserPaging
Document[]	getWhatsNewTopLevelCommunityForUserPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Gets the latest documents added/updated in the application in a specific community (but not its sub-communties) that the user can access
ResultPage	getWhatsNewTopLevelCommunityPaging(java.lang.Long coid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.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 Detail

getTotalUploads$UPDATES

static final boolean getTotalUploads$UPDATES

See Also:

Constant Field Values

getNumberUploads$UPDATES

static final boolean getNumberUploads$UPDATES

See Also:

Constant Field Values

getNumberUploadsPaging$UPDATES

static final boolean getNumberUploadsPaging$UPDATES

See Also:

Constant Field Values

getGeneralStatistics$UPDATES

static final boolean getGeneralStatistics$UPDATES

See Also:

Constant Field Values

getGeneralUserStatistics$UPDATES

static final boolean getGeneralUserStatistics$UPDATES

See Also:

Constant Field Values

getCommunitiesWithMostUploads$UPDATES

static final boolean getCommunitiesWithMostUploads$UPDATES

See Also:

Constant Field Values

getCommunitiesWithMostUploadsPaging$UPDATES

static final boolean getCommunitiesWithMostUploadsPaging$UPDATES

See Also:

Constant Field Values

getKnowledgeCentersWithMostUploads$UPDATES

static final boolean getKnowledgeCentersWithMostUploads$UPDATES

See Also:

Constant Field Values

getKnowledgeCentersWithMostUploadsPaging$UPDATES

static final boolean getKnowledgeCentersWithMostUploadsPaging$UPDATES

See Also:

Constant Field Values

getUploadsByHour$UPDATES

static final boolean getUploadsByHour$UPDATES

See Also:

Constant Field Values

getUploadsByHourPaging$UPDATES

static final boolean getUploadsByHourPaging$UPDATES

See Also:

Constant Field Values

getUploadsByType$UPDATES

static final boolean getUploadsByType$UPDATES

See Also:

Constant Field Values

getUploadsByTypePaging$UPDATES

static final boolean getUploadsByTypePaging$UPDATES

See Also:

Constant Field Values

getUploadsByWeekDays$UPDATES

static final boolean getUploadsByWeekDays$UPDATES

See Also:

Constant Field Values

getUploadsByWeekDaysPaging$UPDATES

static final boolean getUploadsByWeekDaysPaging$UPDATES

See Also:

Constant Field Values

getCommunityAdminReport$UPDATES

static final boolean getCommunityAdminReport$UPDATES

See Also:

Constant Field Values

getCommunityAdminReportPaging$UPDATES

static final boolean getCommunityAdminReportPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewSubscriptions$UPDATES

static final boolean getWhatsNewSubscriptions$UPDATES

See Also:

Constant Field Values

getWhatsNewSubscriptionsPaging$UPDATES

static final boolean getWhatsNewSubscriptionsPaging$UPDATES

See Also:

Constant Field Values

getMoreWhatsNewSubscriptions$UPDATES

static final boolean getMoreWhatsNewSubscriptions$UPDATES

See Also:

Constant Field Values

getMoreWhatsNewSubscriptionsPaging$UPDATES

static final boolean getMoreWhatsNewSubscriptionsPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewCommunityForUser$UPDATES

static final boolean getWhatsNewCommunityForUser$UPDATES

See Also:

Constant Field Values

getWhatsNewCommunityForUserPaging$UPDATES

static final boolean getWhatsNewCommunityForUserPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewTopLevelCommunityForUser$UPDATES

static final boolean getWhatsNewTopLevelCommunityForUser$UPDATES

See Also:

Constant Field Values

getWhatsNewTopLevelCommunityForUserPaging$UPDATES

static final boolean getWhatsNewTopLevelCommunityForUserPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewCommunityPaging$UPDATES

static final boolean getWhatsNewCommunityPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewCommunity$UPDATES

static final boolean getWhatsNewCommunity$UPDATES

See Also:

Constant Field Values

getWhatsNewTopLevelCommunity$UPDATES

static final boolean getWhatsNewTopLevelCommunity$UPDATES

See Also:

Constant Field Values

getWhatsNewTopLevelCommunityPaging$UPDATES

static final boolean getWhatsNewTopLevelCommunityPaging$UPDATES

See Also:

Constant Field Values

getWhatsNewKnowledgeCenter$UPDATES

static final boolean getWhatsNewKnowledgeCenter$UPDATES

See Also:

Constant Field Values

getWhatsNewKnowledgeCenterPaging$UPDATES

static final boolean getWhatsNewKnowledgeCenterPaging$UPDATES

See Also:

Constant Field Values

Method Detail

getTotalUploads

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

UploadStatistics[] getNumberUploads(java.lang.Long days_)

Deprecated. user getNumberUploadsPaging

Gets the number of uploads in the last N days

Parameters:

days_ - the number of days in the query

Returns:

a list of UploadStatistics objects. Each UploadStatistics object represents one day of upload information. The fields uploadDate and numberOfUploads are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getNumberUploadsPaging

ResultPage getNumberUploadsPaging(java.lang.Long days_,
                                  int startIndex_,
                                  int batchSize_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.Integer sortOrder_)
                           throws InvalidDataFormatException

Gets the number of uploads in the last N days

Parameters:

days_ - the number of days in the query

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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents one day of upload information. The fields uploadDate and numberOfUploads are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

InvalidDataFormatException - if days_ is null

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

UploadStatistics[] getCommunitiesWithMostUploads(java.lang.Long num_)

Deprecated. use getCommunitiesWithMostUploadsPaging

Gets the top num_ communities with the most uploads

Parameters:

num_ - the top number of communities to return

Returns:

a list of UploadStatistics objects. Each UploadStatistics object represents a community's upload information. The fields communityName and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getCommunitiesWithMostUploadsPaging

ResultPage getCommunitiesWithMostUploadsPaging(int startIndex_,
                                               int batchSize_,
                                               java.lang.Integer sortProperty_,
                                               java.lang.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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents a community's upload information. The fields communityName and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getKnowledgeCentersWithMostUploads

UploadStatistics[] getKnowledgeCentersWithMostUploads(java.lang.Long num_)

Deprecated. use getKnowledgeCentersWithMostUploadsPaging

Gets 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. Each UploadStatistics object represents a knowledge center's upload information. The fields knowledgeCenterName and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getKnowledgeCentersWithMostUploadsPaging

ResultPage getKnowledgeCentersWithMostUploadsPaging(int startIndex_,
                                                    int batchSize_,
                                                    java.lang.Integer sortProperty_,
                                                    java.lang.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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents a knowledge center's upload information. The fields knowledgeCenterName and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByHour

UploadStatistics[] getUploadsByHour()

Deprecated. use getUploadsByHourPaging

Gets the number of uploads for each hour

Returns:

a list of UploadStatistics objects. Each UploadStatistics object represents upload information for an hour. The fields uploadHourOfDay and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByHourPaging

ResultPage getUploadsByHourPaging(int startIndex_,
                                  int batchSize_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents upload information for an hour. The fields uploadHourOfDay and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByType

UploadStatistics[] getUploadsByType()

Deprecated. use getUploadsByTypePaging

Gets the number of uploads by document extension

Returns:

a list of UploadStatistics objects. Each UploadStatistics object represents upload information for a document extension. The fields documentExtension and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByTypePaging

ResultPage getUploadsByTypePaging(int startIndex_,
                                  int batchSize_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents upload information for a document extension. The fields documentExtension and numberOfDocumensUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByWeekDays

UploadStatistics[] getUploadsByWeekDays()

Deprecated. use getUploadsByWeekDaysPaging

Gets the number of uploads by weekdays

Returns:

a list of UploadStatistics objects. Each UploadStatistics object represents upload information for a weekday. The fields uploadDayOfWeek and numberOfDocumentsUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getUploadsByWeekDaysPaging

ResultPage getUploadsByWeekDaysPaging(int startIndex_,
                                      int batchSize_,
                                      java.lang.Integer sortProperty_,
                                      java.lang.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 of Constants.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 of UploadStatistics objects. Each UploadStatistics object represents upload information for a weekday. The fields uploadDayOfWeek and numberOfDocumentsUploaded are the only fields populated.

Throws:

ServiceException - if any system-level error occurs

getCommunityAdminReport

Community[] getCommunityAdminReport(java.lang.Long commid_)
                             throws InvalidUserException,
                                    InvalidCommunityException

Deprecated. use getCommunityAdminReportPaging

Gets 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 occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the given community does not exist

getCommunityAdminReportPaging

ResultPage getCommunityAdminReportPaging(java.lang.Long commid_,
                                         int startIndex_,
                                         int batchSize_,
                                         java.lang.Integer sortProperty_,
                                         java.lang.Integer sortOrder_)
                                  throws InvalidUserException,
                                         InvalidCommunityException

Gets information about a specified community and all its sub communities

Parameters:

commid_ - the unique ID of the community

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 of Constants.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 the SORT_BY_XXX constants in Community.

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 of Community objects which represent the community and sub-communities

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the community does not exist

getWhatsNewSubscriptions

Document[] getWhatsNewSubscriptions()
                             throws InvalidUserException

Deprecated. use getWhatsNewSubscriptionsPaging

Gets 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 occurs

InvalidUserException - if the current user service context is invalid.

getWhatsNewSubscriptionsPaging

ResultPage getWhatsNewSubscriptionsPaging(int startIndex_,
                                          int batchSize_,
                                          java.lang.Integer sortProperty_,
                                          java.lang.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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represent the latest documents

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

getMoreWhatsNewSubscriptions

Document[] getMoreWhatsNewSubscriptions(java.lang.String sortColumn_,
                                        java.lang.Integer sortOrder_,
                                        java.lang.Integer sortLength_)
                                 throws InvalidUserException

Deprecated. use getMoreWhatsNewSubscriptionsPaging

Gets the latest documents added/updated in the application in knowledge centers to which the user is subscribed

Parameters:

sortColumn_ - the field of the Document by which to sort the returned list of documents. This is one of the SORT_COLUMN_XXX in Document

sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order

sortLength_ - the maximum number of documents to return

Returns:

a list of Document objects, of maximum length sortLength_ which represent the latest documents in a users subscriptions

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

getMoreWhatsNewSubscriptionsPaging

ResultPage getMoreWhatsNewSubscriptionsPaging(int startIndex_,
                                              int batchSize_,
                                              java.lang.Integer sortProperty_,
                                              java.lang.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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects that represent the latest documents in a user's subscriptions

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

getWhatsNewCommunityForUser

Document[] getWhatsNewCommunityForUser(java.lang.Long communityId_,
                                       java.lang.Long num_)
                                throws InvalidUserException,
                                       InvalidCommunityException

Deprecated. use getWhatsNewCommunityForUserPaging

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 community

num_ - 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 occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the community does not exist

getWhatsNewCommunityForUserPaging

ResultPage getWhatsNewCommunityForUserPaging(java.lang.Long communityId_,
                                             int startIndex_,
                                             int batchSize_,
                                             java.lang.Integer sortProperty_,
                                             java.lang.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 community

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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represent the top N latest documents

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the community does not exist

getWhatsNewTopLevelCommunityForUser

Document[] getWhatsNewTopLevelCommunityForUser(java.lang.Long communityId_,
                                               java.lang.Long num_)
                                        throws InvalidUserException,
                                               InvalidCommunityException

Deprecated. use getWhatsNewTopLevelCommunityForUserPaging

Gets 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 community

num_ - 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 occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the community does not exist

getWhatsNewTopLevelCommunityForUserPaging

Document[] getWhatsNewTopLevelCommunityForUserPaging(java.lang.Long communityId_,
                                                     int startIndex_,
                                                     int batchSize_,
                                                     java.lang.Integer sortProperty_,
                                                     java.lang.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 community

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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represents the latest documents

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the current user service context is invalid.

InvalidCommunityException - if the community does not exist

getWhatsNewCommunityPaging

ResultPage getWhatsNewCommunityPaging(java.lang.Long coid_,
                                      int startIndex_,
                                      int batchSize_,
                                      java.lang.Integer sortProperty_,
                                      java.lang.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 community

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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represent the top N latest documents

Throws:

InvalidCommunityException - if the community does not exist

ServiceException - if any system-level error occurs

getWhatsNewCommunity

Document[] getWhatsNewCommunity(java.lang.Long coid_,
                                java.lang.Long num_)
                         throws InvalidCommunityException,
                                InvalidDataFormatException

Deprecated. use getWhatsNewCommunityPaging

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 community

num_ - 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 exist

ServiceException - if any system-level error occurs

InvalidDataFormatException

getWhatsNewTopLevelCommunity

Document[] getWhatsNewTopLevelCommunity(java.lang.Long coid_,
                                        java.lang.Long num_)
                                 throws InvalidCommunityException

Deprecated. use getWhatsNewTopLevelCommunityPaging

Retrieves 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 community

num_ - the top number of documents to return

Returns:

a list of Document objects which represent the documents

Throws:

ServiceException - if any system-level error occurs

InvalidCommunityException - if the community does not exist

getWhatsNewTopLevelCommunityPaging

ResultPage getWhatsNewTopLevelCommunityPaging(java.lang.Long coid_,
                                              int startIndex_,
                                              int batchSize_,
                                              java.lang.Integer sortProperty_,
                                              java.lang.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 community

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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represents the documents

Throws:

ServiceException - if any system-level error occurs

InvalidCommunityException - if the community does not exist

getWhatsNewKnowledgeCenter

Document[] getWhatsNewKnowledgeCenter(java.lang.Long kcid_,
                                      java.lang.Integer sortOrder_,
                                      java.lang.String sortColumn_)
                               throws InvalidUserException,
                                      InvalidKnowledgeCenterException

Deprecated. use getWhatsNewKnowledgeCenterPaging

Retrieves the top N latest documents added or updated in a specified knowledge center

Parameters:

kcid_ - the unique ID of the knowledge center

sortColumn_ - the field of the Document by which to sort the returned list of documents. This is one of the SORT_COLUMN_XXX in Document

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 occurs

InvalidUserException - if the current user service context is invalid.

InvalidKnowledgeCenterException - if the KnowledgeCenter does not exist

getWhatsNewKnowledgeCenterPaging

ResultPage getWhatsNewKnowledgeCenterPaging(java.lang.Long kcid_,
                                            int startIndex_,
                                            int batchSize_,
                                            java.lang.Integer sortProperty_,
                                            java.lang.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 center

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 of Constants.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 the SORT_BY_XXX constants in Document.

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 of Document objects which represent the top N latest documents

Throws:

ServiceException - if any system-level error occurs

InvalidUserException - if the logged in user does not have access

InvalidKnowledgeCenterException - if the KnowledgeCenter does not exist