Package com.redwood.scheduler.api.model

Interface SAPSystem

    • 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:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getJ2EEConnectString

        String getJ2EEConnectString()
        Get the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this SAP system)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isCurrentlyIsolated

        boolean isCurrentlyIsolated()
        Get the value for CurrentlyIsolated. (Whether this SAP system is actually isolated or not at the moment.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDefaultClientNumber

        String getDefaultClientNumber()
        Get the value for DefaultClientNumber. (Default XBP client number to use for this system.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isIsolated

        boolean isIsolated()
        Get the value for Isolated. (Whether this SAP system is considered isolated or not.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isLoadBalancingEnabled

        boolean isLoadBalancingEnabled()
        Get the value for LoadBalancingEnabled. (Whether application server load balancing is enabled for this SAP system.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getJobHandlingEnabled

        JobHandlingType getJobHandlingEnabled()
        Get the value for JobHandlingEnabled. (Should the XBP job interception and synchronization for this SAP System be enabled?) 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.

      • 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:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setJ2EEConnectString

        void setJ2EEConnectString​(String newJ2EEConnectString)
        Set the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this SAP system) This value is optional.
        Parameters:
        newJ2EEConnectString - the new value for J2EEConnectString.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setIsolated

        void setIsolated​(boolean newIsolated)
        Set the value for Isolated. (Whether this SAP system is considered isolated or not.)
        Parameters:
        newIsolated - the new value for Isolated.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLoadBalancingEnabled

        void setLoadBalancingEnabled​(boolean newLoadBalancingEnabled)
        Set the value for LoadBalancingEnabled. (Whether application server load balancing is enabled for this SAP system.)
        Parameters:
        newLoadBalancingEnabled - the new value for LoadBalancingEnabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setJobHandlingEnabled

        void setJobHandlingEnabled​(JobHandlingType newJobHandlingEnabled)
        Set the value for JobHandlingEnabled. (Should the XBP job interception and synchronization for this SAP System be enabled?) This value is mandatory.
        Parameters:
        newJobHandlingEnabled - the new value for JobHandlingEnabled. 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.

      • checkConnectString

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

      • init

        void init()
        Perform initialization tasks for the SAP System.

      • isSNCConnection

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

      • getDefaultXBPClient

        SAPXBP getDefaultXBPClient()
        Get the default XBP client.
        Returns:
        Default XBP client if there is one.

      • getDefaultOutputRetrievalProcessServer

        ProcessServer getDefaultOutputRetrievalProcessServer()
        Get the default output retrieval Process Server.
        Returns:
        Default output retrieval Process Server.

      • getDefaultJobTimeZone

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

      • getSpoolListRetrievalProcessServer

        ProcessServer getSpoolListRetrievalProcessServer()
        Get the SpoolListRetrievalProcessServer.
        Returns:
        SpoolListRetrievalProcessServer
        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.

      • getFailOverSpoolListRetrievalProcessServer

        ProcessServer getFailOverSpoolListRetrievalProcessServer()
        Get the FailOverSpoolListRetrievalProcessServer.
        Returns:
        FailOverSpoolListRetrievalProcessServer
        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.

      • setProcessServer

        void setProcessServer​(ProcessServer newProcessServer)
        Set the value for ProcessServer. This value is mandatory.
        Parameters:
        newProcessServer - is the object to set ProcessServer to. Link the SAP system to its corresponding process server. If this is null, then the object cannot be persisted.

      • setQueue

        void setQueue​(Queue newQueue)
        Set the value for Queue. This value is mandatory.
        Parameters:
        newQueue - is the object to set Queue to. Link the SAP system to its corresponding default queue. If this is null, then the object cannot be persisted.

      • setDefaultJobTimeZone

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

      • setSpoolListRetrievalProcessServer

        void setSpoolListRetrievalProcessServer​(ProcessServer newSpoolListRetrievalProcessServer)
        Set the value for SpoolListRetrievalProcessServer. This value is optional.
        Parameters:
        newSpoolListRetrievalProcessServer - is the object to set SpoolListRetrievalProcessServer to. Assign a different Process Server to perform SAP job output retrieval

      • setFailOverSpoolListRetrievalProcessServer

        void setFailOverSpoolListRetrievalProcessServer​(ProcessServer newFailOverSpoolListRetrievalProcessServer)
        Set the value for FailOverSpoolListRetrievalProcessServer. This value is optional.
        Parameters:
        newFailOverSpoolListRetrievalProcessServer - is the object to set FailOverSpoolListRetrievalProcessServer to. Assign a failover Process Server to perform SAP job output retrieval

      • setCcmsJobDefinition

        void setCcmsJobDefinition​(JobDefinition newCcmsJobDefinition)
        Set the value for CcmsJobDefinition. This value is optional.
        Parameters:
        newCcmsJobDefinition - is the object to set CcmsJobDefinition to. Assign a different Ccms Job definition to SAP System

      • getSAPAbapProgramByName

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

      • getSAPApplicationServerByName

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

      • getSAPApplicationServerGroupByName

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

      • getSAPArchiveObjectByName

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

      • getSAPBatchEventByName

        SAPBatchEvent getSAPBatchEventByName​(String name)
        Get the SAPBatchEvent by NameSAPBatchEvent.
        Parameters:
        name -
        Returns:
        the SAPBatchEvent, or null if it could not be found

      • getSAPCalendarByTypeIdentYear

        SAPCalendar getSAPCalendarByTypeIdentYear​(String type,
                                          String ident,
                                          Long year)
        Get the SAPCalendar by TypeIdentYearSAPSystem.
        Parameters:
        type -
        ident -
        year -
        Returns:
        the SAPCalendar, or null if it could not be found

      • getSAPExternalCommandByNameOsType

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

      • getSAPInfoPackageByName

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

      • getSAPInfoPackageGroupByName

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

      • getSAPPIChannelByChannelId

        SAPPIChannel getSAPPIChannelByChannelId​(String channelId)
        Get the SAPPIChannel by ChannelIdSAPSystem.
        Parameters:
        channelId -
        Returns:
        the SAPPIChannel, or null if it could not be found

      • getSAPMassActivityByName

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

      • getSAPOutputDeviceByName

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

      • getSAPProcessChainByName

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

      • getSAPRecipientByNameTypeClientNumber

        SAPRecipient getSAPRecipientByNameTypeClientNumber​(String name,
                                                   SAPRecipientType type,
                                                   String clientNumber)
        Get the SAPRecipient by NameSAPSystem.
        Parameters:
        name -
        type -
        clientNumber -
        Returns:
        the SAPRecipient, or null if it could not be found

      • getSAPRecipientBySearchNameTypeClientNumber

        SAPRecipient getSAPRecipientBySearchNameTypeClientNumber​(String searchName,
                                                         SAPRecipientType type,
                                                         String clientNumber)
        Get the SAPRecipient by SearchNameSAPSystem.
        Parameters:
        searchName -
        type -
        clientNumber -
        Returns:
        the SAPRecipient, or null if it could not be found

      • getSAPXAL

        SAPXAL getSAPXAL()
        Get the SAPXAL. XAL settings for a SAP system.
        Returns:
        nullSAPXAL
        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.

      • createSAPXAL

        SAPXAL createSAPXAL()
        Create a new SAPXAL linked to this object.
        Returns:
        a new SAPXAL.

      • getSAPXBPs

        RWIterable<SAPXBP> getSAPXBPs()
        Get an RWIterable over an ordered collection of SAPXBPs. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Collection of XBP settings for a SAP system.
        Specified by:
        getSAPXBPs in interface SAPSystemComp
        Returns:
        An RWIterable over an ordered collection of SAPXBP objects .

      • createSAPXBP

        SAPXBP createSAPXBP()
        Create a new SAPXBP linked to this object.
        Returns:
        a new SAPXBP.

      • getSAPXMW

        SAPXMW getSAPXMW()
        Get the SAPXMW. XMW settings for a SAP system.
        Returns:
        nullSAPXMW
        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.

      • createSAPXMW

        SAPXMW createSAPXMW()
        Create a new SAPXMW linked to this object.
        Returns:
        a new SAPXMW.

      • getSAPLanguageBySAPLanguage

        SAPLanguage getSAPLanguageBySAPLanguage​(String sAPLanguage)
        Get the SAPLanguage by SAPLanguageSAPSystem.
        Parameters:
        sAPLanguage -
        Returns:
        the SAPLanguage, 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.

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

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