org.nuxeo.ecm.agenda

Interface AgendaService

All Known Implementing Classes:

AgendaComponent

public interface AgendaService

Since:

5.6

Author:

Arnaud Kervern

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	createEvent(CoreSession session, String path, Map<String,Serializable> properties) Create a new Event document to the specific path.
DocumentModelList	listEvents(CoreSession session, String path, Date dtStart, Date dtEnd) List user readable agendum between both date
DocumentModelList	listEvents(CoreSession session, String path, int limit) List incoming user readable agendum with a limit

Method Detail

listEvents

DocumentModelList listEvents(CoreSession session,
                           String path,
                           Date dtStart,
                           Date dtEnd)
                             throws ClientException

List user readable agendum between both date

Parameters:

path -

dtStart - the start date

dtEnd - the end date (included)

Returns:

matching Event as a DocumentModelList object

Throws:

ClientException

listEvents

DocumentModelList listEvents(CoreSession session,
                           String path,
                           int limit)
                             throws ClientException

List incoming user readable agendum with a limit

Parameters:

path -

limit - the number of events returned must be greater than 0 otherwise ClientException is thrown

Returns:

matching Event as a DocumentModelList object

Throws:

ClientException

createEvent

DocumentModel createEvent(CoreSession session,
                        String path,
                        Map<String,Serializable> properties)
                          throws ClientException

Create a new Event document to the specific path. If the path is blank or "/", the new event will be created into the UserWorkspace

Parameters:

sesion - CoreSession used to create the new doc

path - base path, if it is blank or "/"; the new event will be created into the UserWorkspace

properties - corresponding metadata

Returns:

a new Event created

Throws:

ClientException