Interface ProcessMonitorLog

    • Method Detail

      • getType

        ProcessMonitorLogType getType()
        Get the value for Type. (The type of the log record) 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.
      • getRelatedObjectId

        Long getRelatedObjectId()
        Get the value for RelatedObjectId. (The unique id of the related object for this log) 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.
      • getRelatedObjectName

        String getRelatedObjectName()
        Get the value for RelatedObjectName. (The name of the related object type for this log) 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 of the item at the time of the log) 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.
      • getReply

        String getReply()
        Get the value for Reply. (The reply of the message if it exists)
        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.
      • getCreationTime

        DateTimeZone getCreationTime()
        Get the value for CreationTime. (Timestamp that notes when the Event was raised.) 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.
      • getProgressStart

        DateTimeZone getProgressStart()
        Get the value for ProgressStart. (Timestamp that notes when the Event was raised.) 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.
      • getProgressEnd

        DateTimeZone getProgressEnd()
        Get the value for ProgressEnd. (Timestamp that notes when the Event was raised.)
        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.
      • getStartCount

        Long getStartCount()
        Get the value for StartCount. (The number of starts the item has had.) 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.
      • setType

        void setType​(ProcessMonitorLogType newType)
        Set the value for Type. (The type of the log record) 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.
      • setRelatedObjectId

        void setRelatedObjectId​(Long newRelatedObjectId)
        Set the value for RelatedObjectId. (The unique id of the related object for this log) This value is mandatory.
        Parameters:
        newRelatedObjectId - the new value for RelatedObjectId. 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.
      • setRelatedObjectName

        void setRelatedObjectName​(String newRelatedObjectName)
        Set the value for RelatedObjectName. (The name of the related object type for this log) This value is mandatory.
        Parameters:
        newRelatedObjectName - the new value for RelatedObjectName. 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 of the item at the time of the log) 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.
      • setReply

        void setReply​(String newReply)
        Set the value for Reply. (The reply of the message if it exists) This value is optional.
        Parameters:
        newReply - the new value for Reply.
        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.
      • setStartCount

        void setStartCount​(Long newStartCount)
        Set the value for StartCount. (The number of starts the item has had.) This value is mandatory.
        Parameters:
        newStartCount - the new value for StartCount. 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.
      • getRepliedBySubject

        Subject getRepliedBySubject()
        Get the RepliedBySubject.
        Returns:
        RepliedBySubject
        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.