Package com.redwood.scheduler.api.model

Interface TableDefinitionColumn

    • Method Detail

      • getDisplayOrder

        Long getDisplayOrder()
        Get the value for DisplayOrder. (Display order) 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.

      • getColumnName

        String getColumnName()
        Get the value for ColumnName. (The column name.) 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.

      • getSearchColumnName

        String getSearchColumnName()
        Get the value for SearchColumnName. (The column search name.) 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.

      • isNullable

        boolean isNullable()
        Get the value for Nullable. (Is the parameter optional?)
        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.

      • getDataType

        ParameterType getDataType()
        Get the value for DataType. (The datatype of the column) 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. (Optional 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.

      • getDescription

        String getDescription()
        Get the value for Description. (Optional description)
        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.

      • getDefaultValue

        String getDefaultValue()
        Get the value for DefaultValue. (Optional default value, used to initialize columnValue when creating a new TableValue)
        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.

      • isPassword

        boolean isPassword()
        Get the value for Password. (This column is a Password field and values for this column will not be displayed)
        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.

      • getDataLength

        Long getDataLength()
        Get the value for DataLength. (The maximum length that a table value of a string column can be. If this value is null then the length will not be checked. This value is ignored for non-string columns.)
        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.

      • getSimpleConstraintType

        SimpleConstraintType getSimpleConstraintType()
        Get the value for SimpleConstraintType. (The type of simple constraint to apply.) 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.

      • getSimpleConstraintData

        String getSimpleConstraintData()
        Get the value for SimpleConstraintData. (The data for the simple constraint.)
        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.

      • getSimpleConstraintMessage

        String getSimpleConstraintMessage()
        Get the value for SimpleConstraintMessage. (The message to display if the simple constraint fails to validate.)
        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.

      • isSimpleConstraintOptional

        boolean isSimpleConstraintOptional()
        Get the value for SimpleConstraintOptional. (Is the constraint optional?)
        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.

      • getSimpleConstraintSort

        SimpleConstraintSort getSimpleConstraintSort()
        Get the value for SimpleConstraintSort. (Sort order of constraint.) 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.

      • setDisplayOrder

        void setDisplayOrder​(Long newDisplayOrder)
        Set the value for DisplayOrder. (Display order) This value is mandatory.
        Parameters:
        newDisplayOrder - the new value for DisplayOrder. 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.

      • setColumnName

        void setColumnName​(String newColumnName)
        Set the value for ColumnName. (The column name.) This value is mandatory.
        Parameters:
        newColumnName - the new value for ColumnName. 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.

      • setSearchColumnName

        void setSearchColumnName​(String newSearchColumnName)
        Set the value for SearchColumnName. (The column search name.) This value is mandatory.
        Parameters:
        newSearchColumnName - the new value for SearchColumnName. 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.

      • setNullable

        void setNullable​(boolean newNullable)
        Set the value for Nullable. (Is the parameter optional?)
        Parameters:
        newNullable - the new value for Nullable.
        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.

      • setDataType

        void setDataType​(ParameterType newDataType)
        Set the value for DataType. (The datatype of the column) This value is mandatory.
        Parameters:
        newDataType - the new value for DataType. 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. (Optional 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.

      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        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.

      • setDefaultValue

        void setDefaultValue​(String newDefaultValue)
        Set the value for DefaultValue. (Optional default value, used to initialize columnValue when creating a new TableValue) This value is optional.
        Parameters:
        newDefaultValue - the new value for DefaultValue.
        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.

      • setPassword

        void setPassword​(boolean newPassword)
        Set the value for Password. (This column is a Password field and values for this column will not be displayed)
        Parameters:
        newPassword - the new value for Password.
        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.

      • setDataLength

        void setDataLength​(Long newDataLength)
        Set the value for DataLength. (The maximum length that a table value of a string column can be. If this value is null then the length will not be checked. This value is ignored for non-string columns.) This value is optional.
        Parameters:
        newDataLength - the new value for DataLength.
        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.

      • setSimpleConstraintType

        void setSimpleConstraintType​(SimpleConstraintType newSimpleConstraintType)
        Set the value for SimpleConstraintType. (The type of simple constraint to apply.) This value is mandatory.
        Parameters:
        newSimpleConstraintType - the new value for SimpleConstraintType. 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.

      • setSimpleConstraintData

        void setSimpleConstraintData​(String newSimpleConstraintData)
        Set the value for SimpleConstraintData. (The data for the simple constraint.) This value is optional.
        Parameters:
        newSimpleConstraintData - the new value for SimpleConstraintData.
        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.

      • setSimpleConstraintMessage

        void setSimpleConstraintMessage​(String newSimpleConstraintMessage)
        Set the value for SimpleConstraintMessage. (The message to display if the simple constraint fails to validate.) This value is optional.
        Parameters:
        newSimpleConstraintMessage - the new value for SimpleConstraintMessage.
        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.

      • setSimpleConstraintOptional

        void setSimpleConstraintOptional​(boolean newSimpleConstraintOptional)
        Set the value for SimpleConstraintOptional. (Is the constraint optional?)
        Parameters:
        newSimpleConstraintOptional - the new value for SimpleConstraintOptional.
        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.

      • setSimpleConstraintSort

        void setSimpleConstraintSort​(SimpleConstraintSort newSimpleConstraintSort)
        Set the value for SimpleConstraintSort. (Sort order of constraint.) This value is mandatory.
        Parameters:
        newSimpleConstraintSort - the new value for SimpleConstraintSort. 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.

      • getTableDefinition

        TableDefinition getTableDefinition()
        Get the TableDefinition.
        Returns:
        TableDefinition
        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.