Interface Export

  • All Superinterfaces:
    Root, SchedulerEntity, SchedulerEntityComp, WrappedJob

    public interface Export
    extends WrappedJob
    An export of a set of objects. An export is performed using a system job. This object acts as a place-holder to gather up the exports scheduled and completed for this system.
    • Method Detail

      • getExportId

        Long getExportId()
        Get the value for ExportId. (The Export ID for this Export. This is unique for every Export.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getExportRuleSet

        ExportRuleSet getExportRuleSet()
        Get the value for ExportRuleSet. (The ExportRuleSet that is used for the export.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setExportRuleSet

        void setExportRuleSet​(ExportRuleSet newExportRuleSet)
        Set the value for ExportRuleSet. (The ExportRuleSet that is used for the export.) This value is mandatory.
        Parameters:
        newExportRuleSet - the new value for ExportRuleSet. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getArchiveJobFile

        JobFile getArchiveJobFile()
        Get the ArchiveJobFile.
        Returns:
        ArchiveJobFile
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • setArchiveJobFile

        void setArchiveJobFile​(JobFile newArchiveJobFile)
        Set the value for ArchiveJobFile. This value is optional.
        Parameters:
        newArchiveJobFile - is the object to set ArchiveJobFile to. The jobfile containing the archive that results from the export.
      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
      • checkManagePrivilege

        RequiredPermission checkManagePrivilege()
        Check whether or not the manage action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.