Package org.ametys.plugins.repository.activities

Interface ActivityHolderAmetysObject

All Superinterfaces:

ActivityHolder

All Known Implementing Classes:

Project

public interface ActivityHolderAmetysObject
extends ActivityHolder

AmetysObject that can store activities

Field Summary

Fields inherited from interface org.ametys.plugins.repository.activities.ActivityHolder

ACTIVITIES_ROOT_NODE_NAME, ACTIVITY_NAME_PREFIX, JCR_UTC_FORMAT

Method Summary

Modifier and Type	Method	Description
default Activity	addActivity(ZonedDateTime date, ActivityType type, Map<String,Object> parameters, UserIdentity author, String eventId)	Add an activity to the activity holder
default Activity	addActivity(ActivityType type, Map<String,Object> parameters, String eventId)	Add an activity to the activity holder
default AmetysObjectIterable<Activity>	getActivities()	Returns the activities stored by this activity holder
ActivityHolder	getActivityHolder()	Returns the activity holder holding the activities

Method Details

getActivityHolder

ActivityHolder getActivityHolder()
                          throws javax.jcr.RepositoryException

Returns the activity holder holding the activities

Returns:

the activity holder

Throws:

javax.jcr.RepositoryException - if failed to get activity holder node

getActivities

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

Description copied from interface: ActivityHolder

Returns the activities stored by this activity holder

Specified by:

getActivities in interface ActivityHolder

Returns:

The activities

Throws:

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

addActivity

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

Description copied from interface: ActivityHolder

Add an activity to the activity holder

Specified by:

addActivity in interface ActivityHolder

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(ZonedDateTime date,
 ActivityType type,
 Map<String,Object> parameters,
 UserIdentity author,
 String eventId)
                      throws javax.jcr.RepositoryException

Description copied from interface: ActivityHolder

Add an activity to the activity holder

Specified by:

addActivity in interface ActivityHolder

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