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 TypeMethodDescriptionbooleanReturns the active of this object validation rule.String[]longReturns 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.longReturns 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.longReturns the object definition ID of this object validation rule.longReturns the object validation rule ID of this object validation rule.Returns the output type of this object validation rule.longReturns the primary key of this object validation rule.Returns the script of this object validation rule.booleanReturns the system of this object validation rule.longReturns 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.booleanisActive()Returnstrueif this object validation rule is active.booleanisSystem()Returnstrueif this object validation rule is system.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetActive(boolean active) Sets whether this object validation rule is active.voidsetCompanyId(long companyId) Sets the company ID of this object validation rule.voidsetCreateDate(Date createDate) Sets the create date of this object validation rule.voidSets the engine of this object validation rule.voidsetErrorLabel(String errorLabel) Sets the error label of this object validation rule.voidsetErrorLabel(String errorLabel, Locale locale) Sets the localized error label of this object validation rule in the language.voidsetErrorLabel(String errorLabel, Locale locale, Locale defaultLocale) Sets the localized error label of this object validation rule in the language, and sets the default locale.voidsetErrorLabelCurrentLanguageId(String languageId) voidsetErrorLabelMap(Map<Locale, String> errorLabelMap) Sets the localized error labels of this object validation rule from the map of locales and localized error labels.voidsetErrorLabelMap(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.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this object validation rule.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this object validation rule.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this object validation rule.voidSets the name of this object validation rule.voidSets the localized name of this object validation rule in the language.voidSets the localized name of this object validation rule in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this object validation rule from the map of locales and localized names.voidsetNameMap(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.voidsetObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object validation rule.voidsetObjectValidationRuleId(long objectValidationRuleId) Sets the object validation rule ID of this object validation rule.voidsetOutputType(String outputType) Sets the output type of this object validation rule.voidsetPrimaryKey(long primaryKey) Sets the primary key of this object validation rule.voidSets the script of this object validation rule.voidsetSystem(boolean system) Sets whether this object validation rule is system.voidsetUserId(long userId) Sets the user ID of this object validation rule.voidsetUserName(String userName) Sets the user name of this object validation rule.voidsetUserUuid(String userUuid) Sets the user uuid of this object validation rule.voidSets the uuid of this object validation rule.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods 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:
getMvccVersionin 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:
setMvccVersionin 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:
getUuidin 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:
setUuidin 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:
getExternalReferenceCodein 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:
setExternalReferenceCodein 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:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin 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:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin 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:
getUserIdin 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:
setUserIdin 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:
getUserUuidin 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:
setUserUuidin 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:
getUserNamein 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:
setUserNamein 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:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein 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:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein 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:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein 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:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein 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()Returnstrueif this object validation rule is active.- Returns:
trueif this object validation rule is active;falseotherwise
-
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
useDefaultisfalseand 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
useDefaultisfalseand 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()Returnstrueif this object validation rule is system.- Returns:
trueif this object validation rule is system;falseotherwise
-
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:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin 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:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
ObjectValidationRule cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<ObjectValidationRule>
-
toXmlString
-