Providing error messages

April 11, 2024 01:40 PM

1 min read

Brightspot provides convenient APIs for displaying data validation and other error messages on the content edit form.

Use IllegalArgumentException to display error messages at the top of the content edit form.
Use State#addError to display error messages above a field.

                    ErrorMessages
                
import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.State;

public class Galaxy extends Content {

    private String name;

    @ToolUi.Note("(light years)") 
    private String distanceFromEarth;

    protected void beforeSave() { 
        try {
            Float.parseFloat(getDistance()); 
        } catch (NumberFormatException e) { 
            State state = getState();
            state.addError(
                 state.getField("distanceFromEarth"),
                 "Distance must be an integer (1234) or a floating-point number (1234.32)");
            throw new IllegalArgumentException("Resolve the errors listed below, then click Publish."); 
        }
    }

    public String getDistance() {
        return distanceFromEarth;
    }

}

        Declares a field for entering a distance.
    

        Performs data validation prior to saving the object. Brightspot provides several callback methods with which you can perform validation.
    

        Checks if the editor entered a number.
    

        Displays a detailed error message above the field distanceFromEarth.
    

        Displays a general error message at the top of the content edit form.
    