Interface DispositionActionDefinition

  • All Known Implementing Classes:
    DispositionActionDefinitionImpl

    public interface DispositionActionDefinition
    Disposition action interface
    Author:
    Roy Wetherall
    • Method Detail

      • getNodeRef

        org.alfresco.service.cmr.repository.NodeRef getNodeRef()
        Get the NodeRef that represents the disposition action definition
        Returns:
        NodeRef of disposition action definition
      • getId

        String getId()
        Get disposition action id
        Returns:
        String id
      • getIndex

        int getIndex()
        Get the index of the action within the disposition instructions
        Returns:
        int disposition action index
      • getName

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

        String getLabel()
        Get the display label of the disposition action
        Returns:
        String name's display label
      • getDescription

        String getDescription()
        Get the description of the disposition action
        Returns:
        String description
      • getPeriod

        org.alfresco.service.cmr.repository.Period getPeriod()
        Get the period for the disposition action
        Returns:
        Period disposition period
      • getPeriodProperty

        org.alfresco.service.namespace.QName getPeriodProperty()
        Property to which the period is relative to
        Returns:
        QName property name
      • eligibleOnFirstCompleteEvent

        boolean eligibleOnFirstCompleteEvent()
        Indicates whether the disposition action is eligible when the earliest event is complete, otherwise all events must be complete before eligibility.
        Returns:
        boolean true if eligible on first action complete, false otherwise
      • getLocation

        String getLocation()
        Get the location of the disposition (can be null)
        Returns:
        String disposition location
      • getGhostOnDestroy

        String getGhostOnDestroy()
        Get the ghost on destroy from the disposition
        Returns:
        boolean the gost on destroy flag (on applicable to destroy actions)