org.nuxeo.cm.cases
Interface Case

All Superinterfaces:

HasParticipants, Serializable

All Known Implementing Classes:

CaseImpl

public interface Case
extends HasParticipants, Serializable

Mail envelope

Author:

Anahide Tchertchian

Method Summary

boolean	addCaseItem(CaseItem item, org.nuxeo.ecm.core.api.CoreSession session) Adds given item to the envelope.
boolean	canFollowTransition(String transition)
void	followTransition(String transition) Follow the given transition.
List<CaseItem>	getCaseItems(org.nuxeo.ecm.core.api.CoreSession session) Returns unmodifiable list of items.
org.nuxeo.ecm.core.api.DocumentModel	getDocument() Gets the document model describing the envelope.
List<org.nuxeo.ecm.core.api.DocumentModel>	getDocuments() Gets the items as document with the session of the envelope.
List<org.nuxeo.ecm.core.api.DocumentModel>	getDocuments(org.nuxeo.ecm.core.api.CoreSession session) Gets the items as document
CaseItem	getFirstItem(org.nuxeo.ecm.core.api.CoreSession session) Gets the first document within this envelope
boolean	isDraft() Is this a draft envelope?
boolean	isEmpty() Is this an empty envelope?
boolean	moveDownEmailsInCase(List<CaseItem> selected, org.nuxeo.ecm.core.api.CoreSession session) Moves down given selected items in the envelope.
boolean	moveUpEmailsInCase(List<CaseItem> selected, org.nuxeo.ecm.core.api.CoreSession session) Moves up given selected items in the envelope.
boolean	removeCaseItem(CaseItem item, org.nuxeo.ecm.core.api.CoreSession session) Removes given item from the envelope.
void	save(org.nuxeo.ecm.core.api.CoreSession session) Persists the envelope.

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

addInitialExternalParticipants, addInitialInternalParticipants, addParticipants, getAllParticipants, getInitialExternalParticipants, getInitialInternalParticipants

Method Detail

getDocument

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

Gets the document model describing the envelope.

getDocuments

List<org.nuxeo.ecm.core.api.DocumentModel> getDocuments()

Gets the items as document with the session of the envelope.

getDocuments

List<org.nuxeo.ecm.core.api.DocumentModel> getDocuments(org.nuxeo.ecm.core.api.CoreSession session)

Gets the items as document

getCaseItems

List<CaseItem> getCaseItems(org.nuxeo.ecm.core.api.CoreSession session)

Returns unmodifiable list of items.

getFirstItem

CaseItem getFirstItem(org.nuxeo.ecm.core.api.CoreSession session)

Gets the first document within this envelope

addCaseItem

boolean addCaseItem(CaseItem item,
                    org.nuxeo.ecm.core.api.CoreSession session)

Adds given item to the envelope.

Returns:

true if added, false if item was already present.

removeCaseItem

boolean removeCaseItem(CaseItem item,
                       org.nuxeo.ecm.core.api.CoreSession session)

Removes given item from the envelope.

Returns:

true if added, false if item was not present.

moveUpEmailsInCase

boolean moveUpEmailsInCase(List<CaseItem> selected,
                           org.nuxeo.ecm.core.api.CoreSession session)

Moves up given selected items in the envelope.

Returns:

true if moved up, false if some could not be moved.

moveDownEmailsInCase

boolean moveDownEmailsInCase(List<CaseItem> selected,
                             org.nuxeo.ecm.core.api.CoreSession session)

Moves down given selected items in the envelope.

Returns:

true if moved down, false if some could not be moved.

save

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

Persists the envelope.

isDraft

boolean isDraft()
                throws org.nuxeo.ecm.core.api.ClientException

Is this a draft envelope?

Throws:

org.nuxeo.ecm.core.api.ClientException

isEmpty

boolean isEmpty()
                throws org.nuxeo.ecm.core.api.ClientException

Is this an empty envelope?

Throws:

org.nuxeo.ecm.core.api.ClientException

canFollowTransition

boolean canFollowTransition(String transition)

Parameters:

life - cycle transition

Returns:

true if the case can follow given transition.

followTransition

void followTransition(String transition)

Follow the given transition.

Parameters:

life - cycle transition