Package com.axelor.auth.password.policy

Class PolicyDescription

java.lang.Object

com.axelor.auth.password.policy.PolicyDescription

public final class PolicyDescription
extends Object

Represents a user-facing description of an active password policy requirement, intended for display as guidance on the login or change-password page before the user submits.

Carries the policy ID, a raw translatable message key, and optional format parameters. Use getTranslatedMessage() to obtain the final, translated and formatted string.

See Also:

• PasswordPolicy.getDescription()

Constructor Summary

Constructors

Constructor	Description
PolicyDescription(String policyId, String message, Object... parameters)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Returns the raw (untranslated) message key.
Object[]	getParameters()	Returns the format parameters to interpolate into the translated message.
String	getPolicyId()	Returns the identifier of the policy that produced this description.
String	getTranslatedMessage()	Returns the translated and formatted description string, ready for display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PolicyDescription

public PolicyDescription(String policyId,
 String message,
 Object... parameters)

Method Details

getPolicyId

public String getPolicyId()

Returns the identifier of the policy that produced this description.

getMessage

public String getMessage()

Returns the raw (untranslated) message key.

getParameters

public Object[] getParameters()

Returns the format parameters to interpolate into the translated message.

getTranslatedMessage

public String getTranslatedMessage()

Returns the translated and formatted description string, ready for display.