@Role
public interface MailStatusStore
Modifier and Type | Method and Description |
---|---|
long |
count(Map<String,Object> filterMap)
Count the number of message statuses matching the passed filters.
|
void |
delete(String uniqueMessageId,
Map<String,Object> parameters)
Delete a message.
|
List<MailStatus> |
load(Map<String,Object> filterMap,
int offset,
int count,
String sortField,
boolean sortAscending)
Loads all message statuses matching the passed filters.
|
MailStatus |
load(String uniqueMessageId)
Load message status for the message matching the given message Id.
|
void |
save(MailStatus status,
Map<String,Object> parameters)
Saves mail status in the store.
|
void save(MailStatus status, Map<String,Object> parameters) throws MailStoreException
status
- the mail status to be savedparameters
- some parameters specifying addition context data (for example the current wiki is stored under
the wiki
key)MailStoreException
- when an error occurs saving the dataMailStatus load(String uniqueMessageId) throws MailStoreException
uniqueMessageId
- the unique identifier of the message.MailStoreException
- when an error occurs while loading the dataList<MailStatus> load(Map<String,Object> filterMap, int offset, int count, String sortField, boolean sortAscending) throws MailStoreException
filterMap
- the map of Mail Status parameters to match (e.g. "state", "wiki", "batchId", etc)offset
- the number of rows to skip (0 means don't skip any row)count
- the number of rows to return. If 0 then all rows are returnedsortField
- the name of the field used to order returned status or null if not sort should be performedsortAscending
- when true, sort is done in ascending order of sortField, else in descending orderMailStatus
instancesMailStoreException
- when an error occurs while loading the datalong count(Map<String,Object> filterMap) throws MailStoreException
filterMap
- the map of Mail Status parameters to match (e.g. "state", "wiki", "batchId", etc)MailStoreException
- when an error occurs when loading the datavoid delete(String uniqueMessageId, Map<String,Object> parameters) throws MailStoreException
uniqueMessageId
- the id of the message to deleteparameters
- some parameters specifying addition context data (for example the current wiki is stored under
the wiki
key)MailStoreException
- when an error occurs deleting the messageCopyright © 2004–2017 XWiki. All rights reserved.