Class DispositionActionImpl
- java.lang.Object
-
- org.alfresco.module.org_alfresco_module_rm.disposition.DispositionActionImpl
-
- All Implemented Interfaces:
DispositionAction
,RecordsManagementCustomModel
,RecordsManagementModel
public class DispositionActionImpl extends Object implements DispositionAction, RecordsManagementModel
Disposition action implementation.- Since:
- 1.0
- Author:
- Roy Wetherall
-
-
Field Summary
-
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel
ASPECT_CUSTOM_ASSOCIATIONS, ASPECT_SUPPLEMENTAL_MARKING_LIST, CONSTRAINT_CUSTOM_SMLIST, CUSTOM_REF_CROSSREFERENCE, CUSTOM_REF_OBSOLETES, CUSTOM_REF_RENDITION, CUSTOM_REF_SUPERSEDES, CUSTOM_REF_SUPPORTS, CUSTOM_REF_VERSIONS, PROP_SUPPLEMENTAL_MARKING_LIST, RM_CUSTOM_MODEL, RM_CUSTOM_PREFIX, RM_CUSTOM_URI
-
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel
ASPECT_ARCHIVED, ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COMMON_RECORD_DETAILS, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, ASPECT_DISPOSITION_PROCESSED, ASPECT_EMAIL_CONFIG_ROOT, ASPECT_EXTENDED_SECURITY, ASPECT_FILABLE, ASPECT_FILE_PLAN_COMPONENT, ASPECT_FROZEN, ASPECT_GHOSTED, ASPECT_HELD_CHILDREN, ASPECT_LOADED_DATA_SET_ID, ASPECT_RECORD, ASPECT_RECORD_COMPONENT_ID, ASPECT_RECORD_META_DATA, ASPECT_RECORD_ORIGINATING_DETAILS, ASPECT_RECORD_REJECTION_DETAILS, ASPECT_RECORDS_MANAGEMENT_ROOT, ASPECT_RM_SEARCH, ASPECT_SAVED_SEARCH, ASPECT_SCHEDULED, ASPECT_TRANSFERRED, ASPECT_TRANSFERRING, ASPECT_UNCUT_OFF, ASPECT_UNPUBLISHED_UPDATE, ASPECT_VERSIONED_RECORD, ASPECT_VITAL_RECORD, ASPECT_VITAL_RECORD_DEFINITION, ASSOC_CAVEAT_CONFIG, ASSOC_DISPOSITION_ACTION_DEFINITIONS, ASSOC_DISPOSITION_ACTION_HISTORY, ASSOC_DISPOSITION_SCHEDULE, ASSOC_EMAIL_CONFIG, ASSOC_EVENT_EXECUTIONS, ASSOC_FROZEN_CONTENT, ASSOC_FROZEN_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, GL_URI, PROP_COMBINE_DISPOSITION_STEP_CONDITIONS, PROP_COUNT, PROP_CUT_OFF_DATE, PROP_DATE_FILED, PROP_DB_UNIQUENESS_ID, PROP_DECLARED_AT, PROP_DECLARED_BY, PROP_DISPOSITION_ACTION, PROP_DISPOSITION_ACTION_COMPLETED_AT, PROP_DISPOSITION_ACTION_COMPLETED_BY, PROP_DISPOSITION_ACTION_GHOST_ON_DESTROY, PROP_DISPOSITION_ACTION_ID, PROP_DISPOSITION_ACTION_NAME, PROP_DISPOSITION_ACTION_STARTED_AT, PROP_DISPOSITION_ACTION_STARTED_BY, PROP_DISPOSITION_AS_OF, PROP_DISPOSITION_AUTHORITY, PROP_DISPOSITION_DESCRIPTION, PROP_DISPOSITION_EVENT, PROP_DISPOSITION_EVENT_COMBINATION, PROP_DISPOSITION_EVENTS_ELIGIBLE, PROP_DISPOSITION_INSTRUCTIONS, PROP_DISPOSITION_LOCATION, PROP_DISPOSITION_PERIOD, PROP_DISPOSITION_PERIOD_PROPERTY, PROP_EVENT_EXECUTION_AUTOMATIC, PROP_EVENT_EXECUTION_COMPLETE, PROP_EVENT_EXECUTION_COMPLETED_AT, PROP_EVENT_EXECUTION_COMPLETED_BY, PROP_EVENT_EXECUTION_NAME, PROP_FROZEN_AT, PROP_FROZEN_BY, PROP_HELD_CHILDREN_COUNT, PROP_HOLD_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_MANUALLY_SET_AS_OF, PROP_ORIGIONAL_NAME, PROP_PUBLISH_IN_PROGRESS, PROP_READERS, PROP_RECORD_LEVEL_DISPOSITION, PROP_RECORD_ORIGINATING_CREATION_DATE, PROP_RECORD_ORIGINATING_LOCATION, PROP_RECORD_ORIGINATING_USER_ID, PROP_RECORD_REJECTION_DATE, PROP_RECORD_REJECTION_REASON, PROP_RECORD_REJECTION_USER_ID, PROP_REVIEW_AS_OF, PROP_REVIEW_PERIOD, PROP_ROOT_NODEREF, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_AT, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_BY, PROP_RS_DISPOITION_AUTHORITY, PROP_RS_DISPOITION_INSTRUCTIONS, PROP_RS_DISPOSITION_ACTION_AS_OF, PROP_RS_DISPOSITION_ACTION_NAME, PROP_RS_DISPOSITION_EVENTS, PROP_RS_DISPOSITION_EVENTS_ELIGIBLE, PROP_RS_DISPOSITION_PERIOD, PROP_RS_DISPOSITION_PERIOD_EXPRESSION, PROP_RS_HAS_DISPOITION_SCHEDULE, PROP_RS_HOLD_REASON, PROP_RS_VITAL_RECORD_REVIEW_PERIOD, PROP_RS_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION, PROP_TRANSFER_ACCESSION_INDICATOR, PROP_TRANSFER_LOCATION, PROP_TRANSFER_PDF_INDICATOR, PROP_UNPUBLISHED_UPDATE, PROP_UPDATE_TO, PROP_UPDATED_PROPERTIES, PROP_VITAL_RECORD_INDICATOR, PROP_WRITERS, RM_MODEL, RM_PREFIX, RM_URI, TYPE_CAVEAT_CONFIG, TYPE_DISPOSITION_ACTION, TYPE_DISPOSITION_ACTION_DEFINITION, TYPE_DISPOSITION_SCHEDULE, TYPE_EMAIL_CONFIG, TYPE_EVENT_EXECUTION, TYPE_FILE_PLAN, TYPE_HOLD, TYPE_HOLD_CONTAINER, TYPE_NON_ELECTRONIC_DOCUMENT, TYPE_RECORD_CATEGORY, TYPE_RECORD_FOLDER, TYPE_RECORDS_MANAGEMENT_CONTAINER, TYPE_RM_SITE, TYPE_TRANSFER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER, TYPE_UNFILED_RECORD_FOLDER, UPDATE_TO_DISPOSITION_ACTION_DEFINITION
-
-
Constructor Summary
Constructors Constructor Description DispositionActionImpl(RecordsManagementServiceRegistry services, org.alfresco.service.cmr.repository.NodeRef dispositionActionNodeRef)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEventCompletionDetails(RecordsManagementEvent event)
Add new completion details to the disposition action based on the provided event.void
completeEvent(String eventName, Date completedAt, String completedBy)
Complete an event.Date
getAsOfDate()
Date
getCompletedAt()
String
getCompletedBy()
DispositionActionDefinition
getDispositionActionDefinition()
List<EventCompletionDetails>
getEventCompletionDetails()
EventCompletionDetails
getEventCompletionDetails(String eventName)
Gets the event completion details for the named event.String
getId()
String
getLabel()
String
getName()
org.alfresco.service.cmr.repository.NodeRef
getNodeRef()
Date
getStartedAt()
String
getStartedBy()
boolean
isEventsEligible()
void
refreshEvents()
Refresh events against current disposition action definition.void
undoEvent(String eventName)
Undo the completion of an event.
-
-
-
Constructor Detail
-
DispositionActionImpl
public DispositionActionImpl(RecordsManagementServiceRegistry services, org.alfresco.service.cmr.repository.NodeRef dispositionActionNodeRef)
Constructor- Parameters:
services
- records management service registrydispositionActionNodeRef
- disposition action node reference
-
-
Method Detail
-
getDispositionActionDefinition
public DispositionActionDefinition getDispositionActionDefinition()
- Specified by:
getDispositionActionDefinition
in interfaceDispositionAction
- Returns:
- the disposition action definition
- See Also:
DispositionAction.getDispositionActionDefinition()
-
getNodeRef
public org.alfresco.service.cmr.repository.NodeRef getNodeRef()
- Specified by:
getNodeRef
in interfaceDispositionAction
- Returns:
- the node reference
- See Also:
DispositionAction.getNodeRef()
-
getLabel
public String getLabel()
- Specified by:
getLabel
in interfaceDispositionAction
- Returns:
- the display label for the action
- See Also:
DispositionAction.getLabel()
-
getId
public String getId()
- Specified by:
getId
in interfaceDispositionAction
- Returns:
- the id of the action
- See Also:
DispositionAction.getId()
-
getName
public String getName()
- Specified by:
getName
in interfaceDispositionAction
- Returns:
- the name of the action
- See Also:
DispositionAction.getName()
-
getAsOfDate
public Date getAsOfDate()
- Specified by:
getAsOfDate
in interfaceDispositionAction
- Returns:
- the dispostion action as of eligibility date
- See Also:
DispositionAction.getAsOfDate()
-
isEventsEligible
public boolean isEventsEligible()
- Specified by:
isEventsEligible
in interfaceDispositionAction
- Returns:
- true if the events are complete (ie: enough events have been completed to make the disposition action
- See Also:
DispositionAction.isEventsEligible()
-
getCompletedAt
public Date getCompletedAt()
- Specified by:
getCompletedAt
in interfaceDispositionAction
- Returns:
- when the action was completed
- See Also:
DispositionAction.getCompletedAt()
-
getCompletedBy
public String getCompletedBy()
- Specified by:
getCompletedBy
in interfaceDispositionAction
- Returns:
- the user that completed the action
- See Also:
DispositionAction.getCompletedBy()
-
getStartedAt
public Date getStartedAt()
- Specified by:
getStartedAt
in interfaceDispositionAction
- Returns:
- when the action was started
- See Also:
DispositionAction.getStartedAt()
-
getStartedBy
public String getStartedBy()
- Specified by:
getStartedBy
in interfaceDispositionAction
- Returns:
- the user that started the action
- See Also:
DispositionAction.getStartedBy()
-
getEventCompletionDetails
public List<EventCompletionDetails> getEventCompletionDetails()
- Specified by:
getEventCompletionDetails
in interfaceDispositionAction
- Returns:
- List of events that need to be completed for the action
- See Also:
DispositionAction.getEventCompletionDetails()
-
getEventCompletionDetails
public EventCompletionDetails getEventCompletionDetails(String eventName)
Gets the event completion details for the named event.Returns null if event can not be found.
- Specified by:
getEventCompletionDetails
in interfaceDispositionAction
- Parameters:
eventName
- name of the event- Returns:
EventCompletionDetails
event completion details for named event, null otherwise- Since:
- 2.2
-
completeEvent
public void completeEvent(String eventName, Date completedAt, String completedBy)
Description copied from interface:DispositionAction
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.
- Specified by:
completeEvent
in interfaceDispositionAction
- Parameters:
eventName
- event namecompletedAt
- completed at 'date', now if nullcompletedBy
- completed by user, authenticated user if null- See Also:
DispositionAction.completeEvent(java.lang.String, java.util.Date, java.lang.String)
-
undoEvent
public void undoEvent(String eventName)
Description copied from interface:DispositionAction
Undo the completion of an event.- Specified by:
undoEvent
in interfaceDispositionAction
- Parameters:
eventName
- event name- See Also:
DispositionAction.undoEvent(java.lang.String)
-
refreshEvents
public void refreshEvents()
Description copied from interface:DispositionAction
Refresh events against current disposition action definition.Called when disposition action definition has changed.
- Specified by:
refreshEvents
in interfaceDispositionAction
- See Also:
DispositionAction.refreshEvents()
-
addEventCompletionDetails
public void addEventCompletionDetails(RecordsManagementEvent event)
Description copied from interface:DispositionAction
Add new completion details to the disposition action based on the provided event.- Specified by:
addEventCompletionDetails
in interfaceDispositionAction
- Parameters:
event
- records management event- See Also:
DispositionAction.addEventCompletionDetails(org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent)
-
-