com.appiancorp.suiteapi.forums

Interface DiscussionMetadataConvenienceService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

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.

@Deprecated
public interface DiscussionMetadataConvenienceService
extends com.appiancorp.services.ContextSensitiveService

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:

DiscussionBodyService, DiscussionMetadataCoreService, ForumsSearchService

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	getForumSummaries$UPDATES Deprecated.
static boolean	getForumSummariesPaging$UPDATES Deprecated.
static boolean	getForumSummary$UPDATES Deprecated.
static boolean	getSponsoredThreadSummaries$UPDATES Deprecated.
static boolean	getSponsoredThreadSummariesPaging$UPDATES Deprecated.
static boolean	getSubscribedForumSummaries$UPDATES Deprecated.
static boolean	getSubscribedForumSummariesPaging$UPDATES Deprecated.
static boolean	getSubscribedThreadSummaries$UPDATES Deprecated.
static boolean	getSubscribedThreadSummariesPaging$UPDATES Deprecated.
static boolean	getThreadedMessages$UPDATES Deprecated.
static boolean	getThreadedMessagesPaging$UPDATES Deprecated.
static boolean	getThreadSummaries$UPDATES Deprecated.
static boolean	getThreadSummariesForForum$UPDATES Deprecated.
static boolean	getThreadSummariesForForumPaging$UPDATES Deprecated.
static boolean	getThreadSummariesPaging$UPDATES Deprecated.
static boolean	getThreadSummary$UPDATES Deprecated.
static java.lang.Integer	SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED Deprecated. A constant sort property for ThreadSummary
static java.lang.Integer	SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT Deprecated. A constant sort property for ThreadSummary
static java.lang.Integer	SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT Deprecated. A constant sort property for ThreadSummary

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
ForumSummary[]	getForumSummaries(java.lang.Long[] ids_) Deprecated. use getForumSummariesPaging instead
ResultPage	getForumSummariesPaging(java.lang.Long[] ids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Get the summaries that the current user can access for a set of forums
ForumSummary	getForumSummary(java.lang.Long id_) Deprecated. Get the summary for a forum.
ThreadSummary[]	getSponsoredThreadSummaries(java.lang.Long[] forumIds_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) Deprecated. use getSponsoredThreadSummariesPaging instead
ThreadSummary[]	getSponsoredThreadSummaries(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) Deprecated. use getSponsoredThreadSummariesPaging instead
ResultPage	getSponsoredThreadSummariesPaging(java.lang.Long[] forumIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Get a set of summaries for the sponsored threads in a set of forums.
ResultPage	getSponsoredThreadSummariesPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Get a set of summaries for the sponsored threads in a forum.
ForumSummary[]	getSubscribedForumSummaries(java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) Deprecated. use getSubscribedForumSummariesPaging instead
ResultPage	getSubscribedForumSummariesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets the forums to which the user is subscribed as ResultPage.
ThreadSummary[]	getSubscribedThreadSummaries(java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) Deprecated. use getSubscribedThreadSummariesPaging instead
ResultPage	getSubscribedThreadSummariesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets the summaries of threads to which the user is subscribed as ResultPages.
ThreadedMessage[]	getThreadedMessages(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int count_) Deprecated. use getThreadedMessagesPaging instead
ResultPage	getThreadedMessagesPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Get messages that the current user can access for a forum.
ThreadSummary[]	getThreadSummaries(java.lang.Long[] threadIds_) Deprecated. use getThreadSummariesPaging instead
ThreadSummary[]	getThreadSummariesForForum(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) Deprecated. use getThreadSummariesForForumPaging instead
ResultPage	getThreadSummariesForForumPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets the summaries of threads in the forum as ResultPage.
ResultPage	getThreadSummariesPaging(java.lang.Long[] threadIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Get the summaries for threads.
ThreadSummary	getThreadSummary(java.lang.Long threadId_) Deprecated. Get the summary for a thread.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED

static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED

Deprecated.

A constant sort property for ThreadSummary

SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT

static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT

Deprecated.

A constant sort property for ThreadSummary

SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT

static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT

Deprecated.

A constant sort property for ThreadSummary

getForumSummary$UPDATES

static final boolean getForumSummary$UPDATES

Deprecated.

See Also:

Constant Field Values

getForumSummaries$UPDATES

static final boolean getForumSummaries$UPDATES

Deprecated.

See Also:

Constant Field Values

getForumSummariesPaging$UPDATES

static final boolean getForumSummariesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadSummary$UPDATES

static final boolean getThreadSummary$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadSummaries$UPDATES

static final boolean getThreadSummaries$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadSummariesPaging$UPDATES

static final boolean getThreadSummariesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getSponsoredThreadSummaries$UPDATES

static final boolean getSponsoredThreadSummaries$UPDATES

Deprecated.

See Also:

Constant Field Values

getSponsoredThreadSummariesPaging$UPDATES

static final boolean getSponsoredThreadSummariesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadedMessages$UPDATES

static final boolean getThreadedMessages$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadedMessagesPaging$UPDATES

static final boolean getThreadedMessagesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getSubscribedForumSummaries$UPDATES

static final boolean getSubscribedForumSummaries$UPDATES

Deprecated.

See Also:

Constant Field Values

getSubscribedForumSummariesPaging$UPDATES

static final boolean getSubscribedForumSummariesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getSubscribedThreadSummaries$UPDATES

static final boolean getSubscribedThreadSummaries$UPDATES

Deprecated.

See Also:

Constant Field Values

getSubscribedThreadSummariesPaging$UPDATES

static final boolean getSubscribedThreadSummariesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadSummariesForForum$UPDATES

static final boolean getThreadSummariesForForum$UPDATES

Deprecated.

See Also:

Constant Field Values

getThreadSummariesForForumPaging$UPDATES

static final boolean getThreadSummariesForForumPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

getForumSummary

ForumSummary getForumSummary(java.lang.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.

ServiceException - if any system-level error occurs

getForumSummaries

@Deprecated
ForumSummary[] getForumSummaries(java.lang.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

ServiceException - if any system-level error occurs

getForumSummariesPaging

ResultPage getForumSummariesPaging(java.lang.Long[] ids_,
                                   int startIndex_,
                                   int batchSize_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.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.

ServiceException - if any system-level error occurs

getThreadSummary

ThreadSummary getThreadSummary(java.lang.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.

ServiceException - if any system-level error occurs

getThreadSummaries

@Deprecated
ThreadSummary[] getThreadSummaries(java.lang.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.

ServiceException - if any system-level error occurs

getThreadSummariesPaging

ResultPage getThreadSummariesPaging(java.lang.Long[] threadIds_,
                                    int startIndex_,
                                    int batchSize_,
                                    java.lang.Integer sortProperty_,
                                    java.lang.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.

ServiceException - if any system-level error occurs

getSponsoredThreadSummaries

@Deprecated
ThreadSummary[] getSponsoredThreadSummaries(java.lang.Long forumId_,
                                                        java.lang.Integer sortProperty_,
                                                        java.lang.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.

ServiceException - if any system-level error occurs

getSponsoredThreadSummariesPaging

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

ServiceException - if any system-level error occurs

getSponsoredThreadSummaries

@Deprecated
ThreadSummary[] getSponsoredThreadSummaries(java.lang.Long[] forumIds_,
                                                        java.lang.Integer sortProperty_,
                                                        java.lang.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 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.

ServiceException - if any system-level error occurs

getSponsoredThreadSummariesPaging

ResultPage getSponsoredThreadSummariesPaging(java.lang.Long[] forumIds_,
                                             int startIndex_,
                                             int batchSize_,
                                             java.lang.Integer sortProperty_,
                                             java.lang.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.

ServiceException - if any system-level error occurs

getThreadedMessages

@Deprecated
ThreadedMessage[] getThreadedMessages(java.lang.Long forumId_,
                                                  java.lang.Integer sortProperty_,
                                                  java.lang.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

ServiceException - if any system-level error occurs

getThreadedMessagesPaging

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

ServiceException - if any system-level error occurs

getSubscribedForumSummaries

@Deprecated
ForumSummary[] getSubscribedForumSummaries(java.lang.Integer sortProperty_,
                                                       java.lang.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.

Throws:

ServiceException - if any system-level error occurs

getSubscribedForumSummariesPaging

ResultPage getSubscribedForumSummariesPaging(int startIndex_,
                                             int batchSize_,
                                             java.lang.Integer sortProperty_,
                                             java.lang.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.

Throws:

ServiceException - if any system-level error occurs

getSubscribedThreadSummaries

@Deprecated
ThreadSummary[] getSubscribedThreadSummaries(java.lang.Integer sortProperty_,
                                                         java.lang.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.

Throws:

ServiceException - if any system-level error occurs

getSubscribedThreadSummariesPaging

ResultPage getSubscribedThreadSummariesPaging(int startIndex_,
                                              int batchSize_,
                                              java.lang.Integer sortProperty_,
                                              java.lang.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

Throws:

ServiceException - if any system-level error occurs

getThreadSummariesForForum

@Deprecated
ThreadSummary[] getThreadSummariesForForum(java.lang.Long forumId_,
                                                       java.lang.Integer sortProperty_,
                                                       java.lang.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.

ServiceException - if any system-level error occurs

getThreadSummariesForForumPaging

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

ServiceException - if any system-level error occurs