Interface UserMessageDefinitionAttachment

    • Method Detail

      • getSpecification

        String getSpecification()
        Get the value for Specification. (The specification for the File) 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.
      • getDescription

        String getDescription()
        Get the value for Description. (The description for the File) 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.
      • isAttachToNotification

        boolean isAttachToNotification()
        Get the value for AttachToNotification. (Attach to the notification email?)
        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.
      • setSpecification

        void setSpecification​(String newSpecification)
        Set the value for Specification. (The specification for the File) This value is mandatory.
        Parameters:
        newSpecification - the new value for Specification. 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.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (The description for the File) This value is mandatory.
        Parameters:
        newDescription - the new value for Description. 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.
      • setAttachToNotification

        void setAttachToNotification​(boolean newAttachToNotification)
        Set the value for AttachToNotification. (Attach to the notification email?)
        Parameters:
        newAttachToNotification - the new value for AttachToNotification.
        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.
      • getUserMessageDefinition

        UserMessageDefinition getUserMessageDefinition()
        Get the UserMessageDefinition.
        Returns:
        UserMessageDefinition
        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.