org.nuxeo.cm.cases
Interface CaseItem

All Superinterfaces:

HasParticipants, Serializable

All Known Implementing Classes:

CaseItemImpl

public interface CaseItem
extends HasParticipants, Serializable

Mail envelope item.

Represents a document placed in an envelope.

Author:

Anahide Tchertchian, Alexandre Russel

Method Summary

Case	createMailCase(org.nuxeo.ecm.core.api.CoreSession documentManager, String parentPath, String initialLifeCycleState) Creates a mail envelope with this item inside.
Case	getCase() Gets the envelope this document is in.
org.nuxeo.ecm.core.api.DocumentModelList	getCases(org.nuxeo.ecm.core.api.CoreSession coreSession)
String	getConfidentiality() Gets the confidentiality of the document.
String	getDefaultCaseId() Gets the envelope in which this item should be shown if not associated with an envelope.
org.nuxeo.ecm.core.api.DocumentModel	getDocument() Returns the mail document.
Calendar	getDocumentDate() Gets the date on the item.
Calendar	getImportDate() Sets the item the item was imported into Nuxeo.
String	getOrigin() Gets the origin of the document (email, scan ...).
Calendar	getReceiveDate() Gets the date item was received.
Calendar	getSendingDate() Gets the date the item was sent.
String	getTitle() Gets the title of this item.
String	getType() Get the type of document.
boolean	hasSeveralCases(org.nuxeo.ecm.core.api.CoreSession coreSession)
void	save(org.nuxeo.ecm.core.api.CoreSession session) Persists the item.
void	setCase(Case theCase)
void	setConfidentiality(String cdf)
void	setDefaultCase(String mailEnvelopeId)
void	setDocumentDate(Calendar date)
void	setImportDate(Calendar date)
void	setOrigin(String origin)
void	setReceiveDate(Calendar date)
void	setSendingDate(Calendar date)
void	setTitle(String title)
void	setType(String type)

Methods inherited from interface org.nuxeo.cm.cases.HasParticipants

addInitialExternalParticipants, addInitialInternalParticipants, addParticipants, getAllParticipants, getInitialExternalParticipants, getInitialInternalParticipants

Method Detail

getTitle

String getTitle()

Gets the title of this item.

setTitle

void setTitle(String title)

getSendingDate

Calendar getSendingDate()

Gets the date the item was sent.

setSendingDate

void setSendingDate(Calendar date)

getReceiveDate

Calendar getReceiveDate()

Gets the date item was received.

setReceiveDate

void setReceiveDate(Calendar date)

getImportDate

Calendar getImportDate()

Sets the item the item was imported into Nuxeo.

setImportDate

void setImportDate(Calendar date)

getDocumentDate

Calendar getDocumentDate()

Gets the date on the item.

setDocumentDate

void setDocumentDate(Calendar date)

getConfidentiality

String getConfidentiality()

Gets the confidentiality of the document. The default is 4.

setConfidentiality

void setConfidentiality(String cdf)

getOrigin

String getOrigin()

Gets the origin of the document (email, scan ...).

setOrigin

void setOrigin(String origin)

getType

String getType()

Get the type of document.

setType

void setType(String type)

getCase

Case getCase()

Gets the envelope this document is in. This value only is only set when it is coming from an envelope in the current session.

Returns:

the envelope or null if the document is not associated with an envelope.

setCase

void setCase(Case theCase)

getDefaultCaseId

String getDefaultCaseId()

Gets the envelope in which this item should be shown if not associated with an envelope.

If you find this item from a search, we still have to show it in an envelope. This method tell us in which envelope to put it.

setDefaultCase

void setDefaultCase(String mailEnvelopeId)

getDocument

org.nuxeo.ecm.core.api.DocumentModel getDocument()

Returns the mail document.

createMailCase

Case createMailCase(org.nuxeo.ecm.core.api.CoreSession documentManager,
                    String parentPath,
                    String initialLifeCycleState)

Creates a mail envelope with this item inside.

Parameters:

documentManager - an open session.

parentPath - the path to the folder in which the envelope will be created.

Returns:

The created mail envelope.

save

void save(org.nuxeo.ecm.core.api.CoreSession session)

Persists the item.

getCases

org.nuxeo.ecm.core.api.DocumentModelList getCases(org.nuxeo.ecm.core.api.CoreSession coreSession)

Parameters:

coreSession -

Returns:

list of cases containing the case item.

hasSeveralCases

boolean hasSeveralCases(org.nuxeo.ecm.core.api.CoreSession coreSession)

Returns:

true if case item is in more than one case.