Package org.sakaiproject.conversations.api

Interface ConversationsService

public interface ConversationsService

Field Summary

Fields

Modifier and Type	Field	Description
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

Method Summary

Modifier and Type	Method	Description
void	bookmarkTopic(String topicId, boolean bookmarked)
List<Tag>	createTags(List<Tag> tags)
boolean	deleteComment(String siteId, String commentId)
boolean	deletePost(String siteId, String topicId, String postId, boolean setTopicResolved)
void	deleteTag(Long tagId)
boolean	deleteTopic(String topicId)
ConvStatus	getConvStatusForSiteAndUser(String siteId, String userId)
List<PostTransferBean>	getPostsByTopicId(String siteId, String topicId)
Settings	getSettingsForSite(String siteId)
Map<String,Object>	getSiteStats(String siteId, Instant from, Instant to, int page, String sort)
List<Tag>	getTagsForSite(String siteId)
List<TopicTransferBean>	getTopicsForSite(String siteId)
void	hidePost(String postId, boolean hidden, String siteId)
void	hideTopic(String topicId, boolean hidden)
PostTransferBean	lockPost(String siteId, String topicId, String postId, boolean locked)
TopicTransferBean	lockTopic(String topicId, boolean locked)
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)
Map<Reaction,Integer>	savePostReactions(String postId, Map<Reaction,Boolean> reactions)
Settings	saveSettings(Settings settings)
Tag	saveTag(Tag tag)
TopicTransferBean	saveTopic(TopicTransferBean topicBean)
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

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

Method Detail

getTopicsForSite

List<TopicTransferBean> getTopicsForSite(String siteId)
                                  throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

saveTopic

TopicTransferBean saveTopic(TopicTransferBean topicBean)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deleteTopic

boolean 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)
                     throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

hideTopic

void hideTopic(String topicId,
               boolean hidden)
        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

savePost

PostTransferBean savePost(PostTransferBean postBean)
                   throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

getPostsByTopicId

List<PostTransferBean> getPostsByTopicId(String siteId,
                                         String topicId)
                                  throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deletePost

boolean 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

void hidePost(String postId,
              boolean hidden,
              String siteId)
       throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

savePostReactions

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

Throws:

ConversationsPermissionsException

markPostsViewed

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

Throws:

ConversationsPermissionsException

saveComment

CommentTransferBean saveComment(CommentTransferBean commentBean)
                         throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

deleteComment

boolean deleteComment(String siteId,
                      String commentId)
               throws ConversationsPermissionsException

Throws:

ConversationsPermissionsException

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