Package com.redwood.scheduler.api.model

Interface SAPBAEConnector

    • Method Detail

      • getConnectString

        String getConnectString()
        Get the value for ConnectString. (Connection string for reaching the ABAP stack of this SAP system) 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.

      • getStatus

        ProcessServerStatus getStatus()
        Get the value for Status. (The status of the BAE Connector.) 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.

      • isStartOnStartup

        boolean isStartOnStartup()
        Get the value for StartOnStartup. (Start this BAE connector at system startup.)
        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.

      • setConnectString

        void setConnectString​(String newConnectString)
        Set the value for ConnectString. (Connection string for reaching the ABAP stack of this SAP system) This value is mandatory.
        Parameters:
        newConnectString - the new value for ConnectString. 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.

      • setStartOnStartup

        void setStartOnStartup​(boolean newStartOnStartup)
        Set the value for StartOnStartup. (Start this BAE connector at system startup.)
        Parameters:
        newStartOnStartup - the new value for StartOnStartup.
        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.

      • checkConnectString

        String[] checkConnectString()
        Check the connection string for validity.
        Returns:
        Return an array with check results. An error is indicated by non-null array element. All elements of the array need to be checked.

      • start

        void start()
        Start the BAE connector.

      • stop

        void stop()
        Stop the BAE connector normally.

      • getMonitorRootPath

        String getMonitorRootPath()
        Get the root path label to use for the SAP BAE Connector in the monitor tree. Depends on the configuration/Monitoring/MonitorRootPath registry key: (a) KeyValue = PartitionColonNonGlobal (default) -> if partition is GLOBAL return SAPBAEConnectorName else return Partition:SAPBAEConnectorName. (b) KeyValue = PartitionColonAlways -> Always return Partition:SAPBAEConnectorName. (c) KeyValue = PartitionPathAlways -> Always return Partition/SAPBAEConnectorName.
        Returns:
        The String to use as the root path in the monitor tree

      • isSNCConnection

        boolean isSNCConnection()
        Check if the connection is using SNC.
        Returns:
        true if the connection is using SNC, false otherwise

      • getSAPSystemTimeZone

        TimeZone getSAPSystemTimeZone()
        Get the SAPSystemTimeZone.
        Returns:
        SAPSystemTimeZone
        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.

      • setSAPSystemTimeZone

        void setSAPSystemTimeZone​(TimeZone newSAPSystemTimeZone)
        Set the value for SAPSystemTimeZone. This value is mandatory.
        Parameters:
        newSAPSystemTimeZone - is the object to set SAPSystemTimeZone to. Which TimeZone will be ascribed to the Jobs DateTimeZone fields by default. If this is null, then the object cannot be persisted.

      • getSAPNWCallbackVariantByName

        SAPNWCallbackVariant getSAPNWCallbackVariantByName​(String name)
        Get the SAPNWCallbackVariant by NameSAPSystem.
        Parameters:
        name -
        Returns:
        the SAPNWCallbackVariant, or null if it could not be found

      • getSAPNWCallbackVariantBySearchName

        SAPNWCallbackVariant getSAPNWCallbackVariantBySearchName​(String searchName)
        Get the SAPNWCallbackVariant by SearchNameSAPSystem.
        Parameters:
        searchName -
        Returns:
        the SAPNWCallbackVariant, or null if it could not be found

      • getSAPBAEConfiguration

        SAPBAEConfiguration getSAPBAEConfiguration()
        Get the SAPBAEConfiguration. SAP BAE configuration for a SAP BAE connector.
        Returns:
        nullSAPBAEConfiguration
        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.

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

      • checkControlPrivilege

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

      • checkBusinessAutomationAPIPrivilege

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