Package org.sakaiproject.conversations.api

Interface ConversationsService

public interface ConversationsService

Field Summary

Fields

Modifier and Type	Field	Description
static String	POSTS_CACHE_NAME
static String	PROP_DISABLE_DISCUSSIONS
static String	PROP_MAX_THREAD_DEPTH
static String	PROP_THREADS_PAGE_SIZE
static String	REFERENCE_ROOT
static String	SORT_NAME_ASCENDING
static String	SORT_NAME_DESCENDING
static String	SORT_POSTS_CREATED_ASCENDING
static String	SORT_POSTS_CREATED_DESCENDING
static String	SORT_REACTIONS_MADE_ASCENDING
static String	SORT_REACTIONS_MADE_DESCENDING
static String	SORT_TOPICS_CREATED_ASCENDING
static String	SORT_TOPICS_CREATED_DESCENDING
static String	SORT_TOPICS_VIEWED_ASCENDING
static String	SORT_TOPICS_VIEWED_DESCENDING
static String	STATS_CACHE_NAME
static String	TOOL_ID

Method Summary

Modifier and Type	Method	Description
void	bookmarkTopic(String topicId, boolean bookmarked)
List<Tag>	createTags(List<Tag> tags)
boolean	currentUserCanViewComment(ConversationsComment comment)
boolean	currentUserCanViewPost(ConversationsPost post)
boolean	currentUserCanViewTopic(ConversationsTopic topic)
void	deleteComment(String siteId, String commentId)
void	deletePost(String siteId, String topicId, String postId, boolean setTopicResolved)
void	deleteTag(Long tagId)
void	deleteTopic(String topicId)
TopicTransferBean	getBlankTopic(String siteId)
Optional<CommentTransferBean>	getComment(String commentId)
Optional<String>	getCommentPortalUrl(String commentId)
ConvStatus	getConvStatusForSiteAndUser(String siteId, String userId)
int	getNumberOfThreadPages(String siteId, String topicId)
Optional<PostTransferBean>	getPost(String postId)
Optional<String>	getPostPortalUrl(String topicId, String postId)
Collection<PostTransferBean>	getPostsByTopicId(String siteId, String topicId, Integer page, PostSort sort, String requestedPostId)
Settings	getSettingsForSite(String siteId)
Map<String,Object>	getSiteStats(String siteId, Instant from, Instant to, int page, String sort)
List<Tag>	getTagsForSite(String siteId)
Optional<TopicTransferBean>	getTopic(String siteId)
Optional<String>	getTopicPortalUrl(String topicId)
List<TopicTransferBean>	getTopicsForSite(String siteId)
PostTransferBean	hidePost(String siteId, String topicId, String postId, boolean hiddn)
ConversationsTopic	hideTopic(String topicId, boolean hidden, boolean needsModerator)
PostTransferBean	lockPost(String siteId, String topicId, String postId, boolean locked)
TopicTransferBean	lockTopic(String topicId, boolean locked, boolean needsModerator)
void	markPostsViewed(Set<String> postIds, String topicId)
void	pinTopic(String topicId, boolean pinned)
CommentTransferBean	saveComment(CommentTransferBean commentBean)
void	saveConvStatus(ConvStatus convStatus)
PostTransferBean	savePost(PostTransferBean postBean, boolean sendMessage)
Map<Reaction,Integer>	savePostReactions(String topicId, String postId, Map<Reaction,Boolean> reactions)
Settings	saveSettings(Settings settings)
Tag	saveTag(Tag tag)
TopicTransferBean	saveTopic(TopicTransferBean topicBean, boolean sendMessage)
Map<Reaction,Integer>	saveTopicReactions(String topicId, Map<Reaction,Boolean> reactions)
PostTransferBean	unUpvotePost(String siteId, String postId)
PostTransferBean	upvotePost(String siteId, String topicId, String postId)

Field Detail

TOOL_ID

static final String TOOL_ID

See Also:

Constant Field Values

REFERENCE_ROOT

static final String REFERENCE_ROOT

See Also:

Constant Field Values

SORT_NAME_ASCENDING

static final String SORT_NAME_ASCENDING

See Also:

Constant Field Values

SORT_NAME_DESCENDING

static final String SORT_NAME_DESCENDING

See Also:

Constant Field Values

SORT_TOPICS_CREATED_ASCENDING

static final String SORT_TOPICS_CREATED_ASCENDING

See Also:

Constant Field Values

SORT_TOPICS_CREATED_DESCENDING

static final String SORT_TOPICS_CREATED_DESCENDING

See Also:

Constant Field Values

SORT_TOPICS_VIEWED_ASCENDING

static final String SORT_TOPICS_VIEWED_ASCENDING

See Also:

Constant Field Values

SORT_TOPICS_VIEWED_DESCENDING

static final String SORT_TOPICS_VIEWED_DESCENDING

See Also:

Constant Field Values

SORT_POSTS_CREATED_ASCENDING

static final String SORT_POSTS_CREATED_ASCENDING

See Also:

Constant Field Values

SORT_POSTS_CREATED_DESCENDING

static final String SORT_POSTS_CREATED_DESCENDING

See Also:

Constant Field Values

SORT_REACTIONS_MADE_ASCENDING

static final String SORT_REACTIONS_MADE_ASCENDING

See Also:

Constant Field Values

SORT_REACTIONS_MADE_DESCENDING

static final String SORT_REACTIONS_MADE_DESCENDING

See Also:

Constant Field Values

PROP_THREADS_PAGE_SIZE

static final String PROP_THREADS_PAGE_SIZE

See Also:

Constant Field Values

PROP_MAX_THREAD_DEPTH

static final String PROP_MAX_THREAD_DEPTH

See Also:

Constant Field Values

PROP_DISABLE_DISCUSSIONS

static final String PROP_DISABLE_DISCUSSIONS

See Also:

Constant Field Values

STATS_CACHE_NAME

static final String STATS_CACHE_NAME

See Also:

Constant Field Values

POSTS_CACHE_NAME

static final String POSTS_CACHE_NAME

See Also:

Constant Field Values

Method Detail

getBlankTopic

TopicTransferBean getBlankTopic(String siteId)
                         throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getTopic

Optional<TopicTransferBean> getTopic(String siteId)
                              throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

currentUserCanViewTopic

boolean currentUserCanViewTopic(ConversationsTopic topic)

getTopicsForSite

List<TopicTransferBean> getTopicsForSite(String siteId)
                                  throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getTopicPortalUrl

Optional<String> getTopicPortalUrl(String topicId)

saveTopic

TopicTransferBean saveTopic(TopicTransferBean topicBean,
                            boolean sendMessage)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deleteTopic

void deleteTopic(String topicId)
          throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

pinTopic

void pinTopic(String topicId,
              boolean pinned)
       throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

lockTopic

TopicTransferBean lockTopic(String topicId,
                            boolean locked,
                            boolean needsModerator)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

hideTopic

ConversationsTopic hideTopic(String topicId,
                             boolean hidden,
                             boolean needsModerator)
                      throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

bookmarkTopic

void bookmarkTopic(String topicId,
                   boolean bookmarked)
            throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveTopicReactions

Map<Reaction,Integer> saveTopicReactions(String topicId,
                                               Map<Reaction,Boolean> reactions)
                                        throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getPost

Optional<PostTransferBean> getPost(String postId)
                            throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

savePost

PostTransferBean savePost(PostTransferBean postBean,
                          boolean sendMessage)
                   throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getPostPortalUrl

Optional<String> getPostPortalUrl(String topicId,
                                  String postId)

getNumberOfThreadPages

int getNumberOfThreadPages(String siteId,
                           String topicId)
                    throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getPostsByTopicId

Collection<PostTransferBean> getPostsByTopicId(String siteId,
                                               String topicId,
                                               Integer page,
                                               PostSort sort,
                                               String requestedPostId)
                                        throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deletePost

void deletePost(String siteId,
                String topicId,
                String postId,
                boolean setTopicResolved)
         throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

upvotePost

PostTransferBean upvotePost(String siteId,
                            String topicId,
                            String postId)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

unUpvotePost

PostTransferBean unUpvotePost(String siteId,
                              String postId)
                       throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

lockPost

PostTransferBean lockPost(String siteId,
                          String topicId,
                          String postId,
                          boolean locked)
                   throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

hidePost

PostTransferBean hidePost(String siteId,
                          String topicId,
                          String postId,
                          boolean hiddn)
                   throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

savePostReactions

Map<Reaction,Integer> savePostReactions(String topicId,
                                              String postId,
                                              Map<Reaction,Boolean> reactions)
                                       throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

markPostsViewed

void markPostsViewed(Set<String> postIds,
                     String topicId)
              throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

currentUserCanViewPost

boolean currentUserCanViewPost(ConversationsPost post)

currentUserCanViewComment

boolean currentUserCanViewComment(ConversationsComment comment)

getComment

Optional<CommentTransferBean> getComment(String commentId)
                                  throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveComment

CommentTransferBean saveComment(CommentTransferBean commentBean)
                         throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deleteComment

void deleteComment(String siteId,
                   String commentId)
            throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getCommentPortalUrl

Optional<String> getCommentPortalUrl(String commentId)

createTags

List<Tag> createTags(List<Tag> tags)
              throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveTag

Tag saveTag(Tag tag)
     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getTagsForSite

List<Tag> getTagsForSite(String siteId)
                  throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deleteTag

void deleteTag(Long tagId)
        throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getSettingsForSite

Settings getSettingsForSite(String siteId)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveSettings

Settings saveSettings(Settings settings)
               throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getConvStatusForSiteAndUser

ConvStatus getConvStatusForSiteAndUser(String siteId,
                                       String userId)
                                throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveConvStatus

void saveConvStatus(ConvStatus convStatus)
             throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getSiteStats

Map<String,Object> getSiteStats(String siteId,
                                      Instant from,
                                      Instant to,
                                      int page,
                                      String sort)
                               throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException