Package com.redwood.scheduler.api.model

Interface Format

    • Method Detail

      • getExtension

        String getExtension()
        Get the value for Extension. (The case-sensitive extension used in the output filename.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getMimeType

        String getMimeType()
        Get the value for MimeType. (All files having this format are assumed to have this MIME-type.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isAllowTailing

        boolean isAllowTailing()
        Get the value for AllowTailing. (Does the output format support tailing.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setExtension

        void setExtension​(String newExtension)
        Set the value for Extension. (The case-sensitive extension used in the output filename.) This value is optional.
        Parameters:
        newExtension - the new value for Extension.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setMimeType

        void setMimeType​(String newMimeType)
        Set the value for MimeType. (All files having this format are assumed to have this MIME-type.) This value is mandatory.
        Parameters:
        newMimeType - the new value for MimeType. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.