Package com.liferay.object.model
Interface ObjectValidationRuleModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<ObjectValidationRule>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<ObjectValidationRule>
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedAuditedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
ObjectValidationRule
- All Known Implementing Classes:
ObjectValidationRuleWrapper
@ProviderType
public interface ObjectValidationRuleModel
extends com.liferay.portal.kernel.model.BaseModel<ObjectValidationRule>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
The base model interface for the ObjectValidationRule service. Represents a row in the "ObjectValidationRule" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.object.model.impl.ObjectValidationRuleModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.object.model.impl.ObjectValidationRuleImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the active of this object validation rule.String[]
long
Returns the company ID of this object validation rule.Returns the create date of this object validation rule.Returns the engine of this object validation rule.Returns the error label of this object validation rule.getErrorLabel
(String languageId) Returns the localized error label of this object validation rule in the language.getErrorLabel
(String languageId, boolean useDefault) Returns the localized error label of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.getErrorLabel
(Locale locale) Returns the localized error label of this object validation rule in the language.getErrorLabel
(Locale locale, boolean useDefault) Returns the localized error label of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized error labels of this object validation rule.Returns the external reference code of this object validation rule.Returns the modified date of this object validation rule.long
Returns the mvcc version of this object validation rule.getName()
Returns the name of this object validation rule.Returns the localized name of this object validation rule in the language.Returns the localized name of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this object validation rule in the language.Returns the localized name of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this object validation rule.long
Returns the object definition ID of this object validation rule.long
Returns the object validation rule ID of this object validation rule.Returns the output type of this object validation rule.long
Returns the primary key of this object validation rule.Returns the script of this object validation rule.boolean
Returns the system of this object validation rule.long
Returns the user ID of this object validation rule.Returns the user name of this object validation rule.Returns the user uuid of this object validation rule.getUuid()
Returns the uuid of this object validation rule.boolean
isActive()
Returnstrue
if this object validation rule is active.boolean
isSystem()
Returnstrue
if this object validation rule is system.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setActive
(boolean active) Sets whether this object validation rule is active.void
setCompanyId
(long companyId) Sets the company ID of this object validation rule.void
setCreateDate
(Date createDate) Sets the create date of this object validation rule.void
Sets the engine of this object validation rule.void
setErrorLabel
(String errorLabel) Sets the error label of this object validation rule.void
setErrorLabel
(String errorLabel, Locale locale) Sets the localized error label of this object validation rule in the language.void
setErrorLabel
(String errorLabel, Locale locale, Locale defaultLocale) Sets the localized error label of this object validation rule in the language, and sets the default locale.void
setErrorLabelCurrentLanguageId
(String languageId) void
setErrorLabelMap
(Map<Locale, String> errorLabelMap) Sets the localized error labels of this object validation rule from the map of locales and localized error labels.void
setErrorLabelMap
(Map<Locale, String> errorLabelMap, Locale defaultLocale) Sets the localized error labels of this object validation rule from the map of locales and localized error labels, and sets the default locale.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this object validation rule.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this object validation rule.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this object validation rule.void
Sets the name of this object validation rule.void
Sets the localized name of this object validation rule in the language.void
Sets the localized name of this object validation rule in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this object validation rule from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this object validation rule from the map of locales and localized names, and sets the default locale.void
setObjectDefinitionId
(long objectDefinitionId) Sets the object definition ID of this object validation rule.void
setObjectValidationRuleId
(long objectValidationRuleId) Sets the object validation rule ID of this object validation rule.void
setOutputType
(String outputType) Sets the output type of this object validation rule.void
setPrimaryKey
(long primaryKey) Sets the primary key of this object validation rule.void
Sets the script of this object validation rule.void
setSystem
(boolean system) Sets whether this object validation rule is system.void
setUserId
(long userId) Sets the user ID of this object validation rule.void
setUserName
(String userName) Sets the user name of this object validation rule.void
setUserUuid
(String userUuid) Sets the user uuid of this object validation rule.void
Sets the uuid of this object validation rule.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this object validation rule.- Returns:
- the primary key of this object validation rule
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this object validation rule.- Parameters:
primaryKey
- the primary key of this object validation rule
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this object validation rule.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this object validation rule
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this object validation rule.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this object validation rule
-
getUuid
Returns the uuid of this object validation rule.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this object validation rule
-
setUuid
Sets the uuid of this object validation rule.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this object validation rule
-
getExternalReferenceCode
Returns the external reference code of this object validation rule.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this object validation rule
-
setExternalReferenceCode
Sets the external reference code of this object validation rule.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this object validation rule
-
getObjectValidationRuleId
long getObjectValidationRuleId()Returns the object validation rule ID of this object validation rule.- Returns:
- the object validation rule ID of this object validation rule
-
setObjectValidationRuleId
void setObjectValidationRuleId(long objectValidationRuleId) Sets the object validation rule ID of this object validation rule.- Parameters:
objectValidationRuleId
- the object validation rule ID of this object validation rule
-
getCompanyId
long getCompanyId()Returns the company ID of this object validation rule.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this object validation rule
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this object validation rule.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this object validation rule
-
getUserId
long getUserId()Returns the user ID of this object validation rule.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this object validation rule
-
setUserId
void setUserId(long userId) Sets the user ID of this object validation rule.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this object validation rule
-
getUserUuid
String getUserUuid()Returns the user uuid of this object validation rule.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this object validation rule
-
setUserUuid
Sets the user uuid of this object validation rule.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this object validation rule
-
getUserName
Returns the user name of this object validation rule.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this object validation rule
-
setUserName
Sets the user name of this object validation rule.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this object validation rule
-
getCreateDate
Date getCreateDate()Returns the create date of this object validation rule.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this object validation rule
-
setCreateDate
Sets the create date of this object validation rule.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this object validation rule
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this object validation rule.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this object validation rule
-
setModifiedDate
Sets the modified date of this object validation rule.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this object validation rule
-
getObjectDefinitionId
long getObjectDefinitionId()Returns the object definition ID of this object validation rule.- Returns:
- the object definition ID of this object validation rule
-
setObjectDefinitionId
void setObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object validation rule.- Parameters:
objectDefinitionId
- the object definition ID of this object validation rule
-
getActive
boolean getActive()Returns the active of this object validation rule.- Returns:
- the active of this object validation rule
-
isActive
boolean isActive()Returnstrue
if this object validation rule is active.- Returns:
true
if this object validation rule is active;false
otherwise
-
setActive
void setActive(boolean active) Sets whether this object validation rule is active.- Parameters:
active
- the active of this object validation rule
-
getEngine
Returns the engine of this object validation rule.- Returns:
- the engine of this object validation rule
-
setEngine
Sets the engine of this object validation rule.- Parameters:
engine
- the engine of this object validation rule
-
getErrorLabel
String getErrorLabel()Returns the error label of this object validation rule.- Returns:
- the error label of this object validation rule
-
getErrorLabel
Returns the localized error label of this object validation rule in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized error label of this object validation rule
-
getErrorLabel
Returns the localized error label of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized error label of this object validation rule. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getErrorLabel
Returns the localized error label of this object validation rule in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized error label of this object validation rule
-
getErrorLabel
Returns the localized error label of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized error label of this object validation rule
-
getErrorLabelCurrentLanguageId
-
getErrorLabelCurrentValue
-
getErrorLabelMap
Returns a map of the locales and localized error labels of this object validation rule.- Returns:
- the locales and localized error labels of this object validation rule
-
setErrorLabel
Sets the error label of this object validation rule.- Parameters:
errorLabel
- the error label of this object validation rule
-
setErrorLabel
Sets the localized error label of this object validation rule in the language.- Parameters:
errorLabel
- the localized error label of this object validation rulelocale
- the locale of the language
-
setErrorLabel
Sets the localized error label of this object validation rule in the language, and sets the default locale.- Parameters:
errorLabel
- the localized error label of this object validation rulelocale
- the locale of the languagedefaultLocale
- the default locale
-
setErrorLabelCurrentLanguageId
-
setErrorLabelMap
Sets the localized error labels of this object validation rule from the map of locales and localized error labels.- Parameters:
errorLabelMap
- the locales and localized error labels of this object validation rule
-
setErrorLabelMap
Sets the localized error labels of this object validation rule from the map of locales and localized error labels, and sets the default locale.- Parameters:
errorLabelMap
- the locales and localized error labels of this object validation ruledefaultLocale
- the default locale
-
getName
String getName()Returns the name of this object validation rule.- Returns:
- the name of this object validation rule
-
getName
Returns the localized name of this object validation rule in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized name of this object validation rule
-
getName
Returns the localized name of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this object validation rule. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this object validation rule in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized name of this object validation rule
-
getName
Returns the localized name of this object validation rule in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this object validation rule
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this object validation rule.- Returns:
- the locales and localized names of this object validation rule
-
setName
Sets the name of this object validation rule.- Parameters:
name
- the name of this object validation rule
-
setName
Sets the localized name of this object validation rule in the language.- Parameters:
name
- the localized name of this object validation rulelocale
- the locale of the language
-
setName
Sets the localized name of this object validation rule in the language, and sets the default locale.- Parameters:
name
- the localized name of this object validation rulelocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this object validation rule from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this object validation rule
-
setNameMap
Sets the localized names of this object validation rule from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this object validation ruledefaultLocale
- the default locale
-
getOutputType
Returns the output type of this object validation rule.- Returns:
- the output type of this object validation rule
-
setOutputType
Sets the output type of this object validation rule.- Parameters:
outputType
- the output type of this object validation rule
-
getScript
Returns the script of this object validation rule.- Returns:
- the script of this object validation rule
-
setScript
Sets the script of this object validation rule.- Parameters:
script
- the script of this object validation rule
-
getSystem
boolean getSystem()Returns the system of this object validation rule.- Returns:
- the system of this object validation rule
-
isSystem
boolean isSystem()Returnstrue
if this object validation rule is system.- Returns:
true
if this object validation rule is system;false
otherwise
-
setSystem
void setSystem(boolean system) Sets whether this object validation rule is system.- Parameters:
system
- the system of this object validation rule
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
ObjectValidationRule cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<ObjectValidationRule>
-
toXmlString
-