Interface TableValue

    • Method Detail

      • getKey

        String getKey()
        Get the value for Key. (The row key.) 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.
      • getSearchKey

        String getSearchKey()
        Get the value for SearchKey. (The row search key.) 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.
      • getColumnValue

        String getColumnValue()
        Get the value for ColumnValue. (The column value.)
        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.
      • setKey

        void setKey​(String newKey)
        Set the value for Key. (The row key.) This value is mandatory.
        Parameters:
        newKey - the new value for Key. 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.
      • setSearchKey

        void setSearchKey​(String newSearchKey)
        Set the value for SearchKey. (The row search key.) This value is mandatory.
        Parameters:
        newSearchKey - the new value for SearchKey. 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.
      • setColumnValue

        void setColumnValue​(String newColumnValue)
        Set the value for ColumnValue. (The column value.) This value is optional.
        Parameters:
        newColumnValue - the new value for ColumnValue.
        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.
      • getTable

        Table getTable()
        Get the Table.
        Returns:
        Table
        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.