Package 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:

  • 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

      UploadStatistics[] getNumberUploads(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(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 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(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_, 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 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(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_, 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 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_, 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 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_, 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 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_, 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 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(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(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 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_, 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 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(String sortColumn_, Integer sortOrder_, 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_, 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 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(Long communityId_, 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(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 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(Long communityId_, 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(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 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(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 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(Long coid_, 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(Long coid_, 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(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 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(Long kcid_, Integer sortOrder_, 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(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 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