@Deprecated
public interface DiscussionMetadataConvenienceService
extends com.appiancorp.services.ContextSensitiveService
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.
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
|
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.
|
static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_DATE_MODIFIED
static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_ROOT_SUBJECT
static final java.lang.Integer SORT_PROPERTY_THREAD_SUMMARY_MESSAGE_COUNT
static final boolean getForumSummary$UPDATES
static final boolean getForumSummaries$UPDATES
static final boolean getForumSummariesPaging$UPDATES
static final boolean getThreadSummary$UPDATES
static final boolean getThreadSummaries$UPDATES
static final boolean getThreadSummariesPaging$UPDATES
static final boolean getSponsoredThreadSummaries$UPDATES
static final boolean getSponsoredThreadSummariesPaging$UPDATES
static final boolean getThreadedMessages$UPDATES
static final boolean getThreadedMessagesPaging$UPDATES
static final boolean getSubscribedForumSummaries$UPDATES
static final boolean getSubscribedForumSummariesPaging$UPDATES
static final boolean getSubscribedThreadSummaries$UPDATES
static final boolean getSubscribedThreadSummariesPaging$UPDATES
static final boolean getThreadSummariesForForum$UPDATES
static final boolean getThreadSummariesForForumPaging$UPDATES
ForumSummary getForumSummary(java.lang.Long id_) throws InvalidForumException, PrivilegeException
id_
- The local id of the forum to be summarized.ForumSummary
object relating to the
given id.InvalidForumException
- if the forum is invalidPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
for the given forum.ServiceException
- if any system-level error occurs@Deprecated ForumSummary[] getForumSummaries(java.lang.Long[] ids_) throws InvalidForumException
ids_
- The local ids of the forums to be summarized.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.InvalidForumException
- if any of the forums is invalidServiceException
- if any system-level error occursResultPage getForumSummariesPaging(java.lang.Long[] ids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidForumException, PrivilegeException
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 orderResultPage
containing the list of the
ForumSummary
objects for forums
in the same order as the incoming ids.InvalidForumException
- if any of the forums is invalidPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
for the given forum.ServiceException
- if any system-level error occursThreadSummary getThreadSummary(java.lang.Long threadId_) throws InvalidThreadException, PrivilegeException
threadId_
- The id of the thread.ThreadSummary
object corresponding to the given
thread id.InvalidThreadException
- if the thread does not existPrivilegeException
- If the user is not contained in the
list of participants within
ThreadRoleMap
for the given thread.ServiceException
- if any system-level error occurs@Deprecated ThreadSummary[] getThreadSummaries(java.lang.Long[] threadIds_) throws InvalidThreadException, PrivilegeException
threadIds_
- The ids of the threads.ThreadSummary
objects in the order
of the given thread ids.InvalidThreadException
- if any of the threads does not existPrivilegeException
- 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 occursResultPage getThreadSummariesPaging(java.lang.Long[] threadIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidThreadException, PrivilegeException
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 orderThreadSummary
objects representing the thread summaries for
threadIds_
InvalidThreadException
- if any of the threads does not existPrivilegeException
- 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@Deprecated ThreadSummary[] getSponsoredThreadSummaries(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
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 orderstartIndex_
- 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.ThreadSummary
objects corresponding
to the sponsored threads within the given forumInvalidForumException
- if the forum is invalidPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
the given forum.ServiceException
- if any system-level error occursResultPage getSponsoredThreadSummariesPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidForumException, PrivilegeException
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 orderResultPage
containing the list of
ThreadSummary
objects for each sponsored thread
within the given forum.InvalidForumException
- if the forum is invalidPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
the given forum.ServiceException
- if any system-level error occurs@Deprecated ThreadSummary[] getSponsoredThreadSummaries(java.lang.Long[] forumIds_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
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 orderstartIndex_
- 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.ThreadSummary
objects corresponding to
the sponsored sponsored threads within the given forumsInvalidForumException
- if any of the forums is invalidPrivilegeException
- 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 occursResultPage getSponsoredThreadSummariesPaging(java.lang.Long[] forumIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidForumException, PrivilegeException
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 orderResultPage
containing the list of
ThreadSummary
objects for each sponsored thread
within the given forums.InvalidForumException
- if any of the forums is invalidPrivilegeException
- 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@Deprecated ThreadedMessage[] getThreadedMessages(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int count_) throws InvalidForumException
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 ordercount_
- Constants.COUNT_ALL
will
result in the entire collection being returned, but this is
STRONGLY discouraged.ThreadedMessage
objects.
A zero-length array if there are no messages.InvalidForumException
- if the forum is invalidServiceException
- if any system-level error occursResultPage getThreadedMessagesPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidForumException
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 orderThreadedMessage
objects representing the messages in the forumInvalidForumException
- if the forum is invalidServiceException
- if any system-level error occurs@Deprecated ForumSummary[] getSubscribedForumSummaries(java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_)
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 orderstartIndex_
- 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.ForumSummary
objects corresponding to
the forums to which the user is subscribed.ServiceException
- if any system-level error occursResultPage getSubscribedForumSummariesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
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 orderResultPage
containing a list of the
ForumSummary
objects representing the forums to
which the user is subscribed.ServiceException
- if any system-level error occurs@Deprecated ThreadSummary[] getSubscribedThreadSummaries(java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_)
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 orderstartIndex_
- 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.ThreadSummary
corresponding to the
threads to which the user is subscribed.ServiceException
- if any system-level error occursResultPage getSubscribedThreadSummariesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
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 orderResultPage
containing the list of
ThreadSummary
objects representing the threads to
which the user is subscribedServiceException
- if any system-level error occurs@Deprecated ThreadSummary[] getThreadSummariesForForum(java.lang.Long forumId_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_, int startIndex_, int batchSize_) throws InvalidForumException, PrivilegeException
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 orderThreadSummary
objects containing
the summaries of threads in the given forum.InvalidForumException
- if the forum does not existPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
for the given forum.ServiceException
- if any system-level error occursResultPage getThreadSummariesForForumPaging(java.lang.Long forumId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidForumException, PrivilegeException
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 orderResultPage
containing the list of
ThreadSummary
objects representing the thread
summaries for the forumInvalidForumException
- if the forum does not existPrivilegeException
- If the user is not contained in the
list of participants within
ForumsRoleMap
for the given forum.ServiceException
- if any system-level error occursCopyright © 2003-2024 Appian Corporation. All Rights Reserved.