Package com.redwood.scheduler.api.model

Interface ImportRuleSet

    • Method Detail

      • getValidity

        Validity getValidity()
        Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) 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.

      • getVariablePrefix

        String getVariablePrefix()
        Get the value for VariablePrefix. (The prefix to apply to values in the Variables table when they are imported, and there is no existing value.)
        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.

      • setVariablePrefix

        void setVariablePrefix​(String newVariablePrefix)
        Set the value for VariablePrefix. (The prefix to apply to values in the Variables table when they are imported, and there is no existing value.) This value is optional.
        Parameters:
        newVariablePrefix - the new value for VariablePrefix.
        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.

      • apply

        void apply​(Iterator<? extends SchedulerEntity> entities)
    throws com.redwood.scheduler.api.exception.ImportOverrideException
        Apply this rule-set to a collection of objects.
        Parameters:
        entities - The objects the override will be applied to.
        Throws:
        com.redwood.scheduler.api.exception.ImportOverrideException - An import override rule could not be applied to an object.

      • apply

        void apply​(Iterator<? extends SchedulerEntity> entities,
           Logger jcsOutLog,
           Logger jcsErrLog)
    throws com.redwood.scheduler.api.exception.ImportOverrideException
        Apply this rule to a collection of objects.
        Parameters:
        entities - The objects the override will be applied to.
        jcsOutLog - Output logger, corresponds to scripting variable jcsOutLog. Will be stdout.log for an import job.
        jcsErrLog - Output logger, corresponds to scripting variable jcsErrLog. Will be stderr.log for an import job.
        Throws:
        com.redwood.scheduler.api.exception.ImportOverrideException - An import override rule could not be applied to an object.

      • apply

        void apply​(Iterator<? extends SchedulerEntity> entities,
           Logger jcsOutLog,
           Logger jcsErrLog,
           ImportActionScriptObject scriptObject)
    throws com.redwood.scheduler.api.exception.ImportOverrideException
        Apply this rule to a collection of objects.
        Parameters:
        entities - The objects the override will be applied to.
        jcsOutLog - Output logger, corresponds to scripting variable jcsOutLog. Will be stdout.log for an import job.
        jcsErrLog - Output logger, corresponds to scripting variable jcsErrLog. Will be stderr.log for an import job.
        scriptObject - Context object for scripting.
        Throws:
        com.redwood.scheduler.api.exception.ImportOverrideException - An import override rule could not be applied to an object.

      • getImportAction

        @Deprecated
ImportAction getImportAction()
        Deprecated.
        Use getImportActions instead

        Deprecated operation, do not use. getImportActions will now return multiple actions. This will only return the POST import action.

        Returns:
        Returns Post Import action ImportRuleSetActionType.PostImport.

      • getImports

        RWIterable<Import> getImports()
        Get an RWIterable over an ordered collection of Imports. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Import rule-set which should be applied during this import.
        Specified by:
        getImports in interface ImportRuleSetComp
        Returns:
        An RWIterable over an ordered collection of Import objects .

      • getImportActionByType

        ImportAction getImportActionByType​(ImportRuleSetActionType type)
        Get the ImportAction by ImportRuleSetActionType.
        Parameters:
        type -
        Returns:
        the ImportAction, or null if it could not be found

      • getImportRules

        RWIterable<ImportRule> getImportRules()
        Get an RWIterable over a collection of ImportRules, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Set of ImportRules that make up the ImportRuleSet.
        Specified by:
        getImportRules in interface ImportRuleSetComp
        Returns:
        An RWIterable over a collection of ImportRule objects , the collection will be ordered by UniqueId.

      • getImportRuleByName

        ImportRule getImportRuleByName​(String name)
        Get the ImportRule by NameImportRuleSet.
        Parameters:
        name -
        Returns:
        the ImportRule, or null if it could not be found

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create 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.

      • 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.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit 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.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete 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.