Package com.appiancorp.suiteapi.forums

Interface DiscussionMetadataCoreService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface DiscussionMetadataCoreService 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 core methods for managing discussion forums. Forums contain topics (aka threads) which contain messages. Messages can have child messages, which are the replies to the message. A forum can be related to a LocalObject, such as a Document or Knowledge Center. Forums can be public or private. Anyone can view and post to a public forum, whereas only selected users can view and post to a private forum (as specified in the actors role map).

A user can subscribe to a topic/thread, in which case he/she will receive a notification whenever a new message is posted to the thread. If the user subscribes to a forum, he/she will receive a notification whenever a new message is posted to any of the topics in the forum.

Individual topics can be sponsored, which provides a way of flagging more important topics. Topics can then be retrieved or sorted based on the sponsored flag. Sponsoring is not connected to the user who marks the topic as sponsored (the topic is simply marked as "sponsored").

Individual messages can be rated by users.

Security for discussion forums is managed through the ForumsRoleMap class.

NOTE: This service only deals with discussion forums metadata, it does not write any content to disk. The DiscussionBodyService should be used to save content.

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

    • MESSAGE_PERMISSION_INVALID

      static final int MESSAGE_PERMISSION_INVALID
      Deprecated.
      Indicates that no permissions can be obtained for the message because the specified message was null or does not exist
      See Also:

    • MESSAGE_PERMISSION_CANNOT_VIEW

      static final int MESSAGE_PERMISSION_CANNOT_VIEW
      Deprecated.
      Indicates that the user is not allowed to view the message
      See Also:

    • MESSAGE_PERMISSION_CAN_VIEW

      static final int MESSAGE_PERMISSION_CAN_VIEW
      Deprecated.
      Indicates that the user is allowed to view the message
      See Also:

    • ACTION_FORUM_CREATE_THREAD

      static final Integer ACTION_FORUM_CREATE_THREAD
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can create threads in the forum

    • ACTION_FORUM_UPDATE

      static final Integer ACTION_FORUM_UPDATE
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can update the forum

    • ACTION_FORUM_DELETE

      static final Integer ACTION_FORUM_DELETE
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can delete the forum

    • ACTION_FORUM_VIEW

      static final Integer ACTION_FORUM_VIEW
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can view the forum

    • ACTION_FORUM_SUBSCRIBE

      static final Integer ACTION_FORUM_SUBSCRIBE
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can subscribe to the forum

    • ACTION_FORUM_UNSUBSCRIBE

      static final Integer ACTION_FORUM_UNSUBSCRIBE
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can unsubscribe from the forum

    • ACTION_FORUM_SPONSOR_THREAD

      static final Integer ACTION_FORUM_SPONSOR_THREAD
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can sponsor a thread in the forum

    • ACTION_FORUM_UNSPONSOR_THREAD

      static final Integer ACTION_FORUM_UNSPONSOR_THREAD
      Deprecated.
      The index of the element in the allowedActions field of the Forum bean that indicates whether the user can unsponsor a thread in the forum

    • ACTION_THREAD_CREATE_MESSAGE

      static final Integer ACTION_THREAD_CREATE_MESSAGE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can create a message in the thread

    • ACTION_THREAD_UPDATE

      static final Integer ACTION_THREAD_UPDATE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can update the thread

    • ACTION_THREAD_DELETE

      static final Integer ACTION_THREAD_DELETE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can delete the thread

    • ACTION_THREAD_MOVE

      static final Integer ACTION_THREAD_MOVE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can move the thread

    • ACTION_THREAD_VIEW

      static final Integer ACTION_THREAD_VIEW
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can view the thread

    • ACTION_THREAD_ADD_RESOURCE

      static final Integer ACTION_THREAD_ADD_RESOURCE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can add a resource to the thread

    • ACTION_THREAD_REMOVE_RESOURCE

      static final Integer ACTION_THREAD_REMOVE_RESOURCE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can remove a resource from the thread

    • ACTION_THREAD_SUBSCRIBE

      static final Integer ACTION_THREAD_SUBSCRIBE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can subscribe to the thread

    • ACTION_THREAD_UNSUBSCRIBE

      static final Integer ACTION_THREAD_UNSUBSCRIBE
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can unsubscribe from the thread

    • ACTION_THREAD_SPONSOR

      static final Integer ACTION_THREAD_SPONSOR
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can sponsor the thread

    • ACTION_THREAD_UNSPONSOR

      static final Integer ACTION_THREAD_UNSPONSOR
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can unsponsor the thread

    • ACTION_THREAD_INVITE_OTHER_USERS

      static final Integer ACTION_THREAD_INVITE_OTHER_USERS
      Deprecated.
      The index of the element in the allowedActions field of the ThreadSummary bean that indicates whether the user can invite other users to the thread

    • ACTION_MESSAGE_UPDATE

      static final Integer ACTION_MESSAGE_UPDATE
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can update the message

    • ACTION_MESSAGE_DELETE

      static final Integer ACTION_MESSAGE_DELETE
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can delete the message

    • ACTION_MESSAGE_DELETE_WITH_DESCENDANTS

      static final Integer ACTION_MESSAGE_DELETE_WITH_DESCENDANTS
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can delete the message and its descendents

    • ACTION_MESSAGE_ADD_RATING

      static final Integer ACTION_MESSAGE_ADD_RATING
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can add a rating to the message

    • ACTION_MESSAGE_SET_RATING

      static final Integer ACTION_MESSAGE_SET_RATING
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can set the rating of the message

    • ACTION_MESSAGE_VIEW

      static final Integer ACTION_MESSAGE_VIEW
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can view the message

    • ACTION_MESSAGE_VIEW_ANONYMOUS

      static final Integer ACTION_MESSAGE_VIEW_ANONYMOUS
      Deprecated.
      The index of the element in the allowedActions field of the Message bean that indicates whether the user can anonymously view the message

    • createForum$UPDATES

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

    • setAdministratorGroup$UPDATES

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

    • updateForum$UPDATES

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

    • updateForums$UPDATES

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

    • deleteForum$UPDATES

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

    • getForum$UPDATES

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

    • getForums$UPDATES

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

    • getForumIdsByRelated$UPDATES

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

    • deleteThread$UPDATES

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

    • getThread$UPDATES

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

    • getThreads$UPDATES

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

    • getThreadsForForum$UPDATES

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

    • getThreadsForForumPaging$UPDATES

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

    • moveThread$UPDATES

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

    • addThreadResource$UPDATES

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

    • addThreadResources$UPDATES

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

    • removeThreadResource$UPDATES

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

    • removeThreadResources$UPDATES

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

    • subscribeToThread$UPDATES

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

    • subscribeUsersToThread$UPDATES

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

    • unsubscribeFromThread$UPDATES

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

    • isSubscribedToThread$UPDATES

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

    • getSubscribersForThread$UPDATES

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

    • sponsor$UPDATES

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

    • unsponsor$UPDATES

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

    • sponsorForMessage$UPDATES

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

    • unsponsorForMessage$UPDATES

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

    • createMessage$UPDATES

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

    • updateMessage$UPDATES

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

    • updateMessages$UPDATES

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

    • getMessage$UPDATES

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

    • getMessages$UPDATES

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

    • getMessagesForThread$UPDATES

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

    • addRating$UPDATES

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

    • setRating$UPDATES

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

    • deleteMessageAndDescendants$UPDATES

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

    • deleteMessage$UPDATES

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

    • setRoleMapForForum$UPDATES

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

    • getRoleMapForForum$UPDATES

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

    • getRoleMapForThread$UPDATES

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

    • activateUserSession$UPDATES

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

    • getUsersToNotify$UPDATES

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

    • getUsersToNotifyForForum$UPDATES

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

    • isSubscribedToForum$UPDATES

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

    • subscribeToForum$UPDATES

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

    • unsubscribeFromForum$UPDATES

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

    • enableForumAnonymousPosting$UPDATES

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

    • disableForumAnonymousPosting$UPDATES

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

    • setForumPublic$UPDATES

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

    • setForumPrivate$UPDATES

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

    • getForumsPaging$UPDATES

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

    • findForumsPaging$UPDATES

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

    • getAllForumsPaging$UPDATES

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

    • getAllForumSummariesPaging$UPDATES

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

    • getThreadsPaging$UPDATES

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

    • getMessagesPaging$UPDATES

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

    • getForumIdsByRelatedPaging$UPDATES

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

    • getMessagesForThreadPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getMessagesForThreadPaging$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:

    • getValidForumSummariesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getValidForumSummariesPaging$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:

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

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

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

    • addActorsToRolesInForums$UPDATES

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

    • allowedAnonymousPosting$UPDATES

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

    • getAllDeletedMessagesPaging$UPDATES

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

    • getPermissionsForMessageIdsForSessionUser$UPDATES

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

    • getPermissionsForMessageIdsForUser$UPDATES

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

    • getSubscribersForForum$UPDATES

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

    • isForumPublic$UPDATES

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

    • notifyUserCreation$UPDATES

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

    • notifyUsersCreation$UPDATES

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

    • getSubscribedThreadsPaging$UPDATES

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

    • getSubscribedForumsPaging$UPDATES

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

    • getChildrenForMessagePaging$UPDATES

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

    • getApplicationName$UPDATES

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

    • getApplicationPermissions$UPDATES

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

    • getWorkspace$UPDATES

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

    • createMessages$UPDATES

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

    • createForums$UPDATES

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

    • importMessages$UPDATES

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

    • getThreadsList$UPDATES

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

    • getForumsList$UPDATES

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

    • getMessagesList$UPDATES

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

    • validateGroupMembership$UPDATES

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

    • updateUsernames$UPDATES

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

    • commitUpdateUsernames$UPDATES

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

    • rollbackUpdateUsernames$UPDATES

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

    • inviteUsersToThread$UPDATES

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

    • acceptThreadInvitation$UPDATES

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

    • denyThreadInvitation$UPDATES

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

    • isInvitedToThreads$UPDATES

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

    • changePartitionPaths$UPDATES

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

    • reloadProperties$UPDATES

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

    • validate$UPDATES

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

    • validateTypedValues$UPDATES

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

    • setTimeZone$UPDATES

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

    • setTimeZoneSameAs$UPDATES

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

    • getMessageCountByUsers$UPDATES

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

    • getMessageCountByUsersForForum$UPDATES

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

    • getTopUsersForForum$UPDATES

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

    • getTopUsersForSite$UPDATES

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

    • getMessagesByUserPaging$UPDATES

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

  • Method Details

    • createForum

      @Write(K_FORUMS) Long createForum(Forum f_) throws PrivilegeException, DuplicateUuidException
      Deprecated.
      Create a discussion forum.
      Parameters:
      f_ - The forum to be created. The following fields of the passed object must be set: name, creator and dateCreated. The value of the id field is ignored (can be null), since it will be assigned by the server.
      Returns:
      The server-assigned forum id (local id).
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to create a forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, READER, and USER roles in ForumsRoleMap may create forums.
      DuplicateUuidException - if the UUID of the forum already exists
      ServiceException - if any system-level error occurs

    • setAdministratorGroup

      @Write(K_FORUMS) void setAdministratorGroup(Long groupId_) throws NullPointerException
      Deprecated.
      Sets the group to which a user must belong to be a forums administrator. A forums administrator has additional privileges providing access to restricted functionality, such as viewing the deleted messages, etc.
      Parameters:
      groupId_ - The id of the group to be set as the forums administrator group.
      Throws:
      NullPointerException - if groupId_ is null
      ServiceException - if any system-level error occurs

    • updateForum

      @Write(K_FORUMS) void updateForum(Forum f_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Update the properties of a discussion forum. The fields id and remoteId are not changed.
      Parameters:
      f_ - The Forum object whose properties should be used to update the existing forum. The id field of the passed object should be set to the id of the forum to update. The existing forum's properties are overwritten with the corresponding values contained in the passed object.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to update the forum. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may update forums.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • updateForums

      @Write(K_FORUMS) void updateForums(Forum[] forums_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Update the properties of multiple discussion forums. The fields id and remoteId are not changed.
      Parameters:
      forums_ - An array of Forum objects containing the properties that should be used to update the corresponding exisitng forums. The id field of each object should be set to the id of the forum to update. Each existing forum's properties are overwritten with the corresponding values contained in the passed object.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to update at least one of the forums. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may update forums.
      InvalidForumException - if any one of the forum ids is invalid
      ServiceException - if any system-level error occurs

    • deleteForum

      @Write(K_FORUMS) void deleteForum(Long forumId_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Delete a forum (and all of its threads).
      Parameters:
      forumId_ - The local id of the forum to be deleted (ie the id field of a Forum object).
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to delete the forum. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may delete forums.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getForum

      @Read(K_FORUMS) Forum getForum(Long id_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Get a forum.
      Parameters:
      id_ - The local id of the forum to be retrieved (ie the id field of a Forum object).
      Returns:
      The desired forum.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view this forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view forums.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getForums

      @Deprecated @Read(K_FORUMS) Forum[] getForums(Long[] ids_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Use getForumsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer).
      Get multiple forums.
      Parameters:
      ids_ - The local ids of the forums to be returned.
      Returns:
      The desired forums.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any one of the forums. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view forums.
      InvalidForumException - if any one of the forum ids is invalid
      ServiceException - if any system-level error occurs

    • getForumIdsByRelated

      @Deprecated @Read(K_FORUMS) Long[] getForumIdsByRelated(LocalObject related_)
      Deprecated.
      Use getForumIdsByRelatedPaging(com.appiancorp.suiteapi.common.LocalObject, int, int, java.lang.Integer).
      Get the ids of the forums related to a given Appian Type object (an Appian Type is any type that has a corresponding TYPE_XXX constant defined in ObjectTypeMapping).
      Parameters:
      related_ - The identifier specifiying the object for which related forums are to be returned.
      Returns:
      The ids of the forums that are related to the passed object.
      Throws:
      ServiceException - if any system-level error occurs

    • deleteThread

      @Write(K_FORUMS) void deleteThread(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Delete a thread (and all of its messages).
      Parameters:
      threadId_ - The id of the thread to delete.
      Throws:
      PrivilegeException - if the user does not have sufficient privileges to delete the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may delete threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • getThread

      @Read(K_FORUMS) DiscussionThread getThread(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Get a thread.
      Parameters:
      threadId_ - The id of the thread to be returned.
      Returns:
      The desired thread.
      Throws:
      PrivilegeException - if the user does not have sufficient privileges to view this thread. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view threads.
      InvalidThreadException - if the passed id is invalid
      ServiceException - if any system-level error occurs

    • getThreads

      @Deprecated @Read(K_FORUMS) DiscussionThread[] getThreads(Long[] threadIds_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Use getThreadsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer).
      Get multiple threads.
      Parameters:
      threadIds_ - The ids of the threads to be returned.
      Returns:
      The desired threads.
      Throws:
      NullPointerException - if any one of the passed ids is null
      PrivilegeException - if the user does not have sufficient privileges to view any of the threads. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view threads.
      InvalidThreadException - if any of the threads is invalid
      ServiceException - if any system-level error occurs

    • getThreadsForForum

      @Deprecated @Read(K_FORUMS) DiscussionThread[] getThreadsForForum(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) throws InvalidForumException
      Deprecated.
      Use getThreadsForForumPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer).
      Get a set of threads from a forum.
      Parameters:
      forumId_ - The local id of the forum from which to get the threads.
      sortProperty_ - the property by which the results will be sorted. Use a SORT_PROPERTY_THREAD_XXX constant.
      sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      count_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      Returns:
      The desired threads.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getThreadsForForumPaging

      @Read(K_FORUMS) ResultPage getThreadsForForumPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException
      Deprecated.
      Get all the threads in a given forum, paging.
      Parameters:
      forumId_ - The id (local id) of the forum from which to get 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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in DiscussionThread.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of DiscussionThread objects.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • moveThread

      @Write(K_FORUMS) void moveThread(Long threadId_, Long toForumId_) throws PrivilegeException, InvalidThreadException, InvalidForumException
      Deprecated.
      Move a thread to a different forum.
      Parameters:
      threadId_ - The id of the thread to move.
      toForumId_ - The id of the forum to which to move the thread.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to move the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may move threads.
      InvalidThreadException - if the passed thread id is invalid
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • addThreadResource

      @Write(K_FORUMS) void addThreadResource(Long threadId_, Attachment resource_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Add an attachment to a thread.
      Parameters:
      threadId_ - The id of the thread to which to add the attachment.
      resource_ - The resource attachment to add. The attached field of the object must be set. If the same attachment was already added by another user, the attachement will not be readded.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to attach the resource to the thread. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles in ForumsRoleMap may add resources to threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • addThreadResources

      @Write(K_FORUMS) void addThreadResources(Long threadId_, Attachment[] resources_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Add multiple attachments to a thread.
      Parameters:
      threadId_ - The id of the thread to which to add the attachments.
      resources_ - The resource attachments to add. The attached field of each object must be set. If the same attachment was already added by another user, the attachement will not be readded.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to attach any one of the resources. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles in ForumsRoleMap may add resources to threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • removeThreadResource

      @Write(K_FORUMS) void removeThreadResource(Long threadId_, Attachment resource_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Remove an attachment from a thread.
      Parameters:
      threadId_ - The id of the thread from which to remove the attachment.
      resource_ - The resource attachment to remove. The attached field of the object must be set.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to remove the resource from the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may remove resources from threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • removeThreadResources

      @Write(K_FORUMS) void removeThreadResources(Long threadId_, Attachment[] resources_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Remove multiple resources from a thread.
      Parameters:
      threadId_ - The id of the thread from which to remove the attachments.
      resources_ - The resource attachments to remove. The attached field of each object must be set.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to remove the resource. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may remove resources from threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • subscribeToThread

      @Write(K_FORUMS) void subscribeToThread(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Subscribe the current user to a thread.
      Parameters:
      threadId_ - The id of the thread to subscribe to.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to subscribe to the thread. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may subscribe to threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • subscribeUsersToThread

      @Deprecated @Write(K_FORUMS) void subscribeUsersToThread(Long threadId_, String[] users_) throws InvalidUserException, InvalidThreadException, PrivilegeException
      Deprecated.
      the combination of inviteUsersToThread(java.lang.String[], java.lang.Long) and acceptThreadInvitation(java.lang.Long) is more secure, and should be used instead
      Subscribe a set of users to a thread.
      Parameters:
      threadId_ - The id of the thread to subscribe to.
      users_ - The logins (usernames) of the users to subscribe to the thread.
      Throws:
      InvalidUserException - if any of the passed usernames is invalid
      InvalidThreadException - if the passed thread id is invalid
      PrivilegeException - if the current user does not have sufficient privileges to subscirbe the passed users to the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may remove resources from threads.
      ServiceException - if any system-level error occurs

    • unsubscribeFromThread

      @Write(K_FORUMS) void unsubscribeFromThread(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Unsubscribe the current user from a thread.
      Parameters:
      threadId_ - The id of the thread to unsubscribe from.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to unsubscribe from the thread. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may unsubscribe from threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • isSubscribedToThread

      @Read(K_FORUMS) boolean isSubscribedToThread(Long threadId_) throws InvalidThreadException
      Deprecated.
      Determine whether the current user is subscribed to a thread.
      Parameters:
      threadId_ - The id of a thread.
      Returns:
      true if the current user is subscribed to the passed, thread, and false otherwise
      Throws:
      ServiceException - if any system-level error occurs
      InvalidThreadException - if the passed thread id is invalid

    • getSubscribersForThread

      @Read(K_FORUMS) String[] getSubscribersForThread(Long threadId_) throws InvalidThreadException
      Deprecated.
      Get the usernames of the users subscribed to a thread.
      Parameters:
      threadId_ - The id of a thread.
      Returns:
      The usernames of the users subscribed to the thread.
      Throws:
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • sponsor

      @Write(K_FORUMS) void sponsor(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Sponsor a thread (simply marks the thread as 'sponsored').
      Parameters:
      threadId_ - The id of the thread to sponsor.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to sponsor the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may sponsor threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • unsponsor

      @Write(K_FORUMS) void unsponsor(Long threadId_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Unsponsor a thread.
      Parameters:
      threadId_ - The id of the thread to unsponsor.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to unsponsor the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may unsponsor threads.
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • sponsorForMessage

      @Write(K_FORUMS) void sponsorForMessage(Long messageId_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Sponsor a thread through a thread message (sponsors the thread that contains the message whose id is passed).
      Parameters:
      messageId_ - The id of a message in the thread that will be sponsored.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to sponsor the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may sponsor threads.
      InvalidMessageException - if the passed message id is invalid
      ServiceException - if any system-level error occurs

    • unsponsorForMessage

      @Write(K_FORUMS) void unsponsorForMessage(Long messageId_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Unsponsor a thread through a thread message (unsponsors the thread that contains the message whose id is passed).
      Parameters:
      messageId_ - The id of a message in the thread to unsponsor.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to unsponsor the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may unsponsor threads.
      InvalidMessageException - if the passed message id is invalid
      ServiceException - if any system-level error occurs

    • createMessage

      @Write(K_FORUMS) Message createMessage(Long forumId_, Message m_) throws InvalidForumException, InvalidMessageException, IllegalArgumentException, PrivilegeException
      Deprecated.
      Create a message. NOTE: To physically store the message to disk, this call must be followed by a call to DiscussionBodyService.createMessage(com.appiancorp.suiteapi.forums.Message), using the filename returned by this method.
      Parameters:
      forumId_ - The id of the forum in which to create the new message.
      m_ - The Message object from which to create the message. The minimum required fields that must be set in the object are: threadId, parentId, subject, and anonymousAuthor. When creating a new thread, the threadId and parentId fields should be set to 0 or null. The id, remoteId, and filename will be assigned by the server.
      Returns:
      The new message, with the id, remoteId, and filename fields properly populated.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to create the message. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles in ForumsRoleMap may create messages.
      InvalidMessageException - if the parentId of the passed message is invalid
      IllegalArgumentException - if the user attempts to post the message anonymously but the Forum does not accept anonymous posts
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs
      NullPointerException - if the m_ message is null

    • updateMessage

      @Write(K_FORUMS) String updateMessage(Message m_) throws PrivilegeException, IllegalArgumentException, InvalidMessageException
      Deprecated.
      Update the properties of a message. The id, remoteId, and filename fields are not changed.
      Parameters:
      m_ - The Message object whose properties should be used to update the existing message. The id field of the passed object should be set to the id of the message to update. The existing message's properties are overwritten with the corresponding values contained in the passed object (with the exception of id, remoteId, and filename which are not changed).
      Returns:
      The filename for the body of the message.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to update the message. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may update messages.
      IllegalArgumentException - if the user attempts to post the message anonymously but the Forum does not accept anonymous posts
      InvalidMessageException - if no message exists with the same id as the message passed in
      ServiceException - if any system-level error occurs

    • updateMessages

      @Write(K_FORUMS) String[] updateMessages(Message[] m_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Update the properties of multiple messages. The id, remoteId, and filename fields are not changed.
      Parameters:
      m_ - An array of Message objects containing the properties that should be used to update the corresponding existing messages. The id field of each passed object should be set to the id of the message to update. Each existing message's properties are overwritten with the corresponding values contained in the passed object (with the exception of id, remoteId, and filename which are not changed).
      Returns:
      An array of filenames for the message bodies.
      Throws:
      PrivilegeException - if the user does not have sufficient privileges to update at least one of the messages. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may uupdate messages.
      InvalidMessageException - if no message exists with the same id as the message passed in
      ServiceException - if any system-level error occurs

    • getMessage

      @Read(K_FORUMS) Message getMessage(Long messageId_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Get a message.
      Parameters:
      messageId_ - The id of the message to be returned.
      Returns:
      The desired message.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view this message. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view messages.
      InvalidMessageException - if the message does not exist or has been deleted
      ServiceException - if any system-level error occurs

    • getMessages

      @Deprecated @Read(K_FORUMS) Message[] getMessages(Long[] messageIds_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Use getMessagesPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer).
      Get multiple messages.
      Parameters:
      messageIds_ - The ids of the messages to be returned.
      Returns:
      The desired messages.
      Throws:
      NullPointerException - if the passed messageIds array contains a null element
      PrivilegeException - if the current user does not have sufficient privileges to view any one of the messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view messages.
      InvalidMessageException - if any one of the messages does not exist or has been deleted
      ServiceException - if any system-level error occurs

    • getMessagesForThread

      @Deprecated @Read(K_FORUMS) Message[] getMessagesForThread(Long threadId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) throws InvalidThreadException
      Deprecated.
      Use getMessagesForThreadPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer).
      Get a set of messages in a thread.
      Parameters:
      threadId_ - The local id of the thread from which to get the messages.
      sortProperty_ - The column by which to sort. Use a SORT_PROPERTY_MESSAGE constant.
      sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      count_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      Returns:
      The desired messages.
      Throws:
      InvalidThreadException - of the thread is invalid
      ServiceException - if any system-level error occurs

    • addRating

      @Write(K_FORUMS) void addRating(Long messageId_, int rating_) throws InvalidMessageException, PrivilegeException
      Deprecated.
      Average a new individual rating into the message's overall average rating.
      Parameters:
      messageId_ - The id of the message being rated.
      rating_ - The new individual rating.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to add the rating. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may add ratings to messages.
      InvalidMessageException - if the passed message id is invalid
      ServiceException - if any system-level error occurs

    • setRating

      @Write(K_FORUMS) void setRating(Long messageId_, double averageRating_, int ratingCount_) throws InvalidMessageException, PrivilegeException
      Deprecated.
      Set the average rating for a message.
      Parameters:
      messageId_ - The id of a message.
      averageRating_ - The new average rating.
      ratingCount_ - The new number of individual ratings that were used to determine the passed average rating.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to set the rating. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may set ratings of messages.
      InvalidMessageException - if the message is invalid
      ServiceException - if any system-level error occurs
      See Also:

    • deleteMessageAndDescendants

      @Write(K_FORUMS) void deleteMessageAndDescendants(Long messageId_) throws InvalidMessageException, PrivilegeException
      Deprecated.
      Delete a message and all its descendants.
      Parameters:
      messageId_ - The id of a message.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to delete the message. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may delete messages.
      InvalidMessageException - if the passed message id is invalid
      ServiceException - if any system-level error occurs

    • deleteMessage

      @Write(K_FORUMS) void deleteMessage(Long messageId_) throws InvalidMessageException, PrivilegeException
      Deprecated.
      Delete a given message (connects any children of the given message to the parent of the message).
      Parameters:
      messageId_ - The id of the message to delete.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to delete the message. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may delete messages.
      InvalidMessageException - if the passed message id is invalid
      ServiceException - if any system-level error occurs

    • setRoleMapForForum

      @Write(K_FORUMS) void setRoleMapForForum(Long forumId_, ForumsRoleMap r_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Set the rolemap of a forum. Users and Groups can be either forum participants or administrators.
      Parameters:
      forumId_ - The id of a forum
      r_ - The role map to set.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs
      PrivilegeException

    • getRoleMapForForum

      @Read(K_FORUMS) ForumsRoleMap getRoleMapForForum(Long forumId_) throws InvalidForumException
      Deprecated.
      Get the rolemap of a forum. Users and Groups can be either forum participants or administrators.
      Parameters:
      forumId_ - The id of a forum.
      Returns:
      The role map for the given forum.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getRoleMapForThread

      @Read(K_FORUMS) ForumsRoleMap getRoleMapForThread(Long threadId_) throws InvalidThreadException
      Deprecated.
      Get the rolemap of a thread; currently a thread always inherits the rolemap from its parent forum.
      Parameters:
      threadId_ - The id of a thread.
      Returns:
      The role map for the given thread.
      Throws:
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • activateUserSession

      @Deprecated @Write(K_FORUMS) boolean[] activateUserSession(Long[] memberGroups_, Long[] adminGroups_, Long userTypeId_) throws InvalidUserException
      Deprecated.
      Initializes the group permissions for the current user's session. This method should be called every time the group membership role of the current user is changed (eg: from member to admin, etc), or when a new group is created, or when the current user was newly created.
      Parameters:
      memberGroups_ - Groups of which the current user is a member.
      adminGroups_ - Groups of which the current user is an admin.
      userTypeId_ - this is one of UserProfile.USER_TYPE_BASIC or UserProfile.USER_TYPE_SYS_ADMIN
      Returns:
      A boolean array of three system permissions. Element [0] of the returned array indicates whether the current user can createForum; element [1] of the array indicates whether the current user can getAllDeletedMessagesPaging; and [2] indicates whether the current user can importMessages. See the forums security map description in the overall service description.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • getUsersToNotify

      @Read(K_FORUMS) String[] getUsersToNotify(Long threadId_) throws InvalidThreadException
      Deprecated.
      Get the usernames of the users who should receive notifications when updates are made to a given thread. This set of users is the union of the users subscribed to the thread and the users subscribed to the parent forum of the thread.
      Parameters:
      threadId_ - The id of a thread.
      Returns:
      The usernames of the users to notify of updates to the thread.
      Throws:
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • getUsersToNotifyForForum

      @Read(K_FORUMS) String[] getUsersToNotifyForForum(Long forumId_) throws InvalidForumException
      Deprecated.
      Get the usernames of the users who should receive notification when updates are made to a given forum or any of its threads. This is the list of users that are subscribed to the forum.
      Parameters:
      forumId_ - The id of a forum.
      Returns:
      The usernames of users to notify of updates to the forum or any of its threads.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • isSubscribedToForum

      @Read(K_FORUMS) boolean isSubscribedToForum(Long forumId_) throws InvalidForumException
      Deprecated.
      Get the current user's subscription status for a given forum.
      Parameters:
      forumId_ - The id of a forum.
      Returns:
      true if the current user is subscribed to the forum, and false otherwise
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • subscribeToForum

      @Write(K_FORUMS) void subscribeToForum(Long forumId_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Subscribe the current user to a given forum.
      Parameters:
      forumId_ - The id of the forum to subscribe to.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      PrivilegeException - if the current user does not have sufficient privileges to subscribe to the forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, READER, and WRITER roles in ForumsRoleMap may subscribe to forums.
      ServiceException - if any system-level error occurs

    • unsubscribeFromForum

      @Write(K_FORUMS) void unsubscribeFromForum(Long forumId_) throws InvalidForumException, PrivilegeException
      Deprecated.
      Unsubscribes the current user from a given forum.
      Parameters:
      forumId_ - The id of the forum to unsubscribe from.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      PrivilegeException - if the current user does not have sufficient privileges to unsubscribe from the forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, READER, and WRITER roles in ForumsRoleMap may unsubscribe from forums.
      ServiceException - if any system-level error occurs

    • enableForumAnonymousPosting

      @Write(K_FORUMS) void enableForumAnonymousPosting(Long forumId_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Allow anonymous posting for a given forum
      Parameters:
      forumId_ - The id of a forum.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may enable anonymous posting on forums.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • disableForumAnonymousPosting

      @Write(K_FORUMS) void disableForumAnonymousPosting(Long forumId_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Disallows anonymous posting for a given forum (can only be set by a forums administrator or a user having equivalent/higher privileges).
      Parameters:
      forumId_ - The id of a forum.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may disable anonymous posting on forums.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • setForumPublic

      @Write(K_FORUMS) void setForumPublic(Long forumId_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Set a forum to be public, ie allow all users to see the forum and participate.
      Parameters:
      forumId_ - The id of a forum.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to set forums as public. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may set forums as public.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • setForumPrivate

      @Write(K_FORUMS) void setForumPrivate(Long forumId_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Set a forum to be private, ie allow only users/groups that are participants and administrators to see the forum and participate.
      Parameters:
      forumId_ - The id of a forum.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to set forums as private. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may set forums as private.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getForumsPaging

      @Read(K_FORUMS) ResultPage getForumsPaging(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Gets multiple forums, paging.
      Parameters:
      forumIds_ - The ids (local ids) of the forums to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Forum.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Forum objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any of the forums. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view forums.
      InvalidForumException - if any one of the passed forum ids is invalid
      ServiceException - if any system-level error occurs

    • findForumsPaging

      @Read(K_FORUMS) ResultPage findForumsPaging(String nameSearchString_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Find forums by name (gets the forums whose name matches a given query string).
      Parameters:
      nameSearchString_ - The query string to use to search for forums by name. The query string is interpreted as a regular expression but ignoring case. null is a wildcard, meaning any value of the name field.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Forum.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Forum objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getAllForumsPaging

      @Read(K_FORUMS) ResultPage getAllForumsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Get all forums, paging.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Forum.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Forum objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getAllForumSummariesPaging

      @Read(K_FORUMS) ResultPage getAllForumSummariesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Get the summaries of all forums, paging.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ForumSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ForumSummary objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getThreadsPaging

      @Read(K_FORUMS) ResultPage getThreadsPaging(Long[] threadIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Get multiple threads, paging.
      Parameters:
      threadIds_ - The ids of the threads to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in DiscussionThread.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of DiscussionThread objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any of the threads. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view threads.
      InvalidThreadException - if any one of the passed thread ids is invalid
      ServiceException - if any system-level error occurs

    • getMessagesPaging

      @Read(K_FORUMS) ResultPage getMessagesPaging(Long[] messageIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidMessageException
      Deprecated.
      Get multiple messages, paging.
      Parameters:
      messageIds_ - The ids of the messages to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Message.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Message objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any of the messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view messages.
      InvalidMessageException - if any one of the passed message ids is invalid
      ServiceException - if any system-level error occurs

    • getForumIdsByRelatedPaging

      @Read(K_FORUMS) ResultPage getForumIdsByRelatedPaging(LocalObject related_, int startIndex_, int batchSize_, Integer sortOrder_)
      Deprecated.
      Get the ids of the forums related to a given Appian Type object (an Appian Type is any type that has a corresponding TYPE_XXX constant defined in ObjectTypeMapping).
      Parameters:
      related_ - The identifier specifiying the object for which related forums are to be returned (the type, and either id or stringId fileds of the passed object must be set).
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Long objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getMessagesForThreadPaging

      @Read(K_FORUMS) ResultPage getMessagesForThreadPaging(Long threadId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidThreadException
      Deprecated.
      Get all the messages in a given thread, paging.
      Parameters:
      threadId_ - The thread 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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Message.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Message objects.
      Throws:
      InvalidThreadException - if the passed thread id is invalid
      ServiceException - if any system-level error occurs

    • getForumSummariesPaging

      @Read(K_FORUMS) ResultPage getForumSummariesPaging(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Get the summaries of multiple forums, paging.
      Parameters:
      forumIds_ - The ids of the forums to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ForumSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ForumSummary objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any of the forums. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view forums.
      InvalidForumException - if any one of the passed forum ids is invalid
      ServiceException - if any system-level error occurs

    • getValidForumSummariesPaging

      @Read(K_FORUMS) ResultPage getValidForumSummariesPaging(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Get the summaries of valid multiple forums, paging. This function will return every forum that is valid and visible to the user.
      Parameters:
      forumIds_ - The ids of the forums to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ForumSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ForumSummary objects.

    • getThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getThreadSummariesPaging(Long[] threadIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidThreadException
      Deprecated.
      Get the summaries of multiple threads, paging.
      Parameters:
      threadIds_ - The ids of the threads to retrieve.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ThreadSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ThreadSummary objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may get thread summaries.
      InvalidThreadException - if any one of the passed thread ids is invalid
      ServiceException - if any system-level error occurs

    • getSponsoredThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getSponsoredThreadSummariesPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Get the summaries of all the sponsored threads in a forum, paging.
      Parameters:
      forumId_ - The id of a forum.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ThreadSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ThreadSummary objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to sponsor threads. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may sponsor threads.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getSponsoredThreadSummariesPaging

      @Read(K_FORUMS) ResultPage getSponsoredThreadSummariesPaging(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Get the summaries of all the sponsored threads in multiple forums, paging.
      Parameters:
      forumIds_ - The ids of the forums.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ThreadSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ThreadSummary objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to sponsor threads in any of the forums. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles in ForumsRoleMap may sponsor threads.
      InvalidForumException - if any one of the passed forum ids is invalid
      ServiceException - if any system-level error occurs

    • getThreadedMessagesPaging

      @Read(K_FORUMS) ResultPage getThreadedMessagesPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException
      Deprecated.
      Get all the messages in a forum as ThreadedMessage objects.
      Parameters:
      forumId_ - The id of a forum.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ThreadedMessage.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ThreadedMessage objects.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getThreadSummariesForForumPaging

      @Read(K_FORUMS) ResultPage getThreadSummariesForForumPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException, InvalidForumException
      Deprecated.
      Get the summaries of all the threads in a forum, paging.
      Parameters:
      forumId_ - The id of a forum.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in ThreadSummary.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of ThreadSummary objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view any of the threads. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view threads.
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • addActorsToRolesInForums

      @Write(K_FORUMS) void addActorsToRolesInForums(Long forumId_, String[] usernames_, Long[] groupIds_, String role_) throws InvalidForumException
      Deprecated.
      Add users/groups to a given role in a forum.
      Parameters:
      forumId_ - The id of a forum.
      usernames_ - The users to add to the role.
      groupIds_ - The groups to add to the role.
      role_ - The role, which should be one of the ROLE_XXX constants defined in ForumsRoleMap.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • allowedAnonymousPosting

      @Write(K_FORUMS) boolean allowedAnonymousPosting(Long forumId_) throws InvalidForumException
      Deprecated.
      Returns whether anonymous posting is allowed for a given forum.
      Parameters:
      forumId_ - The id of a forum.
      Returns:
      true if anonymous posting is allowed in the forum, and false otherwise
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • getAllDeletedMessagesPaging

      @Read(K_FORUMS) ResultPage getAllDeletedMessagesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws PrivilegeException
      Deprecated.
      Get all the messages that have been deleted, paging.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Message.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Message objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view deleted messages. Only SYSADMIN and APPADMIN roles in ForumsRoleMap may view deleted messages.
      ServiceException - if any system-level error occurs

    • getPermissionsForMessageIdsForSessionUser

      @Read(K_FORUMS) int[] getPermissionsForMessageIdsForSessionUser(Long[] messageIds_)
      Deprecated.
      Get the permissions that the current user has for the given messages.
      Parameters:
      messageIds_ - The ids of messages.
      Returns:
      An array of ints, each of which represents the current user's permission level for the corresponding message. This is one of the MESSAGE_PERMISSION_XXX constants defined by this class.
      Throws:
      ServiceException - if any system-level error occurs

    • getPermissionsForMessageIdsForUser

      @Read(K_FORUMS) int[] getPermissionsForMessageIdsForUser(Long[] messageIds_, String username_)
      Deprecated.
      Get the permissions that a given user has for the given messages.
      Parameters:
      messageIds_ - The ids of messages.
      username_ - The username (ie login) of a user. If the username is invalid, the method will execute as if for an anonymous user.
      Returns:
      An array of ints, each of which represents the passed user's permission level for the corresponding message. This is one of the MESSAGE_PERMISSION_XXX constants defined by this class.
      Throws:
      ServiceException - if any system-level error occurs

    • getSubscribersForForum

      @Read(K_FORUMS) String[] getSubscribersForForum(Long forumId_) throws InvalidForumException
      Deprecated.
      Returns the usernames of the users subscribed to a given forum.
      Parameters:
      forumId_ - The id of the forum whose subscribers should be retrieved.
      Returns:
      The usernames of the forum subscribers.
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • isForumPublic

      @Read(K_FORUMS) boolean isForumPublic(Long forumId_) throws InvalidForumException
      Deprecated.
      Returns whether a forum is public.
      Parameters:
      forumId_ - The id of a forum.
      Returns:
      true if the given forum is public, and false otherwise
      Throws:
      InvalidForumException - if the passed forum id is invalid
      ServiceException - if any system-level error occurs

    • notifyUserCreation

      @Deprecated @Write(K_FORUMS) void notifyUserCreation(String username_)
      Deprecated.
      done automatically by UserService.createUser
      Notifies this service that a new user has been created. This call is used when a user has has been created in the Personalization server, but has not logged in to forums yet (ie activateUserSession has not been called) and the administrator wants to add the user to a rolemap, etc. In that case, the Forums server will not know the user exists unless this call is made first.
      Parameters:
      username_ - The username (ie login) of the new user.
      Throws:
      ServiceException - if any system-level error occurs

    • notifyUsersCreation

      @Write(K_FORUMS) void notifyUsersCreation(String[] usernames_)
      Deprecated.
      Notifies this service that new users have been created (see notifyUserCreation(java.lang.String)).
      Parameters:
      usernames_ - The usernames (ie logins) of the new users.
      Throws:
      ServiceException - if any system-level error occurs

    • getSubscribedThreadsPaging

      @Read(K_FORUMS) ResultPage getSubscribedThreadsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Get all the threads to which the current user is subscribed, paging.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in DiscussionThread.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of DiscussionThread objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getSubscribedForumsPaging

      @Read(K_FORUMS) ResultPage getSubscribedForumsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Get all the forums to which the current user is subscribed, paging.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Forum.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Forum objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getChildrenForMessagePaging

      @Read(K_FORUMS) ResultPage getChildrenForMessagePaging(Long messageId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidMessageException, PrivilegeException
      Deprecated.
      Get all the child messages (ie replies) of a given message, paging.
      Parameters:
      messageId_ - The id of a message.
      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 Constants.COUNT_ALL to return all results from startIndex_ to the end, but this is STRONGLY discouraged.
      sortProperty_ - The property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Message.
      sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
      Returns:
      A Resultpage containing an array of Message objects.
      Throws:
      InvalidMessageException - if the passed message id is invalid
      PrivilegeException - if the current user does not have sufficient permissios to view messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles in ForumsRoleMap may view messages.
      ServiceException - if any system-level error occurs

    • getApplicationName

      @Read(K_FORUMS) String getApplicationName()
      Deprecated.
      Gets the name of the application on which this service is running.
      Returns:
      the name of the application
      Throws:
      ServiceException - if any system-level error occurs

    • getApplicationPermissions

      @Read(K_FORUMS) boolean[] getApplicationPermissions()
      Deprecated.
      Returns boolean[3] of system permissions which is set in session.
      Returns:
      A boolean array of three system permissions. Element [0] of the returned array indicates whether the current user can createForum; element [1] of the array indicates whether the current user can getAllDeletedMessagesPaging; and [2] indicates whether the current user can importMessages. See the forums security map description in the overall service description.

    • getWorkspace

      @Read(K_FORUMS) String[] getWorkspace()
      Deprecated.
      Gets the current memory profile for the workspace.
      Returns:
      array of Strings of length 4 describing memory usage:
      • [0]Used - Memory Used by the Server so far for storage
      • [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
      • [2]Mapped - is the space used by memory-mapped files
      • [3]Available - is the total available memory for the Server process
      Note: All usage statistics are in Bytes.
      Throws:
      ServiceException - if any system-level error occurs

    • createMessages

      @Write(K_FORUMS) Message[] createMessages(Long[] forumIds_, Message[] msgs_) throws InvalidForumException, InvalidMessageException, IllegalArgumentException, PrivilegeException
      Deprecated.
      Create multiple messages, one per forum. NOTE: To physically store the messages to disk, this call must be followed by a call to DiscussionBodyService.createMessages(com.appiancorp.suiteapi.forums.Message[]), using the filenames returned by this method.
      Parameters:
      forumIds_ - The ids of the forums in which to create the new messages.
      msgs_ - The Message objects from which to create the messages. The minimum required fields that must be set in each object are: threadId, parentId, subject, and anonymousAuthor. When creating a new thread, the threadId and parentId fields should be set to 0. The id, remoteId, and filename fields will be assigned by the server.
      Returns:
      The new messages, with the id, remoteId, and filename fields properly populated.
      Throws:
      InvalidForumException - if any one of the passed forum ids is invalid
      InvalidMessageException - if the parentId of any one of the passed messages does not exist
      IllegalArgumentException - if the forumIds_ array is not the same length as the msgs_ array
      PrivilegeException - if the current user does not have sufficient privileges to create messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles in ForumsRoleMap may create messages.
      ServiceException - if any system-level error occurs
      NullPointerException - if the msgs_ array or one or more elements in the the array is null.

    • createForums

      @Write(K_FORUMS) Long[] createForums(Forum[] forums_) throws PrivilegeException, DuplicateUuidException
      Deprecated.
      Create multiple discussion forums. Forums contain threads which contain messages.
      Parameters:
      forums_ - The forums to be created. The following fields of the passed objects must be set: name, creator and dateCreated. The value of the id field is ignored (can be null), since it will be assigned by the server.
      Returns:
      The server-assigned forum ids (local ids).
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, READER, and USER roles in ForumsRoleMap may create forums.
      DuplicateUuidException - if the UUID of any of the forums already exists or if the same UUID is passed in for several forums
      ServiceException - if any system-level error occurs

    • importMessages

      @Write(K_FORUMS) Message[] importMessages(Long[] forumIds_, Message[] msgs_) throws InvalidForumException, InvalidMessageException, IllegalArgumentException, PrivilegeException
      Deprecated.
      Import multiple messages, one per forum. This method will use the datePosted and author values specified in the passed Message objects instead of assigning them on the server. NOTE: To physically store the messages to disk, this call must be followed by a call to DiscussionBodyService.createMessages(com.appiancorp.suiteapi.forums.Message[]), using the filenames returned by this method.
      Parameters:
      forumIds_ - The ids of the forums in which to create the messages.
      msgs_ - The Message objects from which to create the messages. The minimum required fields that must be set in each object are: threadId, parentId, subject, anonymousAuthor, datePosted, and author. When creating a new thread, the threadId and parentId fields should be set to 0. The id, remoteId, and filename fields will be assigned by the server.
      Returns:
      The imported messages, with the id, remoteId, and filename fields properly populated.
      Throws:
      InvalidForumException - if any one of the passed forum ids is invalid
      InvalidMessageException - if the parentId of any one of the passed messages is invalid
      IllegalArgumentException - if the forumIds_ array is not the same length as the msgs_ array
      PrivilegeException - if the current user does not have sufficient privileges to create messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles in ForumsRoleMap may create messages.
      ServiceException - if any system-level error occurs

    • getThreadsList

      @Read(K_FORUMS) ResultList getThreadsList(Long[] threadIds_)
      Deprecated.
      Gets the specified threads, returning the valid results even if all the results cannot be retrieved (for instance, if some of the threads corresponding to the passed ids no longer exist).
      Parameters:
      threadIds_ - The ids of the threads to retrieve.
      Returns:
      A ResultList containing threads and result codes. the Result.getResults() method should be used to get all the threads that were successfully retrieved. In addition ResultList.getResultCodes() can be used to get the list of result codes corresponding to each of the passed thread ids. Each code represents the successful retrieval of a thread, or, if the thread could not be retrieved, the reason for the failure. Possible result codes: ResultList.CODE_INVALID = the thread specified does not exist, ResultList.CODE_NO_PERMISSION = the user can't see the thread, and ResultList.CODE_VALID = the user can see the thread
      Throws:
      ServiceException - if any system-level error occurs

    • getForumsList

      @Read(K_FORUMS) ResultList getForumsList(Long[] forumIds_) throws InvalidUserException
      Deprecated.
      Gets the specified forums, returning the valid results even if all the results cannot be retrieved (for instance, if some of the forums corresponding to the passed ids no longer exist).
      Parameters:
      forumIds_ - The ids of the threads to retrieve.
      Returns:
      A ResultList containing forums and result codes. the Result.getResults() method should be used to get all the forums that were successfully retrieved. In addition ResultList.getResultCodes() can be used to get the list of result codes corresponding to each of the passed forum ids. Each code represents the successful retrieval of a forum, or, if the forum could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.
      Throws:
      ServiceException - if any system-level error occurs
      InvalidUserException

    • getMessagesList

      @Read(K_FORUMS) ResultList getMessagesList(Long[] messageIds_)
      Deprecated.
      Gets the specified messages, returning the valid results even if all the results cannot be retrieved (for instance, if some of the messages corresponding to the passed ids no longer exist).
      Parameters:
      messageIds_ - The ids of the messages to retrieve.
      Returns:
      A ResultList containing messages and result codes. the Result.getResults() method should be used to get all the messages that were successfully retrieved. In addition ResultList.getResultCodes() can be used to get the list of result codes corresponding to each of the passed message ids. Each code represents the successful retrieval of a message, or, if the message could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.
      Throws:
      ServiceException - if any system-level error occurs

    • validateGroupMembership

      @Deprecated @Read(K_FORUMS) boolean validateGroupMembership(Long[] memGroupIds_, Long[] admGroupIds_) throws InvalidUserException
      Deprecated.
      No longer necessary with credential system
      Validates if the association of a user as 'Member' and as an 'Administrator has changed or not.
      Parameters:
      memGroupIds_ - Groups for which the User is a member
      admGroupIds_ - Groups for which the User is an administrator
      Returns:
      true if there is not change in the membership of the user
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • updateUsernames

      @Deprecated @Write(K_FORUMS) void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, PrivilegeException, DuplicateNameException
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Updates a list of old usernames to new usernames.

      If successful, this method must be followed by commitUpdateUsernames(). After commitUpdateUsernames has been called, the old usernames will still be active, but will expire after the interval specified by maxExpirationTimeInSeconds_; if updateUsernames is successful but commitUpdateUsernames is not called, the new usernames will not become active.

      If unsuccessful, this method should be followed by rollbackUpdateUsernames(). This will simply free memory dedicated to mapping old usernames to new usernames.

      Parameters:
      oldUsernames_ - the usernames to be updated
      newUsernames_ - the usernames to which the old usernames will be updated
      maxExpirationTimeInSeconds_ - the interval, in seconds, after commitUpdateUsernames has been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.
      Throws:
      IllegalArgumentException - if the length of oldUsernames_ is not the same as the length of newUsernames_.
      PrivilegeException - if the current user is not a system administrator
      DuplicateNameException - if any oldUsernames_ or newUsernames_ contain any duplicates, or if an old username is being updated to a username that already exists
      ServiceException - if any system-level error occurs

    • commitUpdateUsernames

      @Deprecated @Write(K_FORUMS) void commitUpdateUsernames()
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Commits an update of usernames.

      This method should be preceded by a call to updateUsernames(String[], String[], long). After the commit, the old usernames will be temporarily active, and will expire after the interval specified by maxExpirationTimeInSeconds_; if commitUpdateUsernames is not called, the new usernames will not become active.

      Throws:
      ServiceException - if any system-level error occurs

    • rollbackUpdateUsernames

      @Deprecated @Write(K_FORUMS) void rollbackUpdateUsernames()
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Rolls back an update of usernames.

      This method should be called if updateUsernames(String[], String[], long) is unsuccessful. The rollback will simply free memory dedicated to mapping old usernames to new usernames.

      Throws:
      ServiceException - if any system-level error occurs

    • inviteUsersToThread

      @Write(K_FORUMS) void inviteUsersToThread(String[] usernames_, Long threadId_) throws InvalidThreadException, PrivilegeException
      Deprecated.
      Add invitation for the given users to the given thread. Later, the invitee can accept the invitation by acceptThreadInvitation or deny the invitation by denyThreadInvitation, after which the invitation becomes void.
      Parameters:
      usernames_ - the users to invite
      threadId_ - the thread to which they are invites
      Throws:
      InvalidThreadException - if the thread does not exist
      PrivilegeException - if the requesting user cannot subscribe other users to thread. Only SYSADMIN, APPADMIN, ADMINISTRATOR, and OWNER can subscribe other users.

    • acceptThreadInvitation

      @Write(K_FORUMS) void acceptThreadInvitation(Long threadId_) throws InvalidThreadException, PrivilegeException
      Deprecated.
      Called by the invitee to accept the invitation.
      Parameters:
      threadId_ - the thread to which the user wants to subscribe
      Throws:
      InvalidThreadException - if the thread does not exist
      PrivilegeException - if the user wasn't invited

    • denyThreadInvitation

      @Write(K_FORUMS) void denyThreadInvitation(Long threadId_) throws InvalidThreadException
      Deprecated.
      Called by the invitee to deny the invitation. If the user wasn't invited, this method does effectively nothing.
      Parameters:
      threadId_ - the thread to which the user does not want to subscribe
      Throws:
      InvalidThreadException - if the thread does not exist

    • isInvitedToThreads

      @Read(K_FORUMS) boolean[] isInvitedToThreads(Long[] threadIds_) throws InvalidThreadException
      Deprecated.
      Called to check if the invitation to threads for current user are valid.
      Parameters:
      threadIds_ - the threads for which to check the user's invitation.
      Returns:
      array of boolean's, true if the user's invitation to the thread is valid, otherwise false.
      Throws:
      InvalidThreadException - if any of the threads does not exist

    • changePartitionPaths

      @Write(K_FORUMS) void changePartitionPaths(String originalPath, String newPath)
      Deprecated.
      Changes where message texts are stored from one path to another. This is method is useful when switching server environments. For example, if switching from Windows to Linux this method could change the partition path from c:\forums to /home/usr/forums.
      Parameters:
      originalPath - The path where forum texts were previously stored.
      newPath - The path where forum texts will now be stored.
      Throws:
      ServiceException - if any system-level error occurs

    • reloadProperties

      @Deprecated @Read(NONE) void reloadProperties()
      Deprecated.
      reloading properties is now automatic, so this call is now unnecessary and does nothing.
      Reloads all database-level properties files (*.xml, *.properties) without interrupting API services
      Throws:
      ServiceException - if any system-level error occurs

    • validate

      @Read(K_FORUMS) String validate()
      Deprecated.
      Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results
      Returns:
      the validation results
      Throws:
      ServiceException - if any system-level error occurs

    • validateTypedValues

      @Read(K_FORUMS) boolean validateTypedValues(TypedValue[] typedValues)
      Deprecated.
      Validates given TypedValues. This method is free to throw an exception or to return false if any TypedValue passed is invalid for this engine. This engine supports: AppianType.FORUM AppianType.DISCUSSION_THREAD AppianType.MESSAGE
      Parameters:
      typedValues -
      Returns:
      true if valid, false if invalid

    • setTimeZone

      @Write(K_FORUMS) void setTimeZone(BackendTimeZoneSimple tz)
      Deprecated.
      Set a backend timezone.
      Parameters:
      tz -

    • setTimeZoneSameAs

      @Deprecated @Write(K_FORUMS) void setTimeZoneSameAs(BackendTimeZoneSimple tz, String sameAsId)
      Deprecated.
      Set the time zone information using the format used by the engines to encapsulate time zone information. This method sets the time zone for the forums engine only. NOTE: Using this method could lead to data inconsistency, use GlobalizationService.setTimeZone(com.appiancorp.suiteapi.portal.BackendTimeZoneSimple) to set the time zone across all engines (rarely required).
      Parameters:
      tz - The specially formatted time zone object used by the engines

    • getMessageCountByUsers

      @Read(K_FORUMS) UserMessageCount[] getMessageCountByUsers(String[] usernameList) throws PrivilegeException
      Deprecated.
      Returns the number of message posts grouped by a list of users. Duplicated and invalid usernames are skipped. The order of the usernames is preserved. They are returned as they appeared in the input array.
      Parameters:
      usernameList - The list of usernames that the service is going to search for
      Returns:
      Returns an array of UserMessageCount objects: Each object has the username and the corresponding number (as an integer) of messages posted. If username is invalid, return zero. It does not return results with invalid users
      Throws:
      PrivilegeException - thrown if user does not have admin privileges

    • getMessageCountByUsers

      @Read(K_FORUMS) UserMessageCount[] getMessageCountByUsers(String[] usernameList, Date fromDate, Date toDate) throws PrivilegeException
      Deprecated.
      Returns the number of message posts grouped by a list of users from the fromDate to the toDate. Dates are inclusive and times are GMT. Duplicated and invalid usernames are skipped. The order of the usernames is preserved. They are returned as they appeared in the input array.
      Parameters:
      usernameList - The list of usernames that the service is going to search for
      fromDate - The initial date for the query
      toDate - The end date for the query
      Returns:
      Returns an array of UserMessageCount objects: Each object has the username and the corresponding number (as an integer) of messages posted. If username is invalid, return zero. It does not return results with invalid users
      Throws:
      PrivilegeException - thrown if user does not have admin privileges

    • getMessageCountByUsersForForum

      @Read(K_FORUMS) UserMessageCount[] getMessageCountByUsersForForum(String[] usernameList, Date fromDate, Date toDate, Long forumId) throws InvalidForumException, PrivilegeException
      Deprecated.
      Returns the number of message posts grouped by a list of users from the fromDate to the toDate. Messages are filtered with a specific forum. Dates are inclusive and times are GMT. Duplicated and invalid usernames are skipped. The order of the usernames is preserved. They are returned as they appeared in the input array.
      Parameters:
      usernameList - The list of usernames that the service is going to search for
      fromDate - The initial date for the query
      toDate - The end date for the query
      forumId - Identifier of the forum to get statistics from
      Returns:
      Returns an array of UserMessageCount objects: Each object has the username and the corresponding number (as an integer) of messages posted. If the username is invalid, it will return a message count of zero for that user.
      Throws:
      PrivilegeException - thrown if user does not have admin privileges
      InvalidForumException

    • getTopUsersForForum

      @Read(K_FORUMS) UserMessageCount[] getTopUsersForForum(Date fromDate, Date toDate, Long forumId, int topNUsers) throws InvalidForumException, PrivilegeException
      Deprecated.
      Returns which users are the most active when posting into a particular forum. The length of the returned array can be difined by changing the value of the parameter topNUsers.
      Parameters:
      fromDate - The initial date for the query
      toDate - The end date for the query
      forumId - Identifier of the forum to get statistics from
      topNUsers - The number of users you expect as an output of the function
      Returns:
      Returns the Top N Active Users in descending order by number of posts
      Throws:
      InvalidForumException - thrown if Forum Id is invalid
      PrivilegeException - thrown if user does not have admin privileges

    • getTopUsersForSite

      @Read(K_FORUMS) UserMessageCount[] getTopUsersForSite(Date fromDate, Date toDate, int topNUsers) throws PrivilegeException
      Deprecated.
      Returns which users are the most active when posting into the entire site. The length of the returned array can be defined by changing the value of the parameter topNUsers. Starting a topic or replying to a topic counts as a post.
      Parameters:
      fromDate - The initial date for the query
      toDate - The end date for the query
      topNUsers - The number of users you expect as an output of the function
      Returns:
      Returns the Top N Active Users in descending order by number of posts
      Throws:
      PrivilegeException - thrown if user does not have admin privileges

    • getMessagesByUserPaging

      @Read(K_FORUMS) ResultPage getMessagesByUserPaging(String username, int startIndex, int batchSize, int sortProperty, int sortOrder) throws PrivilegeException
      Deprecated.
      This function gets all messages for a specific user.
      Parameters:
      username - User whose messages are going to be retreived
      startIndex - The index into the collection of total results at which to start
      batchSize - The number of results to return
      sortProperty - The property by which the results should be sorted This should be one of the SORT_BY_XXX constants defined in {com.appiancorp.suiteapi.forums.DiscussionThread}
      sortOrder - The order in which results are going to be sorted {com.appiancorp.suiteapi.common.Constants#SORT_ORDER_ASCENDING} or {com.appiancorp.suiteapi.common.Constants#SORT_ORDER_DESCENDING}
      Returns:
      Returns all messages for the user
      Throws:
      PrivilegeException - thrown if user does not have admin privileges