Interface RecordsManagementEventService
- All Known Implementing Classes:
RecordsManagementEventServiceImpl
@AlfrescoPublicApi
public interface RecordsManagementEventService
Records management event service interface
- Author:
- Roy Wetherall
-
Method Summary
Modifier and TypeMethodDescriptionAdd an eventboolean
canCreateEvent
(String eventDisplayLabel, String eventName) Indicates whether a particular event can be created.boolean
canEditEvent
(String eventDisplayLabel, String eventName, String eventType) Indicates whether a particular event can be edited.boolean
existsEvent
(String eventName) Indicates whether a particular event exists.Get a records management event given its name.Get the list of available eventsgetEventType
(String eventTypeName) Get the records management event typeGet a list of the event typesvoid
registerEventType
(RecordsManagementEventType eventType) Register an event typevoid
removeEvent
(String eventName) Remove an event
-
Method Details
-
registerEventType
Register an event type- Parameters:
eventType
- event type
-
getEventTypes
List<RecordsManagementEventType> getEventTypes()Get a list of the event types- Returns:
- List
list of the event types
-
getEventType
Get the records management event type- Parameters:
eventTypeName
- name- Returns:
- RecordsManagementEventType event type
-
getEvents
List<RecordsManagementEvent> getEvents()Get the list of available events- Returns:
- List
list of events
-
getEvent
Get a records management event given its name. Returns null if the event name is not recognised.- Parameters:
eventName
- event name- Returns:
- RecordsManagementEvent event
-
existsEvent
Indicates whether a particular event exists. Returns true if it does, false otherwise.- Parameters:
eventName
- event name- Returns:
- boolean true if event exists, false otherwise
-
canCreateEvent
Indicates whether a particular event can be created. Returns true if it is possible, false otherwise.- Parameters:
eventDisplayLabel
- event display labeleventName
- event name- Returns:
- true if the event can be created, false otherwise
-
canEditEvent
Indicates whether a particular event can be edited. Returns true if it is possible, false otherwise.- Parameters:
eventDisplayLabel
- event display labeleventName
- event nameeventType
- event type- Returns:
- true if the event can be edited, false otherwise
-
addEvent
Add an event- Parameters:
eventType
- event typeeventName
- event nameeventDisplayLabel
- event display label
-
removeEvent
Remove an event- Parameters:
eventName
- event name
-