Package org.alfresco.module.org_alfresco_module_rm.disposition

Class DispositionActionDefinitionImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.disposition.DispositionActionDefinitionImpl

All Implemented Interfaces:

DispositionActionDefinition, RecordsManagementCustomModel, RecordsManagementModel

public class DispositionActionDefinitionImpl
extends Object
implements DispositionActionDefinition, RecordsManagementModel

Disposition action implementation

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_DELETION_REASON, 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
DispositionActionDefinitionImpl(RecordsManagementEventService recordsManagementEventService, RecordsManagementActionService recordsManagementActionService, NodeService nodeService, NodeRef nodeRef, int index)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	eligibleOnFirstCompleteEvent()	Indicates whether the disposition action is eligible when the earliest event is complete, otherwise all events must be complete before eligibility.
String	getDescription()	Get the description of the disposition action
List<RecordsManagementEvent>	getEvents()	List of events for the disposition
String	getGhostOnDestroy()	Get the ghost on destroy from the disposition
String	getId()	Get disposition action id
int	getIndex()	Get the index of the action within the disposition instructions
String	getLabel()	Get the display label of the disposition action
String	getLocation()	Get the location of the disposition (can be null)
String	getName()	Get the name of disposition action
NodeRef	getNodeRef()	Get the NodeRef that represents the disposition action definition
Period	getPeriod()	Get the period for the disposition action
QName	getPeriodProperty()	Property to which the period is relative to

Methods inherited from class java.lang.Object

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

Constructor Details

DispositionActionDefinitionImpl

public DispositionActionDefinitionImpl(RecordsManagementEventService recordsManagementEventService,
 RecordsManagementActionService recordsManagementActionService,
 NodeService nodeService,
 NodeRef nodeRef,
 int index)

Constructor

Parameters:

recordsManagementEventService - records management event service

recordsManagementActionService - records management action service

nodeService - node service

nodeRef - disposition action node reference

index - index of disposition action

Method Details

getNodeRef

public NodeRef getNodeRef()

Description copied from interface: DispositionActionDefinition

Get the NodeRef that represents the disposition action definition

Specified by:

getNodeRef in interface DispositionActionDefinition

Returns:

NodeRef of disposition action definition

See Also:

• DispositionActionDefinition.getNodeRef()

getIndex

public int getIndex()

Description copied from interface: DispositionActionDefinition

Get the index of the action within the disposition instructions

Specified by:

getIndex in interface DispositionActionDefinition

Returns:

int disposition action index

See Also:

• DispositionActionDefinition.getIndex()

getId

public String getId()

Description copied from interface: DispositionActionDefinition

Get disposition action id

Specified by:

getId in interface DispositionActionDefinition

Returns:

String id

See Also:

• DispositionActionDefinition.getId()

getDescription

public String getDescription()

Description copied from interface: DispositionActionDefinition

Get the description of the disposition action

Specified by:

getDescription in interface DispositionActionDefinition

Returns:

String description

See Also:

• DispositionActionDefinition.getDescription()

getName

public String getName()

Description copied from interface: DispositionActionDefinition

Get the name of disposition action

Specified by:

getName in interface DispositionActionDefinition

Returns:

String name

See Also:

• DispositionActionDefinition.getName()

getLabel

public String getLabel()

Description copied from interface: DispositionActionDefinition

Get the display label of the disposition action

Specified by:

getLabel in interface DispositionActionDefinition

Returns:

String name's display label

See Also:

• DispositionActionDefinition.getLabel()

getPeriod

public Period getPeriod()

Description copied from interface: DispositionActionDefinition

Get the period for the disposition action

Specified by:

getPeriod in interface DispositionActionDefinition

Returns:

Period disposition period

See Also:

• DispositionActionDefinition.getPeriod()

getPeriodProperty

public QName getPeriodProperty()

Description copied from interface: DispositionActionDefinition

Property to which the period is relative to

Specified by:

getPeriodProperty in interface DispositionActionDefinition

Returns:

QName property name

See Also:

• DispositionActionDefinition.getPeriodProperty()

getEvents

public List<RecordsManagementEvent> getEvents()

Description copied from interface: DispositionActionDefinition

List of events for the disposition

Specified by:

getEvents in interface DispositionActionDefinition

Returns:

List list of events

See Also:

• DispositionActionDefinition.getEvents()

eligibleOnFirstCompleteEvent

public boolean eligibleOnFirstCompleteEvent()

Description copied from interface: DispositionActionDefinition

Indicates whether the disposition action is eligible when the earliest event is complete, otherwise all events must be complete before eligibility.

Specified by:

eligibleOnFirstCompleteEvent in interface DispositionActionDefinition

Returns:

boolean true if eligible on first action complete, false otherwise

See Also:

• DispositionActionDefinition.eligibleOnFirstCompleteEvent()

getLocation

public String getLocation()

Description copied from interface: DispositionActionDefinition

Get the location of the disposition (can be null)

Specified by:

getLocation in interface DispositionActionDefinition

Returns:

String disposition location

See Also:

• DispositionActionDefinition.getLocation()

getGhostOnDestroy

public String getGhostOnDestroy()

Description copied from interface: DispositionActionDefinition

Get the ghost on destroy from the disposition

Specified by:

getGhostOnDestroy in interface DispositionActionDefinition

Returns:

boolean the gost on destroy flag (on applicable to destroy actions)

See Also:

• DispositionActionDefinition.getGhostOnDestroy()