Interface RecordsManagementEventService

All Known Implementing Classes:
RecordsManagementEventServiceImpl

@AlfrescoPublicApi public interface RecordsManagementEventService
Records management event service interface
Author:
Roy Wetherall
  • Method Details

    • registerEventType

      void registerEventType(RecordsManagementEventType eventType)
      Register an event type
      Parameters:
      eventType - event type
    • getEventTypes

      Get a list of the event types
      Returns:
      List list of the event types
    • getEventType

      RecordsManagementEventType getEventType(String eventTypeName)
      Get the records management event type
      Parameters:
      eventTypeName - name
      Returns:
      RecordsManagementEventType event type
    • getEvents

      Get the list of available events
      Returns:
      List list of events
    • getEvent

      RecordsManagementEvent getEvent(String eventName)
      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

      boolean existsEvent(String eventName)
      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

      boolean canCreateEvent(String eventDisplayLabel, String eventName)
      Indicates whether a particular event can be created. Returns true if it is possible, false otherwise.
      Parameters:
      eventDisplayLabel - event display label
      eventName - event name
      Returns:
      true if the event can be created, false otherwise
    • canEditEvent

      boolean canEditEvent(String eventDisplayLabel, String eventName, String eventType)
      Indicates whether a particular event can be edited. Returns true if it is possible, false otherwise.
      Parameters:
      eventDisplayLabel - event display label
      eventName - event name
      eventType - event type
      Returns:
      true if the event can be edited, false otherwise
    • addEvent

      RecordsManagementEvent addEvent(String eventType, String eventName, String eventDisplayLabel)
      Add an event
      Parameters:
      eventType - event type
      eventName - event name
      eventDisplayLabel - event display label
    • removeEvent

      void removeEvent(String eventName)
      Remove an event
      Parameters:
      eventName - event name