Class RMActionExecuterAbstractBase

    • Field Detail

      • applicableKinds

        protected Set<FilePlanComponentKind> applicableKinds
        List of kinds for which this action is applicable
    • Constructor Detail

      • RMActionExecuterAbstractBase

        public RMActionExecuterAbstractBase()
    • Method Detail

      • getTransactionService

        protected org.alfresco.service.transaction.TransactionService getTransactionService()
        Get the transaction service
        Returns:
        The transaction service
      • setTransactionService

        public void setTransactionService​(org.alfresco.service.transaction.TransactionService transactionService)
        Set the transaction service
        Parameters:
        transactionService - The transaction service
      • getNamespaceService

        protected org.alfresco.service.namespace.NamespaceService getNamespaceService()
        Gets the namespace service
        Returns:
        The namespace service
      • setNamespaceService

        public void setNamespaceService​(org.alfresco.service.namespace.NamespaceService namespaceService)
        Set the namespace service
        Parameters:
        namespaceService - The namespace service
      • getNodeService

        protected org.alfresco.service.cmr.repository.NodeService getNodeService()
        Gets the node service
        Returns:
        The node service
      • setNodeService

        public void setNodeService​(org.alfresco.service.cmr.repository.NodeService nodeService)
        Set the node service
        Parameters:
        nodeService - The node service
      • getDictionaryService

        protected org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService()
        Gets the dictionary service
        Returns:
        The dictionary service
      • setDictionaryService

        public void setDictionaryService​(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
        Set the dictionary service
        Overrides:
        setDictionaryService in class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
        Parameters:
        dictionaryService - The dictionary service
      • getContentService

        protected org.alfresco.service.cmr.repository.ContentService getContentService()
        Gets the content service
        Returns:
        The content service
      • setContentService

        public void setContentService​(org.alfresco.service.cmr.repository.ContentService contentService)
        Set the content service
        Parameters:
        contentService - The content service
      • getActionService

        protected org.alfresco.service.cmr.action.ActionService getActionService()
        Gets the action service
        Returns:
        The action service
      • setActionService

        public void setActionService​(org.alfresco.service.cmr.action.ActionService actionService)
        Set action service
        Parameters:
        actionService - The action service
      • getRecordsManagementAuditService

        protected RecordsManagementAuditService getRecordsManagementAuditService()
        Gets the records management audit service
        Returns:
        The records management audit service
      • setRecordsManagementAuditService

        public void setRecordsManagementAuditService​(RecordsManagementAuditService recordsManagementAuditService)
        Set the audit service that action details will be sent to
        Parameters:
        recordsManagementAuditService - The audit service that action details will be sent to
      • getRecordsManagementActionService

        protected RecordsManagementActionService getRecordsManagementActionService()
        Gets the records management action service
        Returns:
        The records management action service
      • setRecordsManagementActionService

        public void setRecordsManagementActionService​(RecordsManagementActionService recordsManagementActionService)
        Set records management service
        Parameters:
        recordsManagementActionService - The records management service
      • getDispositionService

        protected DispositionService getDispositionService()
        Gets the disposition service
        Returns:
        The disposition service
      • setDispositionService

        public void setDispositionService​(DispositionService dispositionService)
        Set the disposition service
        Parameters:
        dispositionService - The disposition service
      • getVitalRecordService

        protected VitalRecordService getVitalRecordService()
        Gets the vital record service
        Returns:
        The vital record service
      • setVitalRecordService

        public void setVitalRecordService​(VitalRecordService vitalRecordService)
        Sets the vital record service
        Parameters:
        vitalRecordService - vital record service
      • getRecordsManagementEventService

        protected RecordsManagementEventService getRecordsManagementEventService()
        Gets the records management event service
        Returns:
        The records management event service
      • setRecordsManagementEventService

        public void setRecordsManagementEventService​(RecordsManagementEventService recordsManagementEventService)
        Set the records management event service
        Parameters:
        recordsManagementEventService - The records management event service
      • getOwnableService

        protected org.alfresco.service.cmr.security.OwnableService getOwnableService()
        Gets the ownable service
        Returns:
        The ownable service
      • setOwnableService

        public void setOwnableService​(org.alfresco.service.cmr.security.OwnableService ownableService)
        Set the ownable service
        Parameters:
        ownableService - The ownable service
      • getFreezeService

        protected FreezeService getFreezeService()
        Gets the freeze service
        Returns:
        The freeze service
      • setFreezeService

        public void setFreezeService​(FreezeService freezeService)
        Set freeze service
        Parameters:
        freezeService - freeze service
      • getRecordService

        protected RecordService getRecordService()
        Gets the record service
        Returns:
        The record service
      • setRecordService

        public void setRecordService​(RecordService recordService)
        Set record service
        Parameters:
        recordService - record service
      • getRecordsManagementAdminService

        protected RecordsManagementAdminService getRecordsManagementAdminService()
        Gets the records management admin service
        Returns:
        The records management admin service
      • setRecordsManagementAdminService

        public void setRecordsManagementAdminService​(RecordsManagementAdminService recordsManagementAdminService)
        Sets the records management admin service
        Parameters:
        recordsManagementAdminService - records management admin service
      • getModelSecurityService

        protected ModelSecurityService getModelSecurityService()
        Gets the model security service
        Returns:
        The model security service
      • setModelSecurityService

        public void setModelSecurityService​(ModelSecurityService modelSecurityService)
        Sets the model security service
        Parameters:
        modelSecurityService - model security service
      • getRecordFolderService

        protected RecordFolderService getRecordFolderService()
        Gets the record folder service
        Returns:
        The record folder service
      • setRecordFolderService

        public void setRecordFolderService​(RecordFolderService recordFolderService)
        Sets the record folder service
        Parameters:
        recordFolderService - record folder service
      • getHoldService

        protected HoldService getHoldService()
        Gets the hold service
        Returns:
        The hold service
      • setHoldService

        public void setHoldService​(HoldService holdService)
        Sets the hold service
        Parameters:
        holdService - hold service
      • getIdentifierService

        public IdentifierService getIdentifierService()
        Gets the identifier service
        Returns:
        the identifier service
      • setIdentifierService

        public void setIdentifierService​(IdentifierService identifierService)
        Sets the identifier service
        Parameters:
        identifierService - the identifier service
      • setApplicableKinds

        public void setApplicableKinds​(String[] applicableKinds)
        Sets the applicable kinds
        Parameters:
        applicableKinds - kinds that this action is applicable for
      • createActionDefinition

        protected org.alfresco.service.cmr.action.ActionDefinition createActionDefinition​(String name)
        Overrides:
        createActionDefinition in class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
        See Also:
        ActionExecuterAbstractBase.createActionDefinition(java.lang.String)
      • getActionDefinition

        public org.alfresco.service.cmr.action.ActionDefinition getActionDefinition()
        Specified by:
        getActionDefinition in interface org.alfresco.repo.action.executer.ActionExecuter
        Overrides:
        getActionDefinition in class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
        See Also:
        ActionExecuterAbstractBase.getActionDefinition()
      • isPublicAction

        public boolean isPublicAction()
        Indicates whether this records management action is public or not
        Specified by:
        isPublicAction in interface RecordsManagementAction
        Returns:
        boolean true if public, false otherwise
      • setBeanName

        public void setBeanName​(String name)
        Specified by:
        setBeanName in interface org.springframework.beans.factory.BeanNameAware
        Overrides:
        setBeanName in class org.alfresco.repo.action.CommonResourceAbstractBase
        See Also:
        CommonResourceAbstractBase.setBeanName(java.lang.String)
      • padString

        @Deprecated
        protected String padString​(String s,
                                   int len)
        Deprecated.
        As of 2.1, replaced by StringUtils.leftPad(String, int)
        Function to pad a string with zero '0' characters to the required length
        Parameters:
        s - String to pad with leading zero '0' characters
        len - Length to pad to
        Returns:
        padded string or the original if already at >= len characters
      • addParameterDefinitions

        protected void addParameterDefinitions​(List<org.alfresco.service.cmr.action.ParameterDefinition> paramList)
        By default there are no parameters.
        Specified by:
        addParameterDefinitions in class org.alfresco.repo.action.ParameterizedItemAbstractBase
        See Also:
        ParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)
      • getImplicitTargetNodeRef

        public org.alfresco.service.cmr.repository.NodeRef getImplicitTargetNodeRef()
        By default, rmActions do not provide an implicit target nodeRef.
        Specified by:
        getImplicitTargetNodeRef in interface RecordsManagementAction
        Returns:
        the target nodeRef