Interface PublishItem

    • Method Detail

      • getReportName

        String getReportName()
        Get the value for ReportName. (The name of the report to publish under) 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.
      • getSource

        String getSource()
        Get the value for Source. (The source file to publish) 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.
      • isRequireApproval

        boolean isRequireApproval()
        Get the value for RequireApproval. (If the publishing requires 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.
      • getMetadata

        String getMetadata()
        Get the value for Metadata. (The meta data of the published file.)
        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.
      • setReportName

        void setReportName​(String newReportName)
        Set the value for ReportName. (The name of the report to publish under) This value is mandatory.
        Parameters:
        newReportName - the new value for ReportName. 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.
      • setSource

        void setSource​(String newSource)
        Set the value for Source. (The source file to publish) This value is mandatory.
        Parameters:
        newSource - the new value for Source. 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.
      • setRequireApproval

        void setRequireApproval​(boolean newRequireApproval)
        Set the value for RequireApproval. (If the publishing requires approval)
        Parameters:
        newRequireApproval - the new value for RequireApproval.
        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.
      • setMetadata

        void setMetadata​(String newMetadata)
        Set the value for Metadata. (The meta data of the published file.) This value is optional.
        Parameters:
        newMetadata - the new value for Metadata.
        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.
      • getR2WCatalogAlias

        R2WCatalogAlias getR2WCatalogAlias()
        Get the R2WCatalogAlias.
        Returns:
        R2WCatalogAlias
        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.
      • setR2WCatalogAlias

        void setR2WCatalogAlias​(R2WCatalogAlias newR2WCatalogAlias)
        Set the value for R2WCatalogAlias. This value is mandatory.
        Parameters:
        newR2WCatalogAlias - is the object to set R2WCatalogAlias to. Link the R2W Catalog to to a Publish Item. If this is null, then the object cannot be persisted.