| org.sakaiproject.api.app.messageforums.ui.PrivateMessageManager
All known Subclasses: org.sakaiproject.component.app.messageforums.ui.PrivateMessageManagerImpl,
PrivateMessageManager | public interface PrivateMessageManager (Code) | | |
Method Summary | |
public void | addAttachToPvtMsg(PrivateMessage pvtMsgData, Attachment pvtMsgAttach) | public PrivateMessage | createPrivateMessage(String typeUuid) | public Attachment | createPvtMsgAttachment(String attachId, String name) | public void | createTopicFolderInForum(PrivateForum pf, String foderName) | public void | createTopicFolderInTopic(PrivateForum pf, PrivateTopic parentTopic, String folderName) | public void | deletePrivateMessage(PrivateMessage message, String typeUuid) | public void | deleteTopicFolder(PrivateForum pf, String topicId) | public int | findMessageCount(String typeUuid) | public int | findUnreadMessageCount(String typeUuid) | public String | getContextId() | public String | getContextSiteId() | public List | getDeletedMessages(String orderField, String order) | public List | getDraftedMessages(String orderField, String order) | public Message | getMessageById(Long messageId) | public MessageForumsMessageManager | getMessageManager() | public List | getMessagesByTopic(String userId, Long topicId) | public List | getMessagesByType(String typeUuid, String orderField, String order) | public List | getMessagesByTypeByContext(String typeUuid, String contextId) | public PrivateMessage | getNextMessage(PrivateMessage message) | public PrivateMessage | getPreviousMessage(PrivateMessage message) | Area | getPrivateMessageArea() | public List | getPrivateMessageCountsForAllSites() | public Attachment | getPvtMsgAttachment(Long pvtMsgAttachId) | public List | getReceivedMessages(String orderField, String order) | public List | getSentMessages(String orderField, String order) | public Topic | getTopicByUuid(String topicUuid) | int | getTotalNoMessages(Topic topic) | int | getUnreadNoMessages(Topic topic) | public boolean | hasNextMessage(PrivateMessage message) | public boolean | hasPreviousMessage(PrivateMessage message) | public PrivateMessage | initMessageWithAttachmentsAndRecipients(PrivateMessage msg) | public PrivateForum | initializationHelper(PrivateForum forum, Area area) | public PrivateForum | initializePrivateMessageArea(Area area) | public boolean | isInstructor() | public boolean | isMutableTopicFolder(String parentTopicId) | boolean | isPrivateAreaEnabled() | public void | markMessageAsReadForUser(PrivateMessage message) | public void | markMessageAsReadForUser(PrivateMessage message, String contextId) | public void | movePvtMsgTopic(PrivateMessage message, Topic oldTopic, Topic newTopic) | public void | removePvtMsgAttachment(Attachment o) | public void | renameTopicFolder(PrivateForum pf, String topicId, String newName) | public void | saveAreaAndForumSettings(Area area, PrivateForum forum) | public void | saveForumSettings(PrivateForum forum) | void | savePrivateMessage(Message message) | public void | savePrivateMessageArea(Area area) | public List | searchPvtMsgs(String typeUuid, String searchText, Date searchFromDate, Date searchToDate, boolean searchByText, boolean searchByAuthor, boolean searchByBody, boolean searchByLabel, boolean searchByDate) | public void | sendPrivateMessage(PrivateMessage message, Set recipients, boolean asEmail) |
SORT_COLUMN_ATTACHMENT | public static String SORT_COLUMN_ATTACHMENT(Code) | | |
SORT_COLUMN_AUTHOR | public static String SORT_COLUMN_AUTHOR(Code) | | |
SORT_COLUMN_LABEL | public static String SORT_COLUMN_LABEL(Code) | | |
SORT_COLUMN_SUBJECT | public static String SORT_COLUMN_SUBJECT(Code) | | |
createPrivateMessage | public PrivateMessage createPrivateMessage(String typeUuid)(Code) | | create private message with type
Parameters: typeUuid - private message |
createTopicFolderInForum | public void createTopicFolderInForum(PrivateForum pf, String foderName)(Code) | | create a folder in Private forum
|
deletePrivateMessage | public void deletePrivateMessage(PrivateMessage message, String typeUuid)(Code) | | mark message as deleted for user
Parameters: message - |
findMessageCount | public int findMessageCount(String typeUuid)(Code) | | find message count for type
Parameters: typeUuid - count |
findUnreadMessageCount | public int findUnreadMessageCount(String typeUuid)(Code) | | find unread message count for type
Parameters: typeUuid - count |
getPrivateMessageArea | Area getPrivateMessageArea()(Code) | | retrieve private message area if it is enabled for the current user
area |
getPrivateMessageCountsForAllSites | public List getPrivateMessageCountsForAllSites()(Code) | | |
getTopicByUuid | public Topic getTopicByUuid(String topicUuid)(Code) | | Get the Topic from uuid
TODO - this can be replaced with another method which doesn't return messages
|
getTotalNoMessages | int getTotalNoMessages(Topic topic)(Code) | | |
getUnreadNoMessages | int getUnreadNoMessages(Topic topic)(Code) | | |
isInstructor | public boolean isInstructor()(Code) | | |
isMutableTopicFolder | public boolean isMutableTopicFolder(String parentTopicId)(Code) | | |
isPrivateAreaEnabled | boolean isPrivateAreaEnabled()(Code) | | check if private message area is enabled for the current user
boolean |
savePrivateMessage | void savePrivateMessage(Message message)(Code) | | Save private message
Parameters: message - Parameters: recipients - |
savePrivateMessageArea | public void savePrivateMessageArea(Area area)(Code) | | |
searchPvtMsgs | public List searchPvtMsgs(String typeUuid, String searchText, Date searchFromDate, Date searchToDate, boolean searchByText, boolean searchByAuthor, boolean searchByBody, boolean searchByLabel, boolean searchByDate)(Code) | | advanced search for private messages
|
sendPrivateMessage | public void sendPrivateMessage(PrivateMessage message, Set recipients, boolean asEmail)(Code) | | send private message to recipients
Parameters: message - Parameters: recipients - Parameters: asEmail - |
|
|