Interface Import

  • All Superinterfaces:
    Root, SchedulerEntity, SchedulerEntityComp, WrappedJob

    public interface Import
    extends WrappedJob
    An import of a set of objects. An import is performed using a system job. This object acts as a place-holder to gather up the imports scheduled and completed for this system. The source of the import is specified by: FilePath, Url or ImportSource. One (and only one) of these must be set.
    • Method Detail

      • getAuditReason

        String getAuditReason()
        Get the value for AuditReason. (The audit reason that is applied to this import.)
        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.
      • getFilePath

        String getFilePath()
        Get the value for FilePath. (Path of the file to import from.)
        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.
      • getImportId

        Long getImportId()
        Get the value for ImportId. (The Import ID for this Import. This is unique for every Import.) 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.
      • getImportRuleSet

        ImportRuleSet getImportRuleSet()
        Get the value for ImportRuleSet. (The ImportRuleSet that is applied to this import.)
        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.
      • getUrl

        String getUrl()
        Get the value for Url. (URL to import the objects from.)
        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.
      • isTestMode

        boolean isTestMode()
        Get the value for TestMode. (Print a report of what will be changed, and additional objects that are required.)
        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.
      • isInvalidateOnError

        boolean isInvalidateOnError()
        Get the value for InvalidateOnError. (Invalidate when compiling if an error occurs.)
        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.
      • isFetchMode

        boolean isFetchMode()
        Get the value for FetchMode. (Fetch additional objects that are required for the selection to be imported.)
        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.
      • getOptions

        String getOptions()
        Get the value for Options. (This field would contain command line parameters in the same format as accepted by the command line tool.)
        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.
      • getTargetPartition

        String getTargetPartition()
        Get the value for TargetPartition. (The target partition this import is imported in.)
        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.
      • setAuditReason

        void setAuditReason​(String newAuditReason)
        Set the value for AuditReason. (The audit reason that is applied to this import.) This value is optional.
        Parameters:
        newAuditReason - the new value for AuditReason.
        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.
      • setFilePath

        void setFilePath​(String newFilePath)
        Set the value for FilePath. (Path of the file to import from.) This value is optional.
        Parameters:
        newFilePath - the new value for FilePath.
        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.
      • setImportRuleSet

        void setImportRuleSet​(ImportRuleSet newImportRuleSet)
        Set the value for ImportRuleSet. (The ImportRuleSet that is applied to this import.) This value is optional.
        Parameters:
        newImportRuleSet - the new value for ImportRuleSet.
        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.
      • setUrl

        void setUrl​(String newUrl)
        Set the value for Url. (URL to import the objects from.) This value is optional.
        Parameters:
        newUrl - the new value for Url.
        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.
      • setTestMode

        void setTestMode​(boolean newTestMode)
        Set the value for TestMode. (Print a report of what will be changed, and additional objects that are required.)
        Parameters:
        newTestMode - the new value for TestMode.
        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.
      • setInvalidateOnError

        void setInvalidateOnError​(boolean newInvalidateOnError)
        Set the value for InvalidateOnError. (Invalidate when compiling if an error occurs.)
        Parameters:
        newInvalidateOnError - the new value for InvalidateOnError.
        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.
      • setFetchMode

        void setFetchMode​(boolean newFetchMode)
        Set the value for FetchMode. (Fetch additional objects that are required for the selection to be imported.)
        Parameters:
        newFetchMode - the new value for FetchMode.
        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.
      • setOptions

        void setOptions​(String newOptions)
        Set the value for Options. (This field would contain command line parameters in the same format as accepted by the command line tool.) This value is optional.
        Parameters:
        newOptions - the new value for Options.
        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.
      • setTargetPartition

        void setTargetPartition​(String newTargetPartition)
        Set the value for TargetPartition. (The target partition this import is imported in.) This value is optional.
        Parameters:
        newTargetPartition - the new value for TargetPartition.
        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.
      • getImportSource

        ImportSource getImportSource()
        Get the ImportSource.
        Returns:
        ImportSource
        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.
      • 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.
      • setImportSource

        void setImportSource​(ImportSource newImportSource)
        Set the value for ImportSource. This value is optional.
        Parameters:
        newImportSource - is the object to set ImportSource to. Source from which the import will retrieve the objects to import.
      • 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 used for the import.
      • 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.