Package org.ametys.plugins.repository.activities

Interface ActivityHolder

All Known Subinterfaces:

ActivityHolderAmetysObject

All Known Implementing Classes:

DefaultActivityHolder, Project, Site

public interface ActivityHolder

Interface for activity holder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVITIES_ROOT_NODE_NAME	the activity root node name
static final String	ACTIVITY_NAME_PREFIX	Prefix used for naming the activity node
static final DateTimeFormatter	JCR_UTC_FORMAT	formatter to store date time in jcr node name

Method Summary

Modifier and Type	Method	Description
Activity	addActivity(ZonedDateTime date, ActivityType type, Map<String,Object> parameters, UserIdentity author, String eventId)	Add an activity to the activity holder
Activity	addActivity(ActivityType type, Map<String,Object> parameters, String eventId)	Add an activity to the activity holder
default Activity	addActivity(ActivityType type, Map<String,Object> parameters, UserIdentity author, String eventId)	Add an activity to the activity holder This convenient method will call addActivity(ZonedDateTime, ActivityType, Map, UserIdentity, String) with the current time.
AmetysObjectIterable<Activity>	getActivities()	Returns the activities stored by this activity holder

Field Details

ACTIVITIES_ROOT_NODE_NAME

static final String ACTIVITIES_ROOT_NODE_NAME

the activity root node name

See Also:

• Constant Field Values

ACTIVITY_NAME_PREFIX

static final String ACTIVITY_NAME_PREFIX

Prefix used for naming the activity node

See Also:

• Constant Field Values

JCR_UTC_FORMAT

static final DateTimeFormatter JCR_UTC_FORMAT

formatter to store date time in jcr node name

Method Details

getActivities

AmetysObjectIterable<Activity> getActivities()
                                      throws javax.jcr.RepositoryException

Returns the activities stored by this activity holder

Returns:

The activities

Throws:

javax.jcr.RepositoryException - if failed to get activity nodes

addActivity

Activity addActivity(ActivityType type,
 Map<String,Object> parameters,
 String eventId)
              throws javax.jcr.RepositoryException

Add an activity to the activity holder

Parameters:

type - the type

parameters - the parameters

eventId - the id of the event

Returns:

the activity

Throws:

javax.jcr.RepositoryException - when an error occurred

addActivity

default Activity addActivity(ActivityType type,
 Map<String,Object> parameters,
 UserIdentity author,
 String eventId)
                      throws javax.jcr.RepositoryException

Add an activity to the activity holder This convenient method will call addActivity(ZonedDateTime, ActivityType, Map, UserIdentity, String) with the current time.

Parameters:

type - the type

parameters - the parameters

author - the author

eventId - the id of the event

Returns:

the activity

Throws:

javax.jcr.RepositoryException - when an error occurred

addActivity

Activity addActivity(ZonedDateTime date,
 ActivityType type,
 Map<String,Object> parameters,
 UserIdentity author,
 String eventId)
              throws javax.jcr.RepositoryException

Add an activity to the activity holder

Parameters:

date - the date

type - the type

parameters - the parameters

author - the author

eventId - the id of the event

Returns:

the activity

Throws:

javax.jcr.RepositoryException - when an error occurred