Interface SAPRecipient

    • Method Detail

      • getClientNumber

        String getClientNumber()
        Get the value for ClientNumber. (Client number.) 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.
      • getOwner

        String getOwner()
        Get the value for Owner. (Owner user name)
        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.
      • getType

        SAPRecipientType getType()
        Get the value for Type. (Recipient type) 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.
      • setClientNumber

        void setClientNumber​(String newClientNumber)
        Set the value for ClientNumber. (Client number.) This value is mandatory.
        Parameters:
        newClientNumber - the new value for ClientNumber. 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.
      • setOwner

        void setOwner​(String newOwner)
        Set the value for Owner. (Owner user name) This value is optional.
        Parameters:
        newOwner - the new value for Owner.
        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.
      • setType

        void setType​(SAPRecipientType newType)
        Set the value for Type. (Recipient type) This value is mandatory.
        Parameters:
        newType - the new value for Type. 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.
      • 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.