Specifying Whether a Parameter Is Required or Optional

Whether a parameter is required or optional determines how a command responds if a user omits the parameter when running the command:

• If the parameter is required, the command returns an error.

• If the parameter is optional, the command runs successfully.

To specify whether a parameter is optional or required, set the optional element of the @Param annotation as follows:

• If the parameter is required, set the optional element to false. This value is the default.

• If the parameter is optional, set the optional element to true.