Interface PublishApproval

    • Method Detail

      • getPublishItem

        Long getPublishItem()
        Get the value for PublishItem. (The unique id of the publish set, publish this approval is related to) 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.
      • getDocId

        Long getDocId()
        Get the value for DocId. (The id of the R2W Document that needs approval) 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.
      • getVersionId

        Long getVersionId()
        Get the value for VersionId. (The version id of the R2W publication that needs approval) 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.
      • getPublicationId

        Long getPublicationId()
        Get the value for PublicationId. (The id of the R2W publication that needs approval) 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.
      • getDocPath

        String getDocPath()
        Get the value for DocPath. (The full path to 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.
      • getApprovalRuleId

        Long getApprovalRuleId()
        Get the value for ApprovalRuleId. (The id of the approval rule) 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.
      • getApprovalURL

        String getApprovalURL()
        Get the value for ApprovalURL. (The URL to the approval) 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.
      • getComment

        String getComment()
        Get the value for Comment. (The approval comment)
        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.
      • getStatus

        String getStatus()
        Get the value for Status. (The status of the approval)
        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.
      • getApproverName

        String getApproverName()
        Get the value for ApproverName. (The name of the user that approved the changes)
        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.
      • getLastModified

        DateTimeZone getLastModified()
        Get the value for LastModified. (The status of the approval)
        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.
      • setPublishItem

        void setPublishItem​(Long newPublishItem)
        Set the value for PublishItem. (The unique id of the publish set, publish this approval is related to) This value is mandatory.
        Parameters:
        newPublishItem - the new value for PublishItem. 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.
      • setDocId

        void setDocId​(Long newDocId)
        Set the value for DocId. (The id of the R2W Document that needs approval) This value is mandatory.
        Parameters:
        newDocId - the new value for DocId. 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.
      • setVersionId

        void setVersionId​(Long newVersionId)
        Set the value for VersionId. (The version id of the R2W publication that needs approval) This value is mandatory.
        Parameters:
        newVersionId - the new value for VersionId. 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.
      • setPublicationId

        void setPublicationId​(Long newPublicationId)
        Set the value for PublicationId. (The id of the R2W publication that needs approval) This value is mandatory.
        Parameters:
        newPublicationId - the new value for PublicationId. 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.
      • setDocPath

        void setDocPath​(String newDocPath)
        Set the value for DocPath. (The full path to the file) This value is mandatory.
        Parameters:
        newDocPath - the new value for DocPath. 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.
      • setApprovalRuleId

        void setApprovalRuleId​(Long newApprovalRuleId)
        Set the value for ApprovalRuleId. (The id of the approval rule) This value is mandatory.
        Parameters:
        newApprovalRuleId - the new value for ApprovalRuleId. 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.
      • setApprovalURL

        void setApprovalURL​(String newApprovalURL)
        Set the value for ApprovalURL. (The URL to the approval) This value is mandatory.
        Parameters:
        newApprovalURL - the new value for ApprovalURL. 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.
      • setComment

        void setComment​(String newComment)
        Set the value for Comment. (The approval comment) This value is optional.
        Parameters:
        newComment - the new value for Comment.
        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.
      • setStatus

        void setStatus​(String newStatus)
        Set the value for Status. (The status of the approval) This value is optional.
        Parameters:
        newStatus - the new value for Status.
        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.
      • setApproverName

        void setApproverName​(String newApproverName)
        Set the value for ApproverName. (The name of the user that approved the changes) This value is optional.
        Parameters:
        newApproverName - the new value for ApproverName.
        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.
      • setLastModified

        void setLastModified​(DateTimeZone newLastModified)
        Set the value for LastModified. (The status of the approval) This value is optional.
        Parameters:
        newLastModified - the new value for LastModified.
        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.
      • getJob

        Job getJob()
        Get the Job.
        Returns:
        Job
        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.
      • setJob

        void setJob​(Job newJob)
        Set the value for Job. This value is optional.
        Parameters:
        newJob - is the object to set Job to. The related PublishApproval job that created this publish approval