org.nuxeo.cm.service
Interface CaseDistributionService

All Superinterfaces:

Serializable

All Known Subinterfaces:

LocalCaseDistributionService, RemoteCaseDistributionService

All Known Implementing Classes:

CaseDistributionBean, CaseDistributionServiceImpl

public interface CaseDistributionService
extends Serializable

Correspondence service.

Distributes an email to users/groups/mailboxes and manages mailboxes.

Method Summary

CaseItem	addCaseItemToCase(org.nuxeo.ecm.core.api.CoreSession session, Case kase, org.nuxeo.ecm.core.api.DocumentModel emailDoc) Add a CaseItem to a Case
Case	createCase(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel emailDoc)
Case	createCase(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel emailDoc, List<Mailbox> mailboxes)
Case	createCaseFromExistingCaseItem(CaseItem adapter, org.nuxeo.ecm.core.api.CoreSession documentManager) This method calls CaseManagementPersister to create a Case from the given CaseItem
CaseLink	createDraftCaseLink(org.nuxeo.ecm.core.api.CoreSession session, Mailbox mailbox, Case envelope) Create a draft post for an envelope in given mailbox.
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel caseDoc, List<Mailbox> mailboxes)
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel caseDoc, Mailbox mailbox)
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, String title, String id, List<Mailbox> mailboxes)
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, String title, String id, Mailbox mailbox)
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, String title, String id, String type, Date date, List<Mailbox> mailboxes)
Case	createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session, String title, String id, String type, List<Mailbox> mailboxes)
List<CaseLink>	getCaseLinks(org.nuxeo.ecm.core.api.CoreSession session, Mailbox mailbox, Case kase) Returns all the case links for this kase in this mailbox.
CaseLink	getDraftCaseLink(org.nuxeo.ecm.core.api.CoreSession session, Mailbox mailbox, String envelopeId) Returns the draft post of an envelope in given mailbox.
List<CaseLink>	getDraftCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession, Mailbox mailbox, long offset, long limit) Returns the draft posts for given mailbox
org.nuxeo.ecm.core.api.DocumentModel	getParentDocumentForCase(org.nuxeo.ecm.core.api.CoreSession session) This method calls CaseManagementPersister to find the parent document of a case to be created.
org.nuxeo.ecm.core.api.DocumentModel	getParentDocumentForCase(org.nuxeo.ecm.core.api.CoreSession session, Date date) This method calls CaseManagementPersister to find the parent document of a case to be created.
String	getParentDocumentPathForCase(org.nuxeo.ecm.core.api.CoreSession session) This method calls CaseManagementPersister to find the parent document path of a case to be created.
String	getParentDocumentPathForCase(org.nuxeo.ecm.core.api.CoreSession session, Date date) This method calls CaseManagementPersister to find the parent document path of a case to be created.
String	getParentDocumentPathForCaseItem(org.nuxeo.ecm.core.api.CoreSession session, Case kase) This method calls CaseManagementPersister to find the parent document path of a CaseItem to be created.
List<CaseLink>	getReceivedCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession, Mailbox mailbox, long offset, long limit) Returns the received posts for given mailbox
List<CaseLink>	getSentCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession, Mailbox mailbox, long offset, long limit) Returns the sent posts for given mailbox
void	notify(org.nuxeo.ecm.core.api.CoreSession session, String name, org.nuxeo.ecm.core.api.DocumentModel document, Map<String,Serializable> eventProperties) Throw a core event.
void	removeCaseLink(CaseLink link, org.nuxeo.ecm.core.api.CoreSession sessiion) Remove a case link from the mailbox.
CaseLink	sendCase(org.nuxeo.ecm.core.api.CoreSession session, CaseLink postRequest, boolean initial) Send an envelope to a mailbox.
CaseLink	sendCase(org.nuxeo.ecm.core.api.CoreSession session, CaseLink postRequest, boolean initial, boolean actionable) Send an case to a mailbox.
CaseLink	sendCase(org.nuxeo.ecm.core.api.CoreSession session, String sender, Case kase, DistributionInfo initialDistribution) Distributes a case to a mailbox.

Method Detail

sendCase

CaseLink sendCase(org.nuxeo.ecm.core.api.CoreSession session,
                  CaseLink postRequest,
                  boolean initial)

Send an envelope to a mailbox.

sendCase

CaseLink sendCase(org.nuxeo.ecm.core.api.CoreSession session,
                  String sender,
                  Case kase,
                  DistributionInfo initialDistribution)

Distributes a case to a mailbox. the case is not currently in any mailbox, (it was created by import for example)

removeCaseLink

void removeCaseLink(CaseLink link,
                    org.nuxeo.ecm.core.api.CoreSession sessiion)

Remove a case link from the mailbox. It is the duty of a listener to update the security on the case if necessary.

Parameters:

link -

getSentCaseLinks

List<CaseLink> getSentCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession,
                                Mailbox mailbox,
                                long offset,
                                long limit)

Returns the sent posts for given mailbox

getReceivedCaseLinks

List<CaseLink> getReceivedCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession,
                                    Mailbox mailbox,
                                    long offset,
                                    long limit)

Returns the received posts for given mailbox

getCaseLinks

List<CaseLink> getCaseLinks(org.nuxeo.ecm.core.api.CoreSession session,
                            Mailbox mailbox,
                            Case kase)

Returns all the case links for this kase in this mailbox.

Parameters:

session -

mailbox - if null returns the links of all mailboxes.

kase -

Returns:

getDraftCaseLinks

List<CaseLink> getDraftCaseLinks(org.nuxeo.ecm.core.api.CoreSession coreSession,
                                 Mailbox mailbox,
                                 long offset,
                                 long limit)

Returns the draft posts for given mailbox

getDraftCaseLink

CaseLink getDraftCaseLink(org.nuxeo.ecm.core.api.CoreSession session,
                          Mailbox mailbox,
                          String envelopeId)

Returns the draft post of an envelope in given mailbox. Returns null if post is not found.

addCaseItemToCase

CaseItem addCaseItemToCase(org.nuxeo.ecm.core.api.CoreSession session,
                           Case kase,
                           org.nuxeo.ecm.core.api.DocumentModel emailDoc)

Add a CaseItem to a Case

Parameters:

session - The core session

kase - The case in which the CaseItem will be added

parentPath - The path in which the CaseItem will be created

emailDoc - The document model for the CaseItem

Returns:

createCase

Case createCase(org.nuxeo.ecm.core.api.CoreSession session,
                org.nuxeo.ecm.core.api.DocumentModel emailDoc)

Parameters:

session -

changeableDocument -

parentPath - the path where the document and its envelope are created

Returns:

a MailEnvelope containing default MailItem.

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     org.nuxeo.ecm.core.api.DocumentModel caseDoc,
                     Mailbox mailbox)

Parameters:

session -

changeableDocument -

the - mailbox in which this case is created

parentPath - the path where the document and its envelope are created

Returns:

an emptyCase

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     org.nuxeo.ecm.core.api.DocumentModel caseDoc,
                     List<Mailbox> mailboxes)

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     String title,
                     String id,
                     List<Mailbox> mailboxes)

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     String title,
                     String id,
                     Mailbox mailbox)

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     String title,
                     String id,
                     String type,
                     List<Mailbox> mailboxes)

createEmptyCase

Case createEmptyCase(org.nuxeo.ecm.core.api.CoreSession session,
                     String title,
                     String id,
                     String type,
                     Date date,
                     List<Mailbox> mailboxes)

createCase

Case createCase(org.nuxeo.ecm.core.api.CoreSession session,
                org.nuxeo.ecm.core.api.DocumentModel emailDoc,
                List<Mailbox> mailboxes)

Parameters:

mailboxes - The list of mailboxes in which the document will be seen.

session -

changeableDocument -

parentPath - the path where the document and its envelope are created

Returns:

a MailEnvelope containing default MailItem.

createDraftCaseLink

CaseLink createDraftCaseLink(org.nuxeo.ecm.core.api.CoreSession session,
                             Mailbox mailbox,
                             Case envelope)

Create a draft post for an envelope in given mailbox.

notify

void notify(org.nuxeo.ecm.core.api.CoreSession session,
            String name,
            org.nuxeo.ecm.core.api.DocumentModel document,
            Map<String,Serializable> eventProperties)

Throw a core event.

Parameters:

session - The session use in the event context and to get the principal.

name - the name of the event

document - The document use for DocumentEventContext

eventProperties - The properties used in the event context.

sendCase

CaseLink sendCase(org.nuxeo.ecm.core.api.CoreSession session,
                  CaseLink postRequest,
                  boolean initial,
                  boolean actionable)

Send an case to a mailbox.

getParentDocumentForCase

org.nuxeo.ecm.core.api.DocumentModel getParentDocumentForCase(org.nuxeo.ecm.core.api.CoreSession session)

This method calls CaseManagementPersister to find the parent document of a case to be created.

Parameters:

session -

Returns:

the case Parent Document

getParentDocumentForCase

org.nuxeo.ecm.core.api.DocumentModel getParentDocumentForCase(org.nuxeo.ecm.core.api.CoreSession session,
                                                              Date date)

This method calls CaseManagementPersister to find the parent document of a case to be created.

Parameters:

session -

date -

Returns:

the case Parent Document

getParentDocumentPathForCase

String getParentDocumentPathForCase(org.nuxeo.ecm.core.api.CoreSession session)

This method calls CaseManagementPersister to find the parent document path of a case to be created.

Parameters:

session -

Returns:

getParentDocumentPathForCase

String getParentDocumentPathForCase(org.nuxeo.ecm.core.api.CoreSession session,
                                    Date date)

This method calls CaseManagementPersister to find the parent document path of a case to be created.

Parameters:

session -

date -

Returns:

createCaseFromExistingCaseItem

Case createCaseFromExistingCaseItem(CaseItem adapter,
                                    org.nuxeo.ecm.core.api.CoreSession documentManager)

This method calls CaseManagementPersister to create a Case from the given CaseItem

Parameters:

{@link - CaseItem}

documentManager -

Returns:

getParentDocumentPathForCaseItem

String getParentDocumentPathForCaseItem(org.nuxeo.ecm.core.api.CoreSession session,
                                        Case kase)

This method calls CaseManagementPersister to find the parent document path of a CaseItem to be created.

Parameters:

coreSession -

the - parent Case

Returns: