Class RecordsManagementEventServiceImpl
java.lang.Object
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventServiceImpl
- All Implemented Interfaces:
RecordsManagementEventService
public class RecordsManagementEventServiceImpl
extends Object
implements RecordsManagementEventService
Records management event service implementation
- Author:
- Roy Wetherall
-
Constructor Summary
Constructors -
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.boolean
existsEventDisplayLabel
(String eventDisplayLabel) Indicates whether a particular event display label 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 eventvoid
setContentService
(ContentService contentService) Set the content servicevoid
setNodeService
(NodeService nodeService) Set the node service
-
Constructor Details
-
RecordsManagementEventServiceImpl
public RecordsManagementEventServiceImpl()
-
-
Method Details
-
setNodeService
Set the node service- Parameters:
nodeService
- node service
-
setContentService
Set the content service- Parameters:
contentService
- content service
-
registerEventType
Description copied from interface:RecordsManagementEventService
Register an event type- Specified by:
registerEventType
in interfaceRecordsManagementEventService
- Parameters:
eventType
- event type- See Also:
-
getEventTypes
Description copied from interface:RecordsManagementEventService
Get a list of the event types- Specified by:
getEventTypes
in interfaceRecordsManagementEventService
- Returns:
- List
list of the event types - See Also:
-
getEvents
Description copied from interface:RecordsManagementEventService
Get the list of available events- Specified by:
getEvents
in interfaceRecordsManagementEventService
- Returns:
- List
list of events - See Also:
-
getEvent
Description copied from interface:RecordsManagementEventService
Get a records management event given its name. Returns null if the event name is not recognised.- Specified by:
getEvent
in interfaceRecordsManagementEventService
- Parameters:
eventName
- event name- Returns:
- RecordsManagementEvent event
- See Also:
-
existsEvent
Description copied from interface:RecordsManagementEventService
Indicates whether a particular event exists. Returns true if it does, false otherwise.- Specified by:
existsEvent
in interfaceRecordsManagementEventService
- Parameters:
eventName
- event name- Returns:
- boolean true if event exists, false otherwise
- See Also:
-
existsEventDisplayLabel
Indicates whether a particular event display label exists. Returns true if it does, false otherwise.- Parameters:
eventDisplayLabel
- event display label- Returns:
- boolean true if event exists, false otherwise
-
canCreateEvent
Description copied from interface:RecordsManagementEventService
Indicates whether a particular event can be created. Returns true if it is possible, false otherwise.- Specified by:
canCreateEvent
in interfaceRecordsManagementEventService
- Parameters:
eventDisplayLabel
- event display labeleventName
- event name- Returns:
- true if the event can be created, false otherwise
- See Also:
-
canEditEvent
Description copied from interface:RecordsManagementEventService
Indicates whether a particular event can be edited. Returns true if it is possible, false otherwise.- Specified by:
canEditEvent
in interfaceRecordsManagementEventService
- Parameters:
eventDisplayLabel
- event display labeleventName
- event nameeventType
- event type- Returns:
- true if the event can be edited, false otherwise
- See Also:
-
addEvent
public RecordsManagementEvent addEvent(String eventType, String eventName, String eventDisplayLabel) Description copied from interface:RecordsManagementEventService
Add an event- Specified by:
addEvent
in interfaceRecordsManagementEventService
- Parameters:
eventType
- event typeeventName
- event nameeventDisplayLabel
- event display label- See Also:
-
removeEvent
Description copied from interface:RecordsManagementEventService
Remove an event- Specified by:
removeEvent
in interfaceRecordsManagementEventService
- Parameters:
eventName
- event name- See Also:
-
getEventType
Description copied from interface:RecordsManagementEventService
Get the records management event type- Specified by:
getEventType
in interfaceRecordsManagementEventService
- Parameters:
eventTypeName
- name- Returns:
- RecordsManagementEventType event type
- See Also:
-