Package com.appiancorp.suiteapi.forums

Interface DiscussionMetadataConvenienceService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface DiscussionMetadataConvenienceService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.
Defines the convenience methods available from the discussion forum server.

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

    • SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED

      static final Integer SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED
      Deprecated.
      A constant sort property for ThreadSummary

    • SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT

      static final Integer SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT
      Deprecated.
      A constant sort property for ThreadSummary

    • SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT

      static final Integer SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT
      Deprecated.
      A constant sort property for ThreadSummary

    • getForumSummary$UPDATES

      @Deprecated(forRemoval=true) static final boolean getForumSummary$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getForumSummaries$UPDATES

      @Deprecated(forRemoval=true) static final boolean getForumSummaries$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getForumSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getForumSummariesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadSummary$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadSummary$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadSummaries$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadSummaries$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadSummariesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSponsoredThreadSummaries$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSponsoredThreadSummaries$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSponsoredThreadSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSponsoredThreadSummariesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadedMessages$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadedMessages$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadedMessagesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadedMessagesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedForumSummaries$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedForumSummaries$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedForumSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedForumSummariesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedThreadSummaries$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedThreadSummaries$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedThreadSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedThreadSummariesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadSummariesForForum$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadSummariesForForum$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getThreadSummariesForForumPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getThreadSummariesForForumPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • getForumSummary

      @Read(K_FORUMS) ForumSummary getForumSummary(Long id_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Get the summary for a forum.
      Parameters:
      id_ - The local id of the forum to be summarized.
      Returns:
      A ForumSummary object relating to the given id.
      Throws:
      InvalidForumException - if the forum is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for the given forum.

    • getForumSummaries

      @Deprecated @Read(K_FORUMS) ForumSummary[] getForumSummaries(Long[] ids_) throws InvalidForumException
      Deprecated.
      use getForumSummariesPaging instead
      Get the summaries that the current user can access for a set of forums.
      Parameters:
      ids_ - The local ids of the forums to be summarized.
      Returns:
      An array of ForumSummary objects in the same order as the incoming ids. Forums which the user does not have access to will simply not be returned with the results.
      Throws:
      InvalidForumException - if any of the forums is invalid

    • getForumSummariesPaging

      @Read(K_FORUMS) ResultPage getForumSummariesPaging(Long[] ids_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Get the summaries that the current user can access for a set of forums
      Parameters:
      ids_ - The local ids of the forums to be summarized.
      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_PROPERTY_FORUM_XXX constants in ForumSummary
      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 the list of the ForumSummary objects for forums in the same order as the incoming ids.
      Throws:
      InvalidForumException - if any of the forums is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for the given forum.

    • getThreadSummary

      @Read(K_FORUMS) ThreadSummary getThreadSummary(Long threadId_) throws InvalidThreadException, PrivilegeException
      Deprecated.
      Get the summary for a thread.
      Parameters:
      threadId_ - The id of the thread.
      Returns:
      A ThreadSummary object corresponding to the given thread id.
      Throws:
      InvalidThreadException - if the thread does not exist
      PrivilegeException - If the user is not contained in the list of participants within ThreadRoleMap for the given thread.

    • getThreadSummaries

      @Deprecated @Read(K_FORUMS) ThreadSummary[] getThreadSummaries(Long[] threadIds_) throws InvalidThreadException, PrivilegeException
      Deprecated.
      use getThreadSummariesPaging instead
      Get the summaries for threads.
      Parameters:
      threadIds_ - The ids of the threads.
      Returns:
      An array of ThreadSummary objects in the order of the given thread ids.
      Throws:
      InvalidThreadException - if any of the threads does not exist
      PrivilegeException - If the user is not contained in the list of participants within ThreadRoleMap for any of the given threads.

    • getThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getThreadSummariesPaging(Long[] threadIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidThreadException, PrivilegeException
      Deprecated.
      Get the summaries for threads.
      Parameters:
      threadIds_ - The ids of the threads.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      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 the list of ThreadSummary objects representing the thread summaries for threadIds_
      Throws:
      InvalidThreadException - if any of the threads does not exist
      PrivilegeException - If the user is not contained in the list of participants within ThreadRoleMap for any of the given threads.

    • getSponsoredThreadSummaries

      @Deprecated @Read(K_FORUMS) ThreadSummary[] getSponsoredThreadSummaries(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
      Deprecated.
      use getSponsoredThreadSummariesPaging instead
      Get a set of summaries for the sponsored threads in a forum.
      Parameters:
      forumId_ - The local id of the forum containing the sponsored threads.
      sortProperty_ - the property by which the results will be sorted This is one of the SORT_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      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.
      Returns:
      An array of ThreadSummary objects corresponding to the sponsored threads within the given forum
      Throws:
      InvalidForumException - if the forum is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap the given forum.

    • getSponsoredThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getSponsoredThreadSummariesPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Get a set of summaries for the sponsored threads in a forum.
      Parameters:
      forumId_ - The local id of the forum containing the sponsored threads.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      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 the list of ThreadSummary objects for each sponsored thread within the given forum.
      Throws:
      InvalidForumException - if the forum is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap the given forum.

    • getSponsoredThreadSummaries

      @Deprecated @Read(K_FORUMS) ThreadSummary[] getSponsoredThreadSummaries(Long[] forumIds_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
      Deprecated.
      use getSponsoredThreadSummariesPaging instead
      Get a set of summaries for the sponsored threads in a set of forums.
      Parameters:
      forumIds_ - The local ids of the forums containing the sponsored threads.
      sortProperty_ - the property by which the results will be sorted This is one of the SORT_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      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.
      Returns:
      An array of ThreadSummary objects corresponding to the sponsored threads within the given forums
      Throws:
      InvalidForumException - if any of the forums is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for any of the given forums.

    • getSponsoredThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getSponsoredThreadSummariesPaging(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Get a set of summaries for the sponsored threads in a set of forums.
      Parameters:
      forumIds_ - The local ids of the forums containing the sponsored threads.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      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 the list of ThreadSummary objects for each sponsored thread within the given forums.
      Throws:
      InvalidForumException - if any of the forums is invalid
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for any of the given forums.

    • getThreadedMessages

      @Deprecated @Read(K_FORUMS) ThreadedMessage[] getThreadedMessages(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) throws InvalidForumException
      Deprecated.
      use getThreadedMessagesPaging instead
      Get messages that the current user can access for a forum
      Parameters:
      forumId_ - The id of the forum containing the messages.
      sortProperty_ - the property by which the results will be sorted This is one of the SORT_BY_XXX constants in ThreadedMessage
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      count_ - Constants.COUNT_ALL will result in the entire collection being returned, but this is STRONGLY discouraged.
      Returns:
      The array of ThreadedMessage objects. A zero-length array if there are no messages.
      Throws:
      InvalidForumException - if the forum is invalid

    • getThreadedMessagesPaging

      @Read(K_FORUMS) ResultPage getThreadedMessagesPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException
      Deprecated.
      Get messages that the current user can access for a forum.
      Parameters:
      forumId_ - The id of the forum containing the messages.
      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 ThreadedMessage
      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 the list of ThreadedMessage objects representing the messages in the forum
      Throws:
      InvalidForumException - if the forum is invalid

    • getSubscribedForumSummaries

      @Deprecated @Read(K_FORUMS) ForumSummary[] getSubscribedForumSummaries(Integer sortProperty_, Integer sortOrder_, int startIndex_, int batchSize_)
      Deprecated.
      use getSubscribedForumSummariesPaging instead
      Gets the forums to which the user is subscribed.
      Parameters:
      sortProperty_ - the property by which the results will be sorted This is one of the SORT_PROPERTY_FORUM_XXX constants in ForumSummary
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      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.
      Returns:
      An array of ForumSummary objects corresponding to the forums to which the user is subscribed.

    • getSubscribedForumSummariesPaging

      @Read(K_FORUMS) ResultPage getSubscribedForumSummariesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Gets the forums to which the user is subscribed as ResultPage.
      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_PROPERTY_FORUM_XXX constants in ForumSummary
      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 the ForumSummary objects representing the forums to which the user is subscribed.

    • getSubscribedThreadSummaries

      @Deprecated @Read(K_FORUMS) ThreadSummary[] getSubscribedThreadSummaries(Integer sortProperty_, Integer sortOrder_, int startIndex_, int batchSize_)
      Deprecated.
      use getSubscribedThreadSummariesPaging instead
      Gets the threads to which the user is subscribed.
      Parameters:
      sortProperty_ - the property by which the results will be sorted This is one of the SORT_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      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.
      Returns:
      an array of ThreadSummary corresponding to the threads to which the user is subscribed.

    • getSubscribedThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getSubscribedThreadSummariesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Gets the summaries of threads to which the user is subscribed as ResultPages.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      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 the list of ThreadSummary objects representing the threads to which the user is subscribed

    • getThreadSummariesForForum

      @Deprecated @Read(K_FORUMS) ThreadSummary[] getThreadSummariesForForum(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
      Deprecated.
      use getThreadSummariesForForumPaging instead
      Gets the summaries of threads in the forum.
      Parameters:
      forumId_ - The forum id.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      Returns:
      an array of ThreadSummary objects containing the summaries of threads in the given forum.
      Throws:
      InvalidForumException - if the forum does not exist
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for the given forum.

    • getThreadSummariesForForumPaging

      @Read(K_FORUMS) ResultPage getThreadSummariesForForumPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Gets the summaries of threads in the forum as ResultPage.
      Parameters:
      forumId_ - The forum id.
      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_PROPERTY_THREAD_SUMMARY_XXX constants in ThreadSummary
      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 the list of ThreadSummary objects representing the thread summaries for the forum
      Throws:
      InvalidForumException - if the forum does not exist
      PrivilegeException - If the user is not contained in the list of participants within ForumsRoleMap for the given forum.