Package com.redwood.scheduler.api.model

Interface RemoteSystem

    • Method Detail

      • getLocation

        String getLocation()
        Get the value for Location. (Location url where the remote system can be reached.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUsername

        String getUsername()
        Get the value for Username. (Name of the user to use to login.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getPassword

        String getPassword()
        Get the value for Password. (Password of the user to use to login.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getType

        RemoteSystemType getType()
        Get the value for Type. (What is the type of the remote system.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isAllowRuleSetOverride

        boolean isAllowRuleSetOverride()
        Get the value for AllowRuleSetOverride. (Is it allowed for the import to override the Import Rule Set.)
        Returns:
        the field
        Throws:
        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 is only valid when the Remote System type is Destination or Both, and would contain command line parameters in the same format as accepted by the command line tool.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLocation

        void setLocation​(String newLocation)
        Set the value for Location. (Location url where the remote system can be reached.) This value is optional.
        Parameters:
        newLocation - the new value for Location.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUsername

        void setUsername​(String newUsername)
        Set the value for Username. (Name of the user to use to login.) This value is optional.
        Parameters:
        newUsername - the new value for Username.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setPassword

        void setPassword​(String newPassword)
        Set the value for Password. (Password of the user to use to login.) This value is optional.
        Parameters:
        newPassword - the new value for Password.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setType

        void setType​(RemoteSystemType newType)
        Set the value for Type. (What is the type of the remote system.) This value is mandatory.
        Parameters:
        newType - the new value for Type. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setAllowRuleSetOverride

        void setAllowRuleSetOverride​(boolean newAllowRuleSetOverride)
        Set the value for AllowRuleSetOverride. (Is it allowed for the import to override the Import Rule Set.)
        Parameters:
        newAllowRuleSetOverride - the new value for AllowRuleSetOverride.
        Throws:
        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 is only valid when the Remote System type is Destination or Both, and 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:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getPushAcceptorJobDefinition

        JobDefinition getPushAcceptorJobDefinition()
        Get the PushAcceptorJobDefinition.
        Returns:
        PushAcceptorJobDefinition
        Throws:
        ObjectDeletedException - If this method is called when the object has been marked for deletion.
        ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

      • getPromoteFurtherJobDefinition

        JobDefinition getPromoteFurtherJobDefinition()
        Get the PromoteFurtherJobDefinition.
        Returns:
        PromoteFurtherJobDefinition
        Throws:
        ObjectDeletedException - If this method is called when the object has been marked for deletion.
        ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

      • setPushAcceptorJobDefinition

        void setPushAcceptorJobDefinition​(JobDefinition newPushAcceptorJobDefinition)
        Set the value for PushAcceptorJobDefinition. This value is optional.
        Parameters:
        newPushAcceptorJobDefinition - is the object to set PushAcceptorJobDefinition to. The job definition that is used to import an archive when using promotion.

      • setPusherJobDefinition

        void setPusherJobDefinition​(JobDefinition newPusherJobDefinition)
        Set the value for PusherJobDefinition. This value is optional.
        Parameters:
        newPusherJobDefinition - is the object to set PusherJobDefinition to. The jobdefinition that is used to export an archive when using promotion.

      • setPromoteFurtherJobDefinition

        void setPromoteFurtherJobDefinition​(JobDefinition newPromoteFurtherJobDefinition)
        Set the value for PromoteFurtherJobDefinition. This value is optional.
        Parameters:
        newPromoteFurtherJobDefinition - is the object to set PromoteFurtherJobDefinition to. The jobdefinition that is used to promote an archive when using promote further.

      • setImportRuleSet

        void setImportRuleSet​(ImportRuleSet newImportRuleSet)
        Set the value for ImportRuleSet. This value is optional.
        Parameters:
        newImportRuleSet - is the object to set ImportRuleSet to. The Import Rule Set that is going to be applied when a remote system is pushing a car file.

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

      • checkUsePrivilege

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