Interface DispositionAction

All Known Implementing Classes:
DispositionActionImpl

public interface DispositionAction
Disposition action interface.
Since:
1.0
Author:
Roy Wetherall
  • Method Details

    • getNodeRef

      NodeRef getNodeRef()
      Returns:
      the node reference
    • getDispositionActionDefinition

      DispositionActionDefinition getDispositionActionDefinition()
      Returns:
      the disposition action definition
    • getId

      String getId()
      Returns:
      the id of the action
    • getName

      String getName()
      Returns:
      the name of the action
    • getLabel

      String getLabel()
      Returns:
      the display label for the action
    • getAsOfDate

      Date getAsOfDate()
      Returns:
      the dispostion action as of eligibility date
    • isEventsEligible

      boolean isEventsEligible()
      Returns:
      true if the events are complete (ie: enough events have been completed to make the disposition action
    • getStartedBy

      String getStartedBy()
      Returns:
      the user that started the action
    • getStartedAt

      Date getStartedAt()
      Returns:
      when the action was started
    • getCompletedBy

      String getCompletedBy()
      Returns:
      the user that completed the action
    • getCompletedAt

      Date getCompletedAt()
      Returns:
      when the action was completed
    • getEventCompletionDetails

      List<EventCompletionDetails> getEventCompletionDetails()
      Returns:
      List of events that need to be completed for the action
    • getEventCompletionDetails

      EventCompletionDetails getEventCompletionDetails(String eventName)
      Get the event completion details for a named event.
      Parameters:
      eventName - event name
      Returns:
      EventCompletionDetails event completion details
      Since:
      2.2
    • addEventCompletionDetails

      void addEventCompletionDetails(RecordsManagementEvent event)
      Add new completion details to the disposition action based on the provided event.
      Parameters:
      event - records management event
      Since:
      2.2
    • completeEvent

      void completeEvent(String eventName, Date completedAt, String completedBy)
      Complete an event.

      If null is provided, the complete at date will be take as 'now' and the completed by user as the fully authenticated user.

      Parameters:
      eventName - event name
      completedAt - completed at 'date', now if null
      completedBy - completed by user, authenticated user if null
      Since:
      2.2
    • undoEvent

      void undoEvent(String eventName)
      Undo the completion of an event.
      Parameters:
      eventName - event name
      Since:
      2.2
    • refreshEvents

      void refreshEvents()
      Refresh events against current disposition action definition.

      Called when disposition action definition has changed.

      Since:
      2.2