Package com.redwood.scheduler.api.model.interfaces

Interface ExportRuleSetComponent

  • public interface ExportRuleSetComponent
    This is the common base for ExportRule and ExportRuleItem.
    See Also:
    ExportedItem.getExportRuleSetComponent()

    • Method Detail

      • isExportContents

        boolean isExportContents()
        Indicates whether the items are exported recursively.
        Returns:
        true when the items are exported recursively.
        See Also:
        ExportRuleItem.isExportContents(), ExportRule.isExportContents()

      • setExportContents

        void setExportContents​(boolean newExportContent)
        Set whether the items should be exported recursively.
        Parameters:
        newExportContent - whether the items should be exported recursively.
        See Also:
        ExportRuleItem.setExportContents(boolean), ExportRule.setExportContents(boolean)

      • getItemsToExport

        RWIterable<com.redwood.scheduler.api.model.SchedulerEntity> getItemsToExport()
        Returns an Iterator over all the items that should be exported with this ExportRuleSetComponent.
        Returns:
        An Iterator over all the items that should be exported. It contains the child items if isExportContents() returns true.
        See Also:
        ExportRuleItem.getItemsToExport(), ExportRule.getItemsToExport()

      • getExportRuleSet

        com.redwood.scheduler.api.model.ExportRuleSet getExportRuleSet()
        Returns the corresponding ExportRuleSet
        Returns:
        the ExportRuleSet from where this ExportRuleSetComponent comes.
        See Also:
        ExportRuleItem.getExportRuleSet(), ExportRule.getExportRuleSet()

      • getDescriptionTranslationKey

        String getDescriptionTranslationKey()
        Returns a description that is useful for display purposes. This might need translating by being passed to SchedulerSession.translateField(String).
        Returns:
        either a description of this component or a translation key for the description of this component.