Interface DiscussionMetadataCoreService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can create threads in the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can delete the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can sponsor a thread in the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can subscribe to the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can unsponsor a thread in the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can unsubscribe from the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can update the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can view the forumstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can add a rating to the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can delete the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can delete the message and its descendentsstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can set the rating of the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can update the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can view the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can anonymously view the messagestatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can add a resource to the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can create a message in the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can delete the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can invite other users to the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can move the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can remove a resource from the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can sponsor the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can subscribe to the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can unsponsor the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can unsubscribe from the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can update the threadstatic final Integer
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can view the threadstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final int
Deprecated.Indicates that the user is allowed to view the messagestatic final int
Deprecated.Indicates that the user is not allowed to view the messagestatic final int
Deprecated.Indicates that no permissions can be obtained for the message because the specified message was null or does not existstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
acceptThreadInvitation
(Long threadId_) Deprecated.Called by the invitee to accept the invitation.boolean[]
activateUserSession
(Long[] memberGroups_, Long[] adminGroups_, Long userTypeId_) Deprecated.void
addActorsToRolesInForums
(Long forumId_, String[] usernames_, Long[] groupIds_, String role_) Deprecated.Add users/groups to a given role in a forum.void
Deprecated.Average a new individual rating into the message's overall average rating.void
addThreadResource
(Long threadId_, Attachment resource_) Deprecated.Add an attachment to a thread.void
addThreadResources
(Long threadId_, Attachment[] resources_) Deprecated.Add multiple attachments to a thread.boolean
allowedAnonymousPosting
(Long forumId_) Deprecated.Returns whether anonymous posting is allowed for a given forum.void
changePartitionPaths
(String originalPath, String newPath) Deprecated.Changes where message texts are stored from one path to another.void
Deprecated.createForum
(Forum f_) Deprecated.Create a discussion forum.Long[]
createForums
(Forum[] forums_) Deprecated.Create multiple discussion forums.createMessage
(Long forumId_, Message m_) Deprecated.Create a message.Message[]
createMessages
(Long[] forumIds_, Message[] msgs_) Deprecated.Create multiple messages, one per forum.void
deleteForum
(Long forumId_) Deprecated.Delete a forum (and all of its threads).void
deleteMessage
(Long messageId_) Deprecated.Delete a given message (connects any children of the given message to the parent of the message).void
deleteMessageAndDescendants
(Long messageId_) Deprecated.Delete a message and all its descendants.void
deleteThread
(Long threadId_) Deprecated.Delete a thread (and all of its messages).void
denyThreadInvitation
(Long threadId_) Deprecated.Called by the invitee to deny the invitation.void
disableForumAnonymousPosting
(Long forumId_) Deprecated.Disallows anonymous posting for a given forum (can only be set by a forums administrator or a user having equivalent/higher privileges).void
enableForumAnonymousPosting
(Long forumId_) Deprecated.Allow anonymous posting for a given forumfindForumsPaging
(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).getAllDeletedMessagesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the messages that have been deleted, paging.getAllForumsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all forums, paging.getAllForumSummariesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of all forums, paging.Deprecated.Gets the name of the application on which this service is running.boolean[]
Deprecated.Returns boolean[3] of system permissions which is set in session.getChildrenForMessagePaging
(Long messageId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the child messages (ie replies) of a given message, paging.Deprecated.Get a forum.Long[]
getForumIdsByRelated
(LocalObject related_) 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 inObjectTypeMapping
).Forum[]
getForumsList
(Long[] forumIds_) 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).getForumsPaging
(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets multiple forums, paging.getForumSummariesPaging
(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of multiple forums, paging.getMessage
(Long messageId_) Deprecated.Get a message.getMessageCountByUsers
(String[] usernameList) Deprecated.Returns the number of message posts grouped by a list of users.getMessageCountByUsers
(String[] usernameList, Date fromDate, Date toDate) Deprecated.Returns the number of message posts grouped by a list of users from the fromDate to the toDate.getMessageCountByUsersForForum
(String[] usernameList, Date fromDate, Date toDate, Long forumId) Deprecated.Returns the number of message posts grouped by a list of users from the fromDate to the toDate.Message[]
getMessages
(Long[] messageIds_) getMessagesByUserPaging
(String username, int startIndex, int batchSize, int sortProperty, int sortOrder) Deprecated.This function gets all messages for a specific user.Message[]
getMessagesForThread
(Long threadId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) getMessagesForThreadPaging
(Long threadId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the messages in a given thread, paging.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).getMessagesPaging
(Long[] messageIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get multiple messages, paging.int[]
getPermissionsForMessageIdsForSessionUser
(Long[] messageIds_) Deprecated.Get the permissions that the current user has for the given messages.int[]
getPermissionsForMessageIdsForUser
(Long[] messageIds_, String username_) Deprecated.Get the permissions that a given user has for the given messages.getRoleMapForForum
(Long forumId_) Deprecated.Get the rolemap of a forum.getRoleMapForThread
(Long threadId_) Deprecated.Get the rolemap of a thread; currently a thread always inherits the rolemap from its parent forum.getSponsoredThreadSummariesPaging
(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of all the sponsored threads in multiple forums, paging.getSponsoredThreadSummariesPaging
(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of all the sponsored threads in a forum, paging.getSubscribedForumsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the forums to which the current user is subscribed, paging.getSubscribedThreadsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the threads to which the current user is subscribed, paging.String[]
getSubscribersForForum
(Long forumId_) Deprecated.Returns the usernames of the users subscribed to a given forum.String[]
getSubscribersForThread
(Long threadId_) Deprecated.Get the usernames of the users subscribed to a thread.Deprecated.Get a thread.getThreadedMessagesPaging
(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the messages in a forum asThreadedMessage
objects.getThreads
(Long[] threadIds_) getThreadsForForum
(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) getThreadsForForumPaging
(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get all the threads in a given forum, paging.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).getThreadsPaging
(Long[] threadIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get multiple threads, paging.getThreadSummariesForForumPaging
(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of all the threads in a forum, paging.getThreadSummariesPaging
(Long[] threadIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of multiple threads, paging.getTopUsersForForum
(Date fromDate, Date toDate, Long forumId, int topNUsers) Deprecated.Returns which users are the most active when posting into a particular forum.getTopUsersForSite
(Date fromDate, Date toDate, int topNUsers) Deprecated.Returns which users are the most active when posting into the entire site.String[]
getUsersToNotify
(Long threadId_) Deprecated.Get the usernames of the users who should receive notifications when updates are made to a given thread.String[]
getUsersToNotifyForForum
(Long forumId_) Deprecated.Get the usernames of the users who should receive notification when updates are made to a given forum or any of its threads.getValidForumSummariesPaging
(Long[] forumIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get the summaries of valid multiple forums, paging.String[]
Deprecated.Gets the current memory profile for the workspace.Message[]
importMessages
(Long[] forumIds_, Message[] msgs_) Deprecated.Import multiple messages, one per forum.void
inviteUsersToThread
(String[] usernames_, Long threadId_) Deprecated.Add invitation for the given users to the giventhread
.boolean
isForumPublic
(Long forumId_) Deprecated.Returns whether a forum is public.boolean[]
isInvitedToThreads
(Long[] threadIds_) Deprecated.Called to check if the invitation to threads for current user are valid.boolean
isSubscribedToForum
(Long forumId_) Deprecated.Get the current user's subscription status for a given forum.boolean
isSubscribedToThread
(Long threadId_) Deprecated.Determine whether the current user is subscribed to a thread.void
moveThread
(Long threadId_, Long toForumId_) Deprecated.Move a thread to a different forum.void
notifyUserCreation
(String username_) Deprecated.done automatically by UserService.createUservoid
notifyUsersCreation
(String[] usernames_) Deprecated.Notifies this service that new users have been created (seenotifyUserCreation(java.lang.String)
).void
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.void
removeThreadResource
(Long threadId_, Attachment resource_) Deprecated.Remove an attachment from a thread.void
removeThreadResources
(Long threadId_, Attachment[] resources_) Deprecated.Remove multiple resources from a thread.void
Deprecated.void
setAdministratorGroup
(Long groupId_) Deprecated.Sets the group to which a user must belong to be a forums administrator.void
setForumPrivate
(Long forumId_) Deprecated.Set a forum to be private, ie allow only users/groups that are participants and administrators to see the forum and participate.void
setForumPublic
(Long forumId_) Deprecated.Set a forum to be public, ie allow all users to see the forum and participate.void
Deprecated.Set the average rating for a message.void
setRoleMapForForum
(Long forumId_, ForumsRoleMap r_) Deprecated.Set the rolemap of a forum.void
Deprecated.Set a backend timezone.void
setTimeZoneSameAs
(BackendTimeZoneSimple tz, String sameAsId) Deprecated.void
Deprecated.Sponsor a thread (simply marks the thread as 'sponsored').void
sponsorForMessage
(Long messageId_) Deprecated.Sponsor a thread through a thread message (sponsors the thread that contains the message whose id is passed).void
subscribeToForum
(Long forumId_) Deprecated.Subscribe the current user to a given forum.void
subscribeToThread
(Long threadId_) Deprecated.Subscribe the current user to a thread.void
subscribeUsersToThread
(Long threadId_, String[] users_) Deprecated.the combination ofinviteUsersToThread(java.lang.String[], java.lang.Long)
andacceptThreadInvitation(java.lang.Long)
is more secure, and should be used insteadvoid
Deprecated.Unsponsor a thread.void
unsponsorForMessage
(Long messageId_) Deprecated.Unsponsor a thread through a thread message (unsponsors the thread that contains the message whose id is passed).void
unsubscribeFromForum
(Long forumId_) Deprecated.Unsubscribes the current user from a given forum.void
unsubscribeFromThread
(Long threadId_) Deprecated.Unsubscribe the current user from a thread.void
updateForum
(Forum f_) Deprecated.Update the properties of a discussion forum.void
updateForums
(Forum[] forums_) Deprecated.Update the properties of multiple discussion forums.updateMessage
(Message m_) Deprecated.Update the properties of a message.String[]
updateMessages
(Message[] m_) Deprecated.Update the properties of multiple messages.void
updateUsernames
(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated.validate()
Deprecated.Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation resultsboolean
validateGroupMembership
(Long[] memGroupIds_, Long[] admGroupIds_) Deprecated.No longer necessary with credential systemboolean
validateTypedValues
(TypedValue[] typedValues) Deprecated.Validates given TypedValues.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
MESSAGE_PERMISSION_INVALID
static final int MESSAGE_PERMISSION_INVALIDDeprecated.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_VIEWDeprecated.Indicates that the user is not allowed to view the message- See Also:
-
MESSAGE_PERMISSION_CAN_VIEW
static final int MESSAGE_PERMISSION_CAN_VIEWDeprecated.Indicates that the user is allowed to view the message- See Also:
-
ACTION_FORUM_CREATE_THREAD
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can create threads in the forum -
ACTION_FORUM_UPDATE
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can update the forum -
ACTION_FORUM_DELETE
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can delete the forum -
ACTION_FORUM_VIEW
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can view the forum -
ACTION_FORUM_SUBSCRIBE
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can subscribe to the forum -
ACTION_FORUM_UNSUBSCRIBE
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can unsubscribe from the forum -
ACTION_FORUM_SPONSOR_THREAD
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can sponsor a thread in the forum -
ACTION_FORUM_UNSPONSOR_THREAD
Deprecated.The index of the element in theallowedActions
field of theForum
bean that indicates whether the user can unsponsor a thread in the forum -
ACTION_THREAD_CREATE_MESSAGE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can create a message in the thread -
ACTION_THREAD_UPDATE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can update the thread -
ACTION_THREAD_DELETE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can delete the thread -
ACTION_THREAD_MOVE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can move the thread -
ACTION_THREAD_VIEW
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can view the thread -
ACTION_THREAD_ADD_RESOURCE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can add a resource to the thread -
ACTION_THREAD_REMOVE_RESOURCE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can remove a resource from the thread -
ACTION_THREAD_SUBSCRIBE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can subscribe to the thread -
ACTION_THREAD_UNSUBSCRIBE
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can unsubscribe from the thread -
ACTION_THREAD_SPONSOR
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can sponsor the thread -
ACTION_THREAD_UNSPONSOR
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can unsponsor the thread -
ACTION_THREAD_INVITE_OTHER_USERS
Deprecated.The index of the element in theallowedActions
field of theThreadSummary
bean that indicates whether the user can invite other users to the thread -
ACTION_MESSAGE_UPDATE
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can update the message -
ACTION_MESSAGE_DELETE
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can delete the message -
ACTION_MESSAGE_DELETE_WITH_DESCENDANTS
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can delete the message and its descendents -
ACTION_MESSAGE_ADD_RATING
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can add a rating to the message -
ACTION_MESSAGE_SET_RATING
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can set the rating of the message -
ACTION_MESSAGE_VIEW
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can view the message -
ACTION_MESSAGE_VIEW_ANONYMOUS
Deprecated.The index of the element in theallowedActions
field of theMessage
bean that indicates whether the user can anonymously view the message -
createForum$UPDATES
static final boolean createForum$UPDATESDeprecated.- See Also:
-
setAdministratorGroup$UPDATES
static final boolean setAdministratorGroup$UPDATESDeprecated.- See Also:
-
updateForum$UPDATES
static final boolean updateForum$UPDATESDeprecated.- See Also:
-
updateForums$UPDATES
static final boolean updateForums$UPDATESDeprecated.- See Also:
-
deleteForum$UPDATES
static final boolean deleteForum$UPDATESDeprecated.- See Also:
-
getForum$UPDATES
static final boolean getForum$UPDATESDeprecated.- See Also:
-
getForums$UPDATES
static final boolean getForums$UPDATESDeprecated.- See Also:
-
getForumIdsByRelated$UPDATES
static final boolean getForumIdsByRelated$UPDATESDeprecated.- See Also:
-
deleteThread$UPDATES
static final boolean deleteThread$UPDATESDeprecated.- See Also:
-
getThread$UPDATES
static final boolean getThread$UPDATESDeprecated.- See Also:
-
getThreads$UPDATES
static final boolean getThreads$UPDATESDeprecated.- See Also:
-
getThreadsForForum$UPDATES
static final boolean getThreadsForForum$UPDATESDeprecated.- See Also:
-
getThreadsForForumPaging$UPDATES
static final boolean getThreadsForForumPaging$UPDATESDeprecated.- See Also:
-
moveThread$UPDATES
static final boolean moveThread$UPDATESDeprecated.- See Also:
-
addThreadResource$UPDATES
static final boolean addThreadResource$UPDATESDeprecated.- See Also:
-
addThreadResources$UPDATES
static final boolean addThreadResources$UPDATESDeprecated.- See Also:
-
removeThreadResource$UPDATES
static final boolean removeThreadResource$UPDATESDeprecated.- See Also:
-
removeThreadResources$UPDATES
static final boolean removeThreadResources$UPDATESDeprecated.- See Also:
-
subscribeToThread$UPDATES
static final boolean subscribeToThread$UPDATESDeprecated.- See Also:
-
subscribeUsersToThread$UPDATES
static final boolean subscribeUsersToThread$UPDATESDeprecated.- See Also:
-
unsubscribeFromThread$UPDATES
static final boolean unsubscribeFromThread$UPDATESDeprecated.- See Also:
-
isSubscribedToThread$UPDATES
static final boolean isSubscribedToThread$UPDATESDeprecated.- See Also:
-
getSubscribersForThread$UPDATES
static final boolean getSubscribersForThread$UPDATESDeprecated.- See Also:
-
sponsor$UPDATES
static final boolean sponsor$UPDATESDeprecated.- See Also:
-
unsponsor$UPDATES
static final boolean unsponsor$UPDATESDeprecated.- See Also:
-
sponsorForMessage$UPDATES
static final boolean sponsorForMessage$UPDATESDeprecated.- See Also:
-
unsponsorForMessage$UPDATES
static final boolean unsponsorForMessage$UPDATESDeprecated.- See Also:
-
createMessage$UPDATES
static final boolean createMessage$UPDATESDeprecated.- See Also:
-
updateMessage$UPDATES
static final boolean updateMessage$UPDATESDeprecated.- See Also:
-
updateMessages$UPDATES
static final boolean updateMessages$UPDATESDeprecated.- See Also:
-
getMessage$UPDATES
static final boolean getMessage$UPDATESDeprecated.- See Also:
-
getMessages$UPDATES
static final boolean getMessages$UPDATESDeprecated.- See Also:
-
getMessagesForThread$UPDATES
static final boolean getMessagesForThread$UPDATESDeprecated.- See Also:
-
addRating$UPDATES
static final boolean addRating$UPDATESDeprecated.- See Also:
-
setRating$UPDATES
static final boolean setRating$UPDATESDeprecated.- See Also:
-
deleteMessageAndDescendants$UPDATES
static final boolean deleteMessageAndDescendants$UPDATESDeprecated.- See Also:
-
deleteMessage$UPDATES
static final boolean deleteMessage$UPDATESDeprecated.- See Also:
-
setRoleMapForForum$UPDATES
static final boolean setRoleMapForForum$UPDATESDeprecated.- See Also:
-
getRoleMapForForum$UPDATES
static final boolean getRoleMapForForum$UPDATESDeprecated.- See Also:
-
getRoleMapForThread$UPDATES
static final boolean getRoleMapForThread$UPDATESDeprecated.- See Also:
-
activateUserSession$UPDATES
static final boolean activateUserSession$UPDATESDeprecated.- See Also:
-
getUsersToNotify$UPDATES
static final boolean getUsersToNotify$UPDATESDeprecated.- See Also:
-
getUsersToNotifyForForum$UPDATES
static final boolean getUsersToNotifyForForum$UPDATESDeprecated.- See Also:
-
isSubscribedToForum$UPDATES
static final boolean isSubscribedToForum$UPDATESDeprecated.- See Also:
-
subscribeToForum$UPDATES
static final boolean subscribeToForum$UPDATESDeprecated.- See Also:
-
unsubscribeFromForum$UPDATES
static final boolean unsubscribeFromForum$UPDATESDeprecated.- See Also:
-
enableForumAnonymousPosting$UPDATES
static final boolean enableForumAnonymousPosting$UPDATESDeprecated.- See Also:
-
disableForumAnonymousPosting$UPDATES
static final boolean disableForumAnonymousPosting$UPDATESDeprecated.- See Also:
-
setForumPublic$UPDATES
static final boolean setForumPublic$UPDATESDeprecated.- See Also:
-
setForumPrivate$UPDATES
static final boolean setForumPrivate$UPDATESDeprecated.- See Also:
-
getForumsPaging$UPDATES
static final boolean getForumsPaging$UPDATESDeprecated.- See Also:
-
findForumsPaging$UPDATES
static final boolean findForumsPaging$UPDATESDeprecated.- See Also:
-
getAllForumsPaging$UPDATES
static final boolean getAllForumsPaging$UPDATESDeprecated.- See Also:
-
getAllForumSummariesPaging$UPDATES
static final boolean getAllForumSummariesPaging$UPDATESDeprecated.- See Also:
-
getThreadsPaging$UPDATES
static final boolean getThreadsPaging$UPDATESDeprecated.- See Also:
-
getMessagesPaging$UPDATES
static final boolean getMessagesPaging$UPDATESDeprecated.- See Also:
-
getForumIdsByRelatedPaging$UPDATES
static final boolean getForumIdsByRelatedPaging$UPDATESDeprecated.- See Also:
-
getMessagesForThreadPaging$UPDATES
static final boolean getMessagesForThreadPaging$UPDATESDeprecated.- See Also:
-
getForumSummariesPaging$UPDATES
static final boolean getForumSummariesPaging$UPDATESDeprecated.- See Also:
-
getValidForumSummariesPaging$UPDATES
static final boolean getValidForumSummariesPaging$UPDATESDeprecated.- See Also:
-
getThreadSummariesPaging$UPDATES
static final boolean getThreadSummariesPaging$UPDATESDeprecated.- See Also:
-
getSponsoredThreadSummariesPaging$UPDATES
static final boolean getSponsoredThreadSummariesPaging$UPDATESDeprecated.- See Also:
-
getThreadedMessagesPaging$UPDATES
static final boolean getThreadedMessagesPaging$UPDATESDeprecated.- See Also:
-
getThreadSummariesForForumPaging$UPDATES
static final boolean getThreadSummariesForForumPaging$UPDATESDeprecated.- See Also:
-
addActorsToRolesInForums$UPDATES
static final boolean addActorsToRolesInForums$UPDATESDeprecated.- See Also:
-
allowedAnonymousPosting$UPDATES
static final boolean allowedAnonymousPosting$UPDATESDeprecated.- See Also:
-
getAllDeletedMessagesPaging$UPDATES
static final boolean getAllDeletedMessagesPaging$UPDATESDeprecated.- See Also:
-
getPermissionsForMessageIdsForSessionUser$UPDATES
static final boolean getPermissionsForMessageIdsForSessionUser$UPDATESDeprecated.- See Also:
-
getPermissionsForMessageIdsForUser$UPDATES
static final boolean getPermissionsForMessageIdsForUser$UPDATESDeprecated.- See Also:
-
getSubscribersForForum$UPDATES
static final boolean getSubscribersForForum$UPDATESDeprecated.- See Also:
-
isForumPublic$UPDATES
static final boolean isForumPublic$UPDATESDeprecated.- See Also:
-
notifyUserCreation$UPDATES
static final boolean notifyUserCreation$UPDATESDeprecated.- See Also:
-
notifyUsersCreation$UPDATES
static final boolean notifyUsersCreation$UPDATESDeprecated.- See Also:
-
getSubscribedThreadsPaging$UPDATES
static final boolean getSubscribedThreadsPaging$UPDATESDeprecated.- See Also:
-
getSubscribedForumsPaging$UPDATES
static final boolean getSubscribedForumsPaging$UPDATESDeprecated.- See Also:
-
getChildrenForMessagePaging$UPDATES
static final boolean getChildrenForMessagePaging$UPDATESDeprecated.- See Also:
-
getApplicationName$UPDATES
static final boolean getApplicationName$UPDATESDeprecated.- See Also:
-
getApplicationPermissions$UPDATES
static final boolean getApplicationPermissions$UPDATESDeprecated.- See Also:
-
getWorkspace$UPDATES
static final boolean getWorkspace$UPDATESDeprecated.- See Also:
-
createMessages$UPDATES
static final boolean createMessages$UPDATESDeprecated.- See Also:
-
createForums$UPDATES
static final boolean createForums$UPDATESDeprecated.- See Also:
-
importMessages$UPDATES
static final boolean importMessages$UPDATESDeprecated.- See Also:
-
getThreadsList$UPDATES
static final boolean getThreadsList$UPDATESDeprecated.- See Also:
-
getForumsList$UPDATES
static final boolean getForumsList$UPDATESDeprecated.- See Also:
-
getMessagesList$UPDATES
static final boolean getMessagesList$UPDATESDeprecated.- See Also:
-
validateGroupMembership$UPDATES
static final boolean validateGroupMembership$UPDATESDeprecated.- See Also:
-
updateUsernames$UPDATES
static final boolean updateUsernames$UPDATESDeprecated.- See Also:
-
commitUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATESDeprecated.- See Also:
-
rollbackUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATESDeprecated.- See Also:
-
inviteUsersToThread$UPDATES
static final boolean inviteUsersToThread$UPDATESDeprecated.- See Also:
-
acceptThreadInvitation$UPDATES
static final boolean acceptThreadInvitation$UPDATESDeprecated.- See Also:
-
denyThreadInvitation$UPDATES
static final boolean denyThreadInvitation$UPDATESDeprecated.- See Also:
-
isInvitedToThreads$UPDATES
static final boolean isInvitedToThreads$UPDATESDeprecated.- See Also:
-
changePartitionPaths$UPDATES
static final boolean changePartitionPaths$UPDATESDeprecated.- See Also:
-
reloadProperties$UPDATES
static final boolean reloadProperties$UPDATESDeprecated.- See Also:
-
validate$UPDATES
static final boolean validate$UPDATESDeprecated.- See Also:
-
validateTypedValues$UPDATES
static final boolean validateTypedValues$UPDATESDeprecated.- See Also:
-
setTimeZone$UPDATES
static final boolean setTimeZone$UPDATESDeprecated.- See Also:
-
setTimeZoneSameAs$UPDATES
static final boolean setTimeZoneSameAs$UPDATESDeprecated.- See Also:
-
getMessageCountByUsers$UPDATES
static final boolean getMessageCountByUsers$UPDATESDeprecated.- See Also:
-
getMessageCountByUsersForForum$UPDATES
static final boolean getMessageCountByUsersForForum$UPDATESDeprecated.- See Also:
-
getTopUsersForForum$UPDATES
static final boolean getTopUsersForForum$UPDATESDeprecated.- See Also:
-
getTopUsersForSite$UPDATES
static final boolean getTopUsersForSite$UPDATESDeprecated.- See Also:
-
getMessagesByUserPaging$UPDATES
static final boolean getMessagesByUserPaging$UPDATESDeprecated.- See Also:
-
-
Method Details
-
createForum
Deprecated.Create a discussion forum.- Parameters:
f_
- The forum to be created. The following fields of the passed object must be set:name
,creator
anddateCreated
. The value of theid
field is ignored (can benull
), 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 inForumsRoleMap
may create forums.DuplicateUuidException
- if the UUID of the forum already existsServiceException
- if any system-level error occurs
-
setAdministratorGroup
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
- ifgroupId_
is nullServiceException
- if any system-level error occurs
-
updateForum
Deprecated.Update the properties of a discussion forum. The fieldsid
andremoteId
are not changed.- Parameters:
f_
- TheForum
object whose properties should be used to update the existing forum. Theid
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 inForumsRoleMap
may update forums.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
updateForums
Deprecated.Update the properties of multiple discussion forums. The fieldsid
andremoteId
are not changed.- Parameters:
forums_
- An array ofForum
objects containing the properties that should be used to update the corresponding exisitng forums. Theid
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 inForumsRoleMap
may update forums.InvalidForumException
- if any one of the forum ids is invalidServiceException
- if any system-level error occurs
-
deleteForum
Deprecated.Delete a forum (and all of its threads).- Parameters:
forumId_
- The local id of the forum to be deleted (ie theid
field of aForum
object).- Throws:
PrivilegeException
- if the current user does not have sufficient privileges to delete the forum. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles inForumsRoleMap
may delete forums.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getForum
Deprecated.Get a forum.- Parameters:
id_
- The local id of the forum to be retrieved (ie theid
field of aForum
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 inForumsRoleMap
may view forums.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getForums
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 inForumsRoleMap
may view forums.InvalidForumException
- if any one of the forum ids is invalidServiceException
- if any system-level error occurs
-
getForumIdsByRelated
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 inObjectTypeMapping
).- 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
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 inForumsRoleMap
may delete threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
getThread
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 inForumsRoleMap
may view threads.InvalidThreadException
- if the passed id is invalidServiceException
- if any system-level error occurs
-
getThreads
@Deprecated DiscussionThread[] getThreads(Long[] threadIds_) throws PrivilegeException, InvalidThreadException 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 isnull
PrivilegeException
- if the user does not have sufficient privileges to view any of the threads. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles inForumsRoleMap
may view threads.InvalidThreadException
- if any of the threads is invalidServiceException
- if any system-level error occurs
-
getThreadsForForum
@Deprecated DiscussionThread[] getThreadsForForum(Long forumId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) throws InvalidForumException Deprecated.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 aSORT_PROPERTY_THREAD_XXX
constant.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Returns:
- The desired threads.
- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getThreadsForForumPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inDiscussionThread
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofDiscussionThread
objects. - Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
moveThread
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 inForumsRoleMap
may move threads.InvalidThreadException
- if the passed thread id is invalidInvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
addThreadResource
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. Theattached
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 inForumsRoleMap
may add resources to threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
addThreadResources
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. Theattached
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 inForumsRoleMap
may add resources to threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
removeThreadResource
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. Theattached
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 inForumsRoleMap
may remove resources from threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
removeThreadResources
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. Theattached
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 inForumsRoleMap
may remove resources from threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
subscribeToThread
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 inForumsRoleMap
may subscribe to threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
subscribeUsersToThread
@Deprecated void subscribeUsersToThread(Long threadId_, String[] users_) throws InvalidUserException, InvalidThreadException, PrivilegeException Deprecated.the combination ofinviteUsersToThread(java.lang.String[], java.lang.Long)
andacceptThreadInvitation(java.lang.Long)
is more secure, and should be used insteadSubscribe 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 invalidInvalidThreadException
- if the passed thread id is invalidPrivilegeException
- if the current user does not have sufficient privileges to subscirbe the passed users to the thread. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles inForumsRoleMap
may remove resources from threads.ServiceException
- if any system-level error occurs
-
unsubscribeFromThread
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 inForumsRoleMap
may unsubscribe from threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
isSubscribedToThread
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, andfalse
otherwise- Throws:
ServiceException
- if any system-level error occursInvalidThreadException
- if the passed thread id is invalid
-
getSubscribersForThread
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 invalidServiceException
- if any system-level error occurs
-
sponsor
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 inForumsRoleMap
may sponsor threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
unsponsor
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 inForumsRoleMap
may unsponsor threads.InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
sponsorForMessage
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 inForumsRoleMap
may sponsor threads.InvalidMessageException
- if the passed message id is invalidServiceException
- if any system-level error occurs
-
unsponsorForMessage
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 inForumsRoleMap
may unsponsor threads.InvalidMessageException
- if the passed message id is invalidServiceException
- if any system-level error occurs
-
createMessage
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 toDiscussionBodyService.createMessage(com.appiancorp.suiteapi.forums.Message)
, using thefilename
returned by this method.- Parameters:
forumId_
- The id of the forum in which to create the new message.m_
- TheMessage
object from which to create the message. The minimum required fields that must be set in the object are:threadId
,parentId
,subject
, andanonymousAuthor
. When creating a new thread, thethreadId
andparentId
fields should be set to 0 or null. Theid
,remoteId
, andfilename
will be assigned by the server.- Returns:
- The new message, with the
id
,remoteId
, andfilename
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 inForumsRoleMap
may create messages.InvalidMessageException
- if theparentId
of the passed message is invalidIllegalArgumentException
- if the user attempts to post the message anonymously but the Forum does not accept anonymous postsInvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occursNullPointerException
- if them_
message is null
-
updateMessage
String updateMessage(Message m_) throws PrivilegeException, IllegalArgumentException, InvalidMessageException Deprecated.Update the properties of a message. Theid
,remoteId
, andfilename
fields are not changed.- Parameters:
m_
- TheMessage
object whose properties should be used to update the existing message. Theid
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 ofid
,remoteId
, andfilename
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 inForumsRoleMap
may update messages.IllegalArgumentException
- if the user attempts to post the message anonymously but the Forum does not accept anonymous postsInvalidMessageException
- if no message exists with the same id as the message passed inServiceException
- if any system-level error occurs
-
updateMessages
Deprecated.Update the properties of multiple messages. Theid
,remoteId
, andfilename
fields are not changed.- Parameters:
m_
- An array ofMessage
objects containing the properties that should be used to update the corresponding existing messages. Theid
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 ofid
,remoteId
, andfilename
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 inForumsRoleMap
may uupdate messages.InvalidMessageException
- if no message exists with the same id as the message passed inServiceException
- if any system-level error occurs
-
getMessage
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 inForumsRoleMap
may view messages.InvalidMessageException
- if the message does not exist or has been deletedServiceException
- if any system-level error occurs
-
getMessages
@Deprecated Message[] getMessages(Long[] messageIds_) throws PrivilegeException, InvalidMessageException Deprecated.Get multiple messages.- Parameters:
messageIds_
- The ids of the messages to be returned.- Returns:
- The desired messages.
- Throws:
NullPointerException
- if the passedmessageIds
array contains anull
elementPrivilegeException
- 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 inForumsRoleMap
may view messages.InvalidMessageException
- if any one of the messages does not exist or has been deletedServiceException
- if any system-level error occurs
-
getMessagesForThread
@Deprecated Message[] getMessagesForThread(Long threadId_, Integer sortProperty_, Integer sortOrder_, int startIndex_, int count_) throws InvalidThreadException Deprecated.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 aSORT_PROPERTY_MESSAGE
constant.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Returns:
- The desired messages.
- Throws:
InvalidThreadException
- of the thread is invalidServiceException
- if any system-level error occurs
-
addRating
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 inForumsRoleMap
may add ratings to messages.InvalidMessageException
- if the passed message id is invalidServiceException
- if any system-level error occurs
-
setRating
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 inForumsRoleMap
may set ratings of messages.InvalidMessageException
- if the message is invalidServiceException
- if any system-level error occurs- See Also:
-
deleteMessageAndDescendants
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 inForumsRoleMap
may delete messages.InvalidMessageException
- if the passed message id is invalidServiceException
- if any system-level error occurs
-
deleteMessage
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 inForumsRoleMap
may delete messages.InvalidMessageException
- if the passed message id is invalidServiceException
- if any system-level error occurs
-
setRoleMapForForum
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 forumr_
- The role map to set.- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occursPrivilegeException
-
getRoleMapForForum
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 invalidServiceException
- if any system-level error occurs
-
getRoleMapForThread
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 invalidServiceException
- if any system-level error occurs
-
activateUserSession
@Deprecated 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 ofUserProfile.USER_TYPE_BASIC
orUserProfile.USER_TYPE_SYS_ADMIN
- Returns:
- A
boolean
array of three system permissions. Element [0] of the returned array indicates whether the current user cancreateForum
; element [1] of the array indicates whether the current user cangetAllDeletedMessagesPaging
; and [2] indicates whether the current user canimportMessages
. See the forums security map description in the overall service description. - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
getUsersToNotify
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 invalidServiceException
- if any system-level error occurs
-
getUsersToNotifyForForum
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 invalidServiceException
- if any system-level error occurs
-
isSubscribedToForum
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, andfalse
otherwise- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
subscribeToForum
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 invalidPrivilegeException
- if the current user does not have sufficient privileges to subscribe to the forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, READER, and WRITER roles inForumsRoleMap
may subscribe to forums.ServiceException
- if any system-level error occurs
-
unsubscribeFromForum
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 invalidPrivilegeException
- if the current user does not have sufficient privileges to unsubscribe from the forum. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, READER, and WRITER roles inForumsRoleMap
may unsubscribe from forums.ServiceException
- if any system-level error occurs
-
enableForumAnonymousPosting
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 inForumsRoleMap
may enable anonymous posting on forums.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
disableForumAnonymousPosting
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 inForumsRoleMap
may disable anonymous posting on forums.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
setForumPublic
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 inForumsRoleMap
may set forums as public.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
setForumPrivate
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 inForumsRoleMap
may set forums as private.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getForumsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForum
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForum
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 inForumsRoleMap
may view forums.InvalidForumException
- if any one of the passed forum ids is invalidServiceException
- if any system-level error occurs
-
findForumsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForum
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForum
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getAllForumsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForum
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForum
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getAllForumSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForumSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForumSummary
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getThreadsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inDiscussionThread
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofDiscussionThread
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 inForumsRoleMap
may view threads.InvalidThreadException
- if any one of the passed thread ids is invalidServiceException
- if any system-level error occurs
-
getMessagesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inMessage
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofMessage
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 inForumsRoleMap
may view messages.InvalidMessageException
- if any one of the passed message ids is invalidServiceException
- if any system-level error occurs
-
getForumIdsByRelatedPaging
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 inObjectTypeMapping
).- Parameters:
related_
- The identifier specifiying the object for which related forums are to be returned (thetype
, and eitherid
orstringId
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofLong
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getMessagesForThreadPaging
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 IDstartIndex_
- 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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inMessage
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofMessage
objects. - Throws:
InvalidThreadException
- if the passed thread id is invalidServiceException
- if any system-level error occurs
-
getForumSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForumSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForumSummary
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 inForumsRoleMap
may view forums.InvalidForumException
- if any one of the passed forum ids is invalidServiceException
- if any system-level error occurs
-
getValidForumSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForumSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForumSummary
objects.
-
getThreadSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inThreadSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofThreadSummary
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 inForumsRoleMap
may get thread summaries.InvalidThreadException
- if any one of the passed thread ids is invalidServiceException
- if any system-level error occurs
-
getSponsoredThreadSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inThreadSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofThreadSummary
objects. - Throws:
PrivilegeException
- if the current user does not have sufficient privileges to sponsor threads. Only SYSADMIN, APPADMIN, OWNER, and ADMINISTRATOR roles inForumsRoleMap
may sponsor threads.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getSponsoredThreadSummariesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inThreadSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofThreadSummary
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 inForumsRoleMap
may sponsor threads.InvalidForumException
- if any one of the passed forum ids is invalidServiceException
- if any system-level error occurs
-
getThreadedMessagesPaging
ResultPage getThreadedMessagesPaging(Long forumId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidForumException Deprecated.Get all the messages in a forum asThreadedMessage
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inThreadedMessage
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofThreadedMessage
objects. - Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getThreadSummariesForForumPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inThreadSummary
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofThreadSummary
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 inForumsRoleMap
may view threads.InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
addActorsToRolesInForums
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 theROLE_XXX
constants defined inForumsRoleMap
.- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
allowedAnonymousPosting
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, andfalse
otherwise- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
getAllDeletedMessagesPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inMessage
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofMessage
objects. - Throws:
PrivilegeException
- if the current user does not have sufficient privileges to view deleted messages. Only SYSADMIN and APPADMIN roles inForumsRoleMap
may view deleted messages.ServiceException
- if any system-level error occurs
-
getPermissionsForMessageIdsForSessionUser
Deprecated.Get the permissions that the current user has for the given messages.- Parameters:
messageIds_
- The ids of messages.- Returns:
- An array of
int
s, each of which represents the current user's permission level for the corresponding message. This is one of theMESSAGE_PERMISSION_XXX
constants defined by this class. - Throws:
ServiceException
- if any system-level error occurs
-
getPermissionsForMessageIdsForUser
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
int
s, each of which represents the passed user's permission level for the corresponding message. This is one of theMESSAGE_PERMISSION_XXX
constants defined by this class. - Throws:
ServiceException
- if any system-level error occurs
-
getSubscribersForForum
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 invalidServiceException
- if any system-level error occurs
-
isForumPublic
Deprecated.Returns whether a forum is public.- Parameters:
forumId_
- The id of a forum.- Returns:
true
if the given forum is public, andfalse
otherwise- Throws:
InvalidForumException
- if the passed forum id is invalidServiceException
- if any system-level error occurs
-
notifyUserCreation
Deprecated.done automatically by UserService.createUserNotifies 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 (ieactivateUserSession
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
Deprecated.Notifies this service that new users have been created (seenotifyUserCreation(java.lang.String)
).- Parameters:
usernames_
- The usernames (ie logins) of the new users.- Throws:
ServiceException
- if any system-level error occurs
-
getSubscribedThreadsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inDiscussionThread
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofDiscussionThread
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getSubscribedForumsPaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inForum
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofForum
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getChildrenForMessagePaging
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. UseConstants.COUNT_ALL
to return all results fromstartIndex_
to the end, but this is STRONGLY discouraged.sortProperty_
- The property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants defined inMessage
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- A
Resultpage
containing an array ofMessage
objects. - Throws:
InvalidMessageException
- if the passed message id is invalidPrivilegeException
- if the current user does not have sufficient permissios to view messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, WRITER, and READER roles inForumsRoleMap
may view messages.ServiceException
- if any system-level error occurs
-
getApplicationName
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
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 cancreateForum
; element [1] of the array indicates whether the current user cangetAllDeletedMessagesPaging
; and [2] indicates whether the current user canimportMessages
. See the forums security map description in the overall service description.
-
getWorkspace
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
- Throws:
ServiceException
- if any system-level error occurs
-
createMessages
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 toDiscussionBodyService.createMessages(com.appiancorp.suiteapi.forums.Message[])
, using thefilename
s returned by this method.- Parameters:
forumIds_
- The ids of the forums in which to create the new messages.msgs_
- TheMessage
objects from which to create the messages. The minimum required fields that must be set in each object are:threadId
,parentId
,subject
, andanonymousAuthor
. When creating a new thread, thethreadId
andparentId
fields should be set to0
. Theid
,remoteId
, andfilename
fields will be assigned by the server.- Returns:
- The new messages, with the
id
,remoteId
, andfilename
fields properly populated. - Throws:
InvalidForumException
- if any one of the passed forum ids is invalidInvalidMessageException
- if theparentId
of any one of the passed messages does not existIllegalArgumentException
- if theforumIds_
array is not the same length as themsgs_
arrayPrivilegeException
- if the current user does not have sufficient privileges to create messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles inForumsRoleMap
may create messages.ServiceException
- if any system-level error occursNullPointerException
- if themsgs_
array or one or more elements in the the array is null.
-
createForums
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
anddateCreated
. The value of theid
field is ignored (can benull
), 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 inForumsRoleMap
may create forums.DuplicateUuidException
- if the UUID of any of the forums already exists or if the same UUID is passed in for several forumsServiceException
- if any system-level error occurs
-
importMessages
Message[] importMessages(Long[] forumIds_, Message[] msgs_) throws InvalidForumException, InvalidMessageException, IllegalArgumentException, PrivilegeException Deprecated.Import multiple messages, one per forum. This method will use thedatePosted
andauthor
values specified in the passedMessage
objects instead of assigning them on the server. NOTE: To physically store the messages to disk, this call must be followed by a call toDiscussionBodyService.createMessages(com.appiancorp.suiteapi.forums.Message[])
, using thefilename
s returned by this method.- Parameters:
forumIds_
- The ids of the forums in which to create the messages.msgs_
- TheMessage
objects from which to create the messages. The minimum required fields that must be set in each object are:threadId
,parentId
,subject
,anonymousAuthor
,datePosted
, andauthor
. When creating a new thread, thethreadId
andparentId
fields should be set to0
. Theid
,remoteId
, andfilename
fields will be assigned by the server.- Returns:
- The imported messages, with the
id
,remoteId
, andfilename
fields properly populated. - Throws:
InvalidForumException
- if any one of the passed forum ids is invalidInvalidMessageException
- if theparentId
of any one of the passed messages is invalidIllegalArgumentException
- if theforumIds_
array is not the same length as themsgs_
arrayPrivilegeException
- if the current user does not have sufficient privileges to create messages. Only SYSADMIN, APPADMIN, OWNER, ADMINISTRATOR, and WRITER roles inForumsRoleMap
may create messages.ServiceException
- if any system-level error occurs
-
getThreadsList
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. theResult.getResults()
method should be used to get all the threads that were successfully retrieved. In additionResultList.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, andResultList.CODE_VALID
= the user can see the thread - Throws:
ServiceException
- if any system-level error occurs
-
getForumsList
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. theResult.getResults()
method should be used to get all the forums that were successfully retrieved. In additionResultList.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 theCODE_XXX
constants inResultList
for details. - Throws:
ServiceException
- if any system-level error occursInvalidUserException
-
getMessagesList
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. theResult.getResults()
method should be used to get all the messages that were successfully retrieved. In additionResultList.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 theCODE_XXX
constants inResultList
for details. - Throws:
ServiceException
- if any system-level error occurs
-
validateGroupMembership
@Deprecated boolean validateGroupMembership(Long[] memGroupIds_, Long[] admGroupIds_) throws InvalidUserException Deprecated.No longer necessary with credential systemValidates 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 memberadmGroupIds_
- 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 existServiceException
- if any system-level error occurs
-
updateUsernames
@Deprecated void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, PrivilegeException, DuplicateNameException Deprecated.DEPRECATED: SeeUserService.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()
. AftercommitUpdateUsernames
has been called, the old usernames will still be active, but will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifupdateUsernames
is successful butcommitUpdateUsernames
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 updatednewUsernames_
- the usernames to which the old usernames will be updatedmaxExpirationTimeInSeconds_
- the interval, in seconds, aftercommitUpdateUsernames
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 ofoldUsernames_
is not the same as the length ofnewUsernames_
.PrivilegeException
- if the current user is not a system administratorDuplicateNameException
- if anyoldUsernames_
ornewUsernames_
contain any duplicates, or if an old username is being updated to a username that already existsServiceException
- if any system-level error occurs
-
commitUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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 bymaxExpirationTimeInSeconds_
; ifcommitUpdateUsernames
is not called, the new usernames will not become active.- Throws:
ServiceException
- if any system-level error occurs
-
rollbackUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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
void inviteUsersToThread(String[] usernames_, Long threadId_) throws InvalidThreadException, PrivilegeException Deprecated.Add invitation for the given users to the giventhread
. Later, the invitee can accept the invitation byacceptThreadInvitation
or deny the invitation bydenyThreadInvitation
, after which the invitation becomes void.- Parameters:
usernames_
- the users to invitethreadId_
- the thread to which they are invites- Throws:
InvalidThreadException
- if the thread does not existPrivilegeException
- if the requesting user cannot subscribe other users to thread. Only SYSADMIN, APPADMIN, ADMINISTRATOR, and OWNER can subscribe other users.
-
acceptThreadInvitation
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 existPrivilegeException
- if the user wasn't invited
-
denyThreadInvitation
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
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
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.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
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
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
Deprecated.Set a backend timezone.- Parameters:
tz
-
-
setTimeZoneSameAs
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, useGlobalizationService.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
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
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 forfromDate
- The initial date for the querytoDate
- 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
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 forfromDate
- The initial date for the querytoDate
- The end date for the queryforumId
- 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 privilegesInvalidForumException
-
getTopUsersForForum
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 querytoDate
- The end date for the queryforumId
- Identifier of the forum to get statistics fromtopNUsers
- 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 invalidPrivilegeException
- thrown if user does not have admin privileges
-
getTopUsersForSite
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 querytoDate
- The end date for the querytopNUsers
- 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
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 retreivedstartIndex
- The index into the collection of total results at which to startbatchSize
- The number of results to returnsortProperty
- 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
-