Interface SoftwareItem

    • Method Detail

      • getSize

        Long getSize()
        Get the value for Size. (The file size.) 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.
      • getTime

        DateTimeZone getTime()
        Get the value for Time. (The modification time of the file. Since there is no time zone on a file, the time zone is always set to GMT)
        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.
      • getRequiredLicense

        LicensableItem getRequiredLicense()
        Get the value for RequiredLicense. (The license key required to view this item, null means that this item can always be viewed)
        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.
      • getData

        String getData()
        Get the value for Data. (The file data.)
        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.
      • getDataBytes

        byte[] getDataBytes()
        Get the value for DataBytes. (The file data.)
        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.
      • getFileName

        String getFileName()
        Get the value for FileName. (Name of the file as found in jar or zip file, if different from SoftwareItem's display 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.
      • getVersion

        String getVersion()
        Get the value for Version. (Version of the download as found in jar or zip 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.
      • getHashSha256

        String getHashSha256()
        Get the value for HashSha256. (SHA256 hash of the download file (without any optional properties).)
        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.
      • setSize

        void setSize​(Long newSize)
        Set the value for Size. (The file size.) This value is mandatory.
        Parameters:
        newSize - the new value for Size. 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.
      • setData

        void setData​(String newData)
        Set the value for Data. (The file data.) This value is optional.
        Parameters:
        newData - the new value for Data.
        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.
      • getSoftwareGroup

        SoftwareGroup getSoftwareGroup()
        Get the SoftwareGroup.
        Returns:
        SoftwareGroup
        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.