Interface SXPBlueprintModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<SXPBlueprint>,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,com.liferay.portal.kernel.model.WorkflowedModel
- All Known Subinterfaces:
SXPBlueprint
- All Known Implementing Classes:
SXPBlueprintWrapper
@ProviderType
public interface SXPBlueprintModel
extends com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>, 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, com.liferay.portal.kernel.model.WorkflowedModel
The base model interface for the SXPBlueprint service. Represents a row in the "SXPBlueprint" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.search.experiences.model.impl.SXPBlueprintModelImpl 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.search.experiences.model.impl.SXPBlueprintImpl.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]longReturns the company ID of this sxp blueprint.Returns the configuration json of this sxp blueprint.Returns the create date of this sxp blueprint.Returns the description of this sxp blueprint.getDescription(String languageId) Returns the localized description of this sxp blueprint in the language.getDescription(String languageId, boolean useDefault) Returns the localized description of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.getDescription(Locale locale) Returns the localized description of this sxp blueprint in the language.getDescription(Locale locale, boolean useDefault) Returns the localized description of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized descriptions of this sxp blueprint.Returns the element instances json of this sxp blueprint.Returns the external reference code of this sxp blueprint.Returns the modified date of this sxp blueprint.longReturns the mvcc version of this sxp blueprint.longReturns the primary key of this sxp blueprint.Returns the schema version of this sxp blueprint.intReturns the status of this sxp blueprint.longReturns the status by user ID of this sxp blueprint.Returns the status by user name of this sxp blueprint.Returns the status by user uuid of this sxp blueprint.Returns the status date of this sxp blueprint.longReturns the sxp blueprint ID of this sxp blueprint.getTitle()Returns the title of this sxp blueprint.Returns the localized title of this sxp blueprint in the language.Returns the localized title of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this sxp blueprint in the language.Returns the localized title of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized titles of this sxp blueprint.longReturns the user ID of this sxp blueprint.Returns the user name of this sxp blueprint.Returns the user uuid of this sxp blueprint.getUuid()Returns the uuid of this sxp blueprint.Returns the version of this sxp blueprint.booleanReturnstrueif this sxp blueprint is approved.booleanisDenied()Returnstrueif this sxp blueprint is denied.booleanisDraft()Returnstrueif this sxp blueprint is a draft.booleanReturnstrueif this sxp blueprint is expired.booleanReturnstrueif this sxp blueprint is inactive.booleanReturnstrueif this sxp blueprint is incomplete.booleanReturnstrueif this sxp blueprint is pending.booleanReturnstrueif this sxp blueprint is scheduled.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetCompanyId(long companyId) Sets the company ID of this sxp blueprint.voidsetConfigurationJSON(String configurationJSON) Sets the configuration json of this sxp blueprint.voidsetCreateDate(Date createDate) Sets the create date of this sxp blueprint.voidsetDescription(String description) Sets the description of this sxp blueprint.voidsetDescription(String description, Locale locale) Sets the localized description of this sxp blueprint in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this sxp blueprint in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions.voidsetDescriptionMap(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions, and sets the default locale.voidsetElementInstancesJSON(String elementInstancesJSON) Sets the element instances json of this sxp blueprint.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this sxp blueprint.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this sxp blueprint.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this sxp blueprint.voidsetPrimaryKey(long primaryKey) Sets the primary key of this sxp blueprint.voidsetSchemaVersion(String schemaVersion) Sets the schema version of this sxp blueprint.voidsetStatus(int status) Sets the status of this sxp blueprint.voidsetStatusByUserId(long statusByUserId) Sets the status by user ID of this sxp blueprint.voidsetStatusByUserName(String statusByUserName) Sets the status by user name of this sxp blueprint.voidsetStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this sxp blueprint.voidsetStatusDate(Date statusDate) Sets the status date of this sxp blueprint.voidsetSXPBlueprintId(long sxpBlueprintId) Sets the sxp blueprint ID of this sxp blueprint.voidSets the title of this sxp blueprint.voidSets the localized title of this sxp blueprint in the language.voidSets the localized title of this sxp blueprint in the language, and sets the default locale.voidsetTitleCurrentLanguageId(String languageId) voidsetTitleMap(Map<Locale, String> titleMap) Sets the localized titles of this sxp blueprint from the map of locales and localized titles.voidsetTitleMap(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this sxp blueprint from the map of locales and localized titles, and sets the default locale.voidsetUserId(long userId) Sets the user ID of this sxp blueprint.voidsetUserName(String userName) Sets the user name of this sxp blueprint.voidsetUserUuid(String userUuid) Sets the user uuid of this sxp blueprint.voidSets the uuid of this sxp blueprint.voidsetVersion(String version) Sets the version of this sxp blueprint.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 sxp blueprint.- Returns:
- the primary key of this sxp blueprint
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this sxp blueprint.- Parameters:
primaryKey- the primary key of this sxp blueprint
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this sxp blueprint.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this sxp blueprint
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this sxp blueprint.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this sxp blueprint
-
getUuid
Returns the uuid of this sxp blueprint.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this sxp blueprint
-
setUuid
Sets the uuid of this sxp blueprint.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this sxp blueprint
-
getExternalReferenceCode
Returns the external reference code of this sxp blueprint.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this sxp blueprint
-
setExternalReferenceCode
Sets the external reference code of this sxp blueprint.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this sxp blueprint
-
getSXPBlueprintId
long getSXPBlueprintId()Returns the sxp blueprint ID of this sxp blueprint.- Returns:
- the sxp blueprint ID of this sxp blueprint
-
setSXPBlueprintId
void setSXPBlueprintId(long sxpBlueprintId) Sets the sxp blueprint ID of this sxp blueprint.- Parameters:
sxpBlueprintId- the sxp blueprint ID of this sxp blueprint
-
getCompanyId
long getCompanyId()Returns the company ID of this sxp blueprint.- 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 sxp blueprint
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this sxp blueprint.- 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 sxp blueprint
-
getUserId
long getUserId()Returns the user ID of this sxp blueprint.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this sxp blueprint
-
setUserId
void setUserId(long userId) Sets the user ID of this sxp blueprint.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this sxp blueprint
-
getUserUuid
String getUserUuid()Returns the user uuid of this sxp blueprint.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this sxp blueprint
-
setUserUuid
Sets the user uuid of this sxp blueprint.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this sxp blueprint
-
getUserName
Returns the user name of this sxp blueprint.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this sxp blueprint
-
setUserName
Sets the user name of this sxp blueprint.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this sxp blueprint
-
getCreateDate
Date getCreateDate()Returns the create date of this sxp blueprint.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this sxp blueprint
-
setCreateDate
Sets the create date of this sxp blueprint.- 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 sxp blueprint
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this sxp blueprint.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this sxp blueprint
-
setModifiedDate
Sets the modified date of this sxp blueprint.- 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 sxp blueprint
-
getConfigurationJSON
Returns the configuration json of this sxp blueprint.- Returns:
- the configuration json of this sxp blueprint
-
setConfigurationJSON
Sets the configuration json of this sxp blueprint.- Parameters:
configurationJSON- the configuration json of this sxp blueprint
-
getDescription
String getDescription()Returns the description of this sxp blueprint.- Returns:
- the description of this sxp blueprint
-
getDescription
Returns the localized description of this sxp blueprint 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 description of this sxp blueprint
-
getDescription
Returns the localized description of this sxp blueprint 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 description of this sxp blueprint. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this sxp blueprint 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 description of this sxp blueprint
-
getDescription
Returns the localized description of this sxp blueprint 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 description of this sxp blueprint
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this sxp blueprint.- Returns:
- the locales and localized descriptions of this sxp blueprint
-
setDescription
Sets the description of this sxp blueprint.- Parameters:
description- the description of this sxp blueprint
-
setDescription
Sets the localized description of this sxp blueprint in the language.- Parameters:
description- the localized description of this sxp blueprintlocale- the locale of the language
-
setDescription
Sets the localized description of this sxp blueprint in the language, and sets the default locale.- Parameters:
description- the localized description of this sxp blueprintlocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions.- Parameters:
descriptionMap- the locales and localized descriptions of this sxp blueprint
-
setDescriptionMap
Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap- the locales and localized descriptions of this sxp blueprintdefaultLocale- the default locale
-
getElementInstancesJSON
Returns the element instances json of this sxp blueprint.- Returns:
- the element instances json of this sxp blueprint
-
setElementInstancesJSON
Sets the element instances json of this sxp blueprint.- Parameters:
elementInstancesJSON- the element instances json of this sxp blueprint
-
getSchemaVersion
Returns the schema version of this sxp blueprint.- Returns:
- the schema version of this sxp blueprint
-
setSchemaVersion
Sets the schema version of this sxp blueprint.- Parameters:
schemaVersion- the schema version of this sxp blueprint
-
getTitle
String getTitle()Returns the title of this sxp blueprint.- Returns:
- the title of this sxp blueprint
-
getTitle
Returns the localized title of this sxp blueprint 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 title of this sxp blueprint
-
getTitle
Returns the localized title of this sxp blueprint 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 title of this sxp blueprint. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getTitle
Returns the localized title of this sxp blueprint 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 title of this sxp blueprint
-
getTitle
Returns the localized title of this sxp blueprint 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 title of this sxp blueprint
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this sxp blueprint.- Returns:
- the locales and localized titles of this sxp blueprint
-
setTitle
Sets the title of this sxp blueprint.- Parameters:
title- the title of this sxp blueprint
-
setTitle
Sets the localized title of this sxp blueprint in the language.- Parameters:
title- the localized title of this sxp blueprintlocale- the locale of the language
-
setTitle
Sets the localized title of this sxp blueprint in the language, and sets the default locale.- Parameters:
title- the localized title of this sxp blueprintlocale- the locale of the languagedefaultLocale- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this sxp blueprint from the map of locales and localized titles.- Parameters:
titleMap- the locales and localized titles of this sxp blueprint
-
setTitleMap
Sets the localized titles of this sxp blueprint from the map of locales and localized titles, and sets the default locale.- Parameters:
titleMap- the locales and localized titles of this sxp blueprintdefaultLocale- the default locale
-
getVersion
Returns the version of this sxp blueprint.- Returns:
- the version of this sxp blueprint
-
setVersion
Sets the version of this sxp blueprint.- Parameters:
version- the version of this sxp blueprint
-
getStatus
int getStatus()Returns the status of this sxp blueprint.- Specified by:
getStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status of this sxp blueprint
-
setStatus
void setStatus(int status) Sets the status of this sxp blueprint.- Specified by:
setStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
status- the status of this sxp blueprint
-
getStatusByUserId
long getStatusByUserId()Returns the status by user ID of this sxp blueprint.- Specified by:
getStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user ID of this sxp blueprint
-
setStatusByUserId
void setStatusByUserId(long statusByUserId) Sets the status by user ID of this sxp blueprint.- Specified by:
setStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserId- the status by user ID of this sxp blueprint
-
getStatusByUserUuid
String getStatusByUserUuid()Returns the status by user uuid of this sxp blueprint.- Specified by:
getStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user uuid of this sxp blueprint
-
setStatusByUserUuid
Sets the status by user uuid of this sxp blueprint.- Specified by:
setStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserUuid- the status by user uuid of this sxp blueprint
-
getStatusByUserName
Returns the status by user name of this sxp blueprint.- Specified by:
getStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user name of this sxp blueprint
-
setStatusByUserName
Sets the status by user name of this sxp blueprint.- Specified by:
setStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserName- the status by user name of this sxp blueprint
-
getStatusDate
Date getStatusDate()Returns the status date of this sxp blueprint.- Specified by:
getStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status date of this sxp blueprint
-
setStatusDate
Sets the status date of this sxp blueprint.- Specified by:
setStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusDate- the status date of this sxp blueprint
-
isApproved
boolean isApproved()Returnstrueif this sxp blueprint is approved.- Specified by:
isApprovedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is approved;falseotherwise
-
isDenied
boolean isDenied()Returnstrueif this sxp blueprint is denied.- Specified by:
isDeniedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is denied;falseotherwise
-
isDraft
boolean isDraft()Returnstrueif this sxp blueprint is a draft.- Specified by:
isDraftin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is a draft;falseotherwise
-
isExpired
boolean isExpired()Returnstrueif this sxp blueprint is expired.- Specified by:
isExpiredin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is expired;falseotherwise
-
isInactive
boolean isInactive()Returnstrueif this sxp blueprint is inactive.- Specified by:
isInactivein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is inactive;falseotherwise
-
isIncomplete
boolean isIncomplete()Returnstrueif this sxp blueprint is incomplete.- Specified by:
isIncompletein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is incomplete;falseotherwise
-
isPending
boolean isPending()Returnstrueif this sxp blueprint is pending.- Specified by:
isPendingin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is pending;falseotherwise
-
isScheduled
boolean isScheduled()Returnstrueif this sxp blueprint is scheduled.- Specified by:
isScheduledin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this sxp blueprint is scheduled;falseotherwise
-
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
SXPBlueprint cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<SXPBlueprint>
-
toXmlString
-