Package com.veeva.vault.sdk.api.data
Interface ObjectValidationRuleMetadata
public interface ObjectValidationRuleMetadata
Provides methods to retrieve common metadata for the specified object validation rule.
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the description of the given object validation rule.Retrieves the error locations of the given object validation rule.Retrieves the error message of the given object validation rule in the initiating user's language.getLabel()
Retrieves the label value of the given object validation rule in the initiating user's language.getName()
Retrieves the name of the given object validation rule.Retrieves the name of the associated object for the given object validation rule.Retrieves theSourceType
of the given object validation rule.Retrieves theValidationRuleExpressionMetadata
containing the validation expression of the given object validation rule.boolean
isActive()
Retrieves whether the given object validation rule status is active.
-
Method Details
-
getObjectName
String getObjectName()Retrieves the name of the associated object for the given object validation rule. For example,"product__v"
.- Returns:
- the non-null object name
-
getName
String getName()Retrieves the name of the given object validation rule. For example,"object_validation_rule__c"
.- Returns:
- the non-null object validation rule name
-
getLabel
String getLabel()Retrieves the label value of the given object validation rule in the initiating user's language. For example, "Validation Rule Name".- Returns:
- the object validation rule label
-
getSourceType
SourceType getSourceType()Retrieves theSourceType
of the given object validation rule. For example,SourceType.STANDARD
.- Returns:
- the
SourceType
of the object validation rule - See Also:
-
getErrorMessage
String getErrorMessage()Retrieves the error message of the given object validation rule in the initiating user's language. For example, "Object Validation Error Message".- Returns:
- the object validation rule error message
-
getErrorLocations
Retrieves the error locations of the given object validation rule. These are the names of the fields where the error message appears if the validation rule fails. For example,"text_field__c"
.- Returns:
- a List of field names where the validation rule error message appears
-
isActive
boolean isActive()Retrieves whether the given object validation rule status is active.- Returns:
- true if the object validation rule is active, otherwise false
-
getDescription
String getDescription()Retrieves the description of the given object validation rule.- Returns:
- the validation rule description
-
getValidationExpression
ValidationRuleExpressionMetadata getValidationExpression()Retrieves theValidationRuleExpressionMetadata
containing the validation expression of the given object validation rule.- Returns:
- a
ValidationRuleExpressionMetadata
with a validation expression
-