Interface SAPPIChannel

    • Method Detail

      • getChannelId

        String getChannelId()
        Get the value for ChannelId. (XI/PI channel id.) 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.
      • getService

        String getService()
        Get the value for Service. (SAP XI/PI service of this channel.) 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.
      • getParty

        String getParty()
        Get the value for Party. (SAP XI/PI party of this channel.)
        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.
      • setChannelId

        void setChannelId​(String newChannelId)
        Set the value for ChannelId. (XI/PI channel id.) This value is mandatory.
        Parameters:
        newChannelId - the new value for ChannelId. 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.
      • setService

        void setService​(String newService)
        Set the value for Service. (SAP XI/PI service of this channel.) This value is mandatory.
        Parameters:
        newService - the new value for Service. 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.
      • setParty

        void setParty​(String newParty)
        Set the value for Party. (SAP XI/PI party of this channel.) This value is optional.
        Parameters:
        newParty - the new value for Party.
        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.
      • getSAPSystem

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        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.