org.nuxeo.ecm.agenda

Class AgendaComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.agenda.AgendaComponent

All Implemented Interfaces:

AgendaService, Adaptable, Component, Extensible, TimestampedService

public class AgendaComponent
extends DefaultComponent
implements AgendaService

Since:

5.6

Author:

Arnaud Kervern

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEDULABLE_TYPE
static String	VEVENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AgendaComponent()

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

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VEVENT_TYPE

public static final String VEVENT_TYPE

See Also:

Constant Field Values

SCHEDULABLE_TYPE

public static final String SCHEDULABLE_TYPE

See Also:

Constant Field Values

Constructor Detail

AgendaComponent

public AgendaComponent()

Method Detail

listEvents

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

Description copied from interface: AgendaService

List user readable agendum between both date

Specified by:

listEvents in interface AgendaService

dtStart - the start date

dtEnd - the end date (included)

Returns:

matching Event as a DocumentModelList object

Throws:

ClientException

listEvents

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

Description copied from interface: AgendaService

List incoming user readable agendum with a limit

Specified by:

listEvents in interface AgendaService

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

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

Description copied from interface: AgendaService

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

Specified by:

createEvent in interface AgendaService

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