org.alfresco.module.org_alfresco_module_rm.event

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

Constructor and Description
RecordsManagementEventServiceImpl()

Method Summary

Modifier and Type	Method and Description
RecordsManagementEvent	addEvent(String eventType, String eventName, String eventDisplayLabel) Add an event
boolean	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)
RecordsManagementEvent	getEvent(String eventName) Get a records management event given its name.
List<RecordsManagementEvent>	getEvents() Get the list of available events
RecordsManagementEventType	getEventType(String eventTypeName) Get the records management event type
List<RecordsManagementEventType>	getEventTypes() Get a list of the event types
void	registerEventType(RecordsManagementEventType eventType) Register an event type
void	removeEvent(String eventName) Remove an event
void	setContentService(org.alfresco.service.cmr.repository.ContentService contentService) Set the content service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordsManagementEventServiceImpl

public RecordsManagementEventServiceImpl()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

Parameters:

nodeService - node service

setContentService

public void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)

Set the content service

Parameters:

contentService - content service

registerEventType

public void registerEventType(RecordsManagementEventType eventType)

Description copied from interface: RecordsManagementEventService

Register an event type

Specified by:

registerEventType in interface RecordsManagementEventService

Parameters:

eventType - event type

See Also:

RecordsManagementEventService.registerEventType(org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventType)

getEventTypes

public List<RecordsManagementEventType> getEventTypes()

Description copied from interface: RecordsManagementEventService

Get a list of the event types

Specified by:

getEventTypes in interface RecordsManagementEventService

Returns:

List list of the event types

See Also:

RecordsManagementEventService.getEventTypes()

getEvents

public List<RecordsManagementEvent> getEvents()

Description copied from interface: RecordsManagementEventService

Get the list of available events

Specified by:

getEvents in interface RecordsManagementEventService

Returns:

List list of events

See Also:

RecordsManagementEventService.getEvents()

getEvent

public RecordsManagementEvent getEvent(String eventName)

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 interface RecordsManagementEventService

Parameters:

eventName - event name

Returns:

RecordsManagementEvent event

See Also:

RecordsManagementEventService.getEvent(java.lang.String)

existsEvent

public boolean existsEvent(String eventName)

Description copied from interface: RecordsManagementEventService

Indicates whether a particular event exists. Returns true if it does, false otherwise.

Specified by:

existsEvent in interface RecordsManagementEventService

Parameters:

eventName - event name

Returns:

boolean true if event exists, false otherwise

See Also:

RecordsManagementEventService.existsEvent(java.lang.String)

existsEventDisplayLabel

public boolean existsEventDisplayLabel(String eventDisplayLabel)

See Also:

org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#existsEventDisplayLabel(java.lang.String)

canCreateEvent

public boolean canCreateEvent(String eventDisplayLabel,
                              String eventName)

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 interface RecordsManagementEventService

Parameters:

eventDisplayLabel - event display label

eventName - event name

Returns:

true if the event can be created, false otherwise

See Also:

RecordsManagementEventService.canCreateEvent(java.lang.String, java.lang.String)

canEditEvent

public boolean canEditEvent(String eventDisplayLabel,
                            String eventName,
                            String eventType)

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 interface RecordsManagementEventService

Parameters:

eventDisplayLabel - event display label

eventName - event name

eventType - event type

Returns:

true if the event can be edited, false otherwise

See Also:

RecordsManagementEventService.canEditEvent(java.lang.String, java.lang.String, java.lang.String)

addEvent

public RecordsManagementEvent addEvent(String eventType,
                                       String eventName,
                                       String eventDisplayLabel)

Description copied from interface: RecordsManagementEventService

Add an event

Specified by:

addEvent in interface RecordsManagementEventService

Parameters:

eventType - event type

eventName - event name

eventDisplayLabel - event display label

See Also:

RecordsManagementEventService.addEvent(java.lang.String, java.lang.String, java.lang.String)

removeEvent

public void removeEvent(String eventName)

Description copied from interface: RecordsManagementEventService

Remove an event

Specified by:

removeEvent in interface RecordsManagementEventService

Parameters:

eventName - event name

See Also:

RecordsManagementEventService.removeEvent(java.lang.String)

getEventType

public RecordsManagementEventType getEventType(String eventTypeName)

Description copied from interface: RecordsManagementEventService

Get the records management event type

Specified by:

getEventType in interface RecordsManagementEventService

Returns:

RecordsManagementEventType event type

See Also:

RecordsManagementEventService.getEventType(java.lang.String)