Message Class

Contains validation errors that occur when the end user saves the page when using a standard controller.

Namespace

ApexPages

Usage

When using a standard controller, all validation errors, both custom and standard, that occur when the end user saves the page are automatically added to the page error collections. If there is an inputField component bound to the field with an error, the message is added to the components error collection. All messages are added to the pages error collection. For more information, see Validation Rules and Standard Controllers in the Visualforce Developer's Guide.

If your application uses a custom controller or extension, you must use the message class for collecting errors.

Instantiation

In a custom controller or controller extension, you can instantiate a Message in one of the following ways:

  • ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary);

    where ApexPages.severity is the enum that is determines how severe a message is, and summary is the String used to summarize the message. For example:

    ApexPages.Message myMsg = new ApexPages.Message(ApexPages.Severity.FATAL, 'my error msg');
  • ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary, detail);

    where ApexPages.severity is the enum that is determines how severe a message is, summary is the String used to summarize the message, and detail is the String used to provide more detailed information about the error.

ApexPages.Severity Enum

Using the ApexPages.Severity enum values, specify the severity of the message. The following are the valid values:
  • CONFIRM
  • ERROR
  • FATAL
  • INFO
  • WARNING

All enums have access to standard methods, such as name and value.

Message Constructors

The following are constructors for Message.

Message(ApexPages.Severity, String)

Creates a new instance of the ApexPages.Message class using the specified message severity and summary.

Signature

public Message(ApexPages.Severity severity, String summary)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.

Message(ApexPages.Severity, String, String)

Creates a new instance of the ApexPages.Message class using the specified message severity, summary, and message detail.

Signature

public Message(ApexPages.Severity severity, String summary, String detail)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.
detail
Type: String
The detailed Visualforce message.

Message(ApexPages.Severity, String, String, String)

Creates a new instance of the ApexPages.Message class using the specified severity, summary, detail, and component ID.

Signature

public Message(ApexPages.Severity severity, String summary, String detail, String id)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.
detail
Type: String
The detailed Visualforce message.
id
Type: String
The ID of the Visualforce component to associate with the message, for example, a form field with an error.

Message Methods

The following are methods for Message. All are instance methods.

getComponentLabel()

Returns the label of the associated inputField component. If no label is defined, this method returns null.

Signature

public String getComponentLabel()

Return Value

Type: String

getDetail()

Returns the value of the detail parameter used to create the message. If no detail String was specified, this method returns null.

Signature

public String getDetail()

Return Value

Type: String

getSeverity()

Returns the severity enum used to create the message.

Signature

public ApexPages.Severity getSeverity()

Return Value

Type: ApexPages.Severity

getSummary()

Returns the summary String used to create the message.

Signature

public String getSummary()

Return Value

Type: String

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.