@ProviderType public interface SXPBlueprintModel extends com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>, 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
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
.
SXPBlueprint
Modifier and Type | Method and Description |
---|---|
SXPBlueprint |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this sxp blueprint.
|
java.lang.String |
getConfigurationJSON()
Returns the configuration json of this sxp blueprint.
|
java.util.Date |
getCreateDate()
Returns the create date of this sxp blueprint.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this sxp blueprint.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this sxp blueprint in the language.
|
java.lang.String |
getDescription(java.util.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.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this sxp blueprint in the language.
|
java.lang.String |
getDescription(java.lang.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.
|
java.lang.String |
getDescriptionCurrentLanguageId() |
java.lang.String |
getDescriptionCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this sxp blueprint.
|
java.lang.String |
getElementInstancesJSON()
Returns the element instances json of this sxp blueprint.
|
java.lang.String |
getExternalReferenceCode()
Returns the external reference code of this sxp blueprint.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this sxp blueprint.
|
long |
getMvccVersion()
Returns the mvcc version of this sxp blueprint.
|
long |
getPrimaryKey()
Returns the primary key of this sxp blueprint.
|
java.lang.String |
getSchemaVersion()
Returns the schema version of this sxp blueprint.
|
int |
getStatus()
Returns the status of this sxp blueprint.
|
long |
getStatusByUserId()
Returns the status by user ID of this sxp blueprint.
|
java.lang.String |
getStatusByUserName()
Returns the status by user name of this sxp blueprint.
|
java.lang.String |
getStatusByUserUuid()
Returns the status by user uuid of this sxp blueprint.
|
java.util.Date |
getStatusDate()
Returns the status date of this sxp blueprint.
|
long |
getSXPBlueprintId()
Returns the sxp blueprint ID of this sxp blueprint.
|
java.lang.String |
getTitle()
Returns the title of this sxp blueprint.
|
java.lang.String |
getTitle(java.util.Locale locale)
Returns the localized title of this sxp blueprint in the language.
|
java.lang.String |
getTitle(java.util.Locale locale,
boolean useDefault)
Returns the localized title of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getTitle(java.lang.String languageId)
Returns the localized title of this sxp blueprint in the language.
|
java.lang.String |
getTitle(java.lang.String languageId,
boolean useDefault)
Returns the localized title of this sxp blueprint in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getTitleCurrentLanguageId() |
java.lang.String |
getTitleCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getTitleMap()
Returns a map of the locales and localized titles of this sxp blueprint.
|
long |
getUserId()
Returns the user ID of this sxp blueprint.
|
java.lang.String |
getUserName()
Returns the user name of this sxp blueprint.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this sxp blueprint.
|
java.lang.String |
getUuid()
Returns the uuid of this sxp blueprint.
|
java.lang.String |
getVersion()
Returns the version of this sxp blueprint.
|
boolean |
isApproved()
Returns
true if this sxp blueprint is approved. |
boolean |
isDenied()
Returns
true if this sxp blueprint is denied. |
boolean |
isDraft()
Returns
true if this sxp blueprint is a draft. |
boolean |
isExpired()
Returns
true if this sxp blueprint is expired. |
boolean |
isInactive()
Returns
true if this sxp blueprint is inactive. |
boolean |
isIncomplete()
Returns
true if this sxp blueprint is incomplete. |
boolean |
isPending()
Returns
true if this sxp blueprint is pending. |
boolean |
isScheduled()
Returns
true if this sxp blueprint is scheduled. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCompanyId(long companyId)
Sets the company ID of this sxp blueprint.
|
void |
setConfigurationJSON(java.lang.String configurationJSON)
Sets the configuration json of this sxp blueprint.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this sxp blueprint.
|
void |
setDescription(java.lang.String description)
Sets the description of this sxp blueprint.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this sxp blueprint in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this sxp blueprint in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(java.lang.String languageId) |
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions.
|
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions, and sets the default locale.
|
void |
setElementInstancesJSON(java.lang.String elementInstancesJSON)
Sets the element instances json of this sxp blueprint.
|
void |
setExternalReferenceCode(java.lang.String externalReferenceCode)
Sets the external reference code of this sxp blueprint.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this sxp blueprint.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this sxp blueprint.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this sxp blueprint.
|
void |
setSchemaVersion(java.lang.String schemaVersion)
Sets the schema version of this sxp blueprint.
|
void |
setStatus(int status)
Sets the status of this sxp blueprint.
|
void |
setStatusByUserId(long statusByUserId)
Sets the status by user ID of this sxp blueprint.
|
void |
setStatusByUserName(java.lang.String statusByUserName)
Sets the status by user name of this sxp blueprint.
|
void |
setStatusByUserUuid(java.lang.String statusByUserUuid)
Sets the status by user uuid of this sxp blueprint.
|
void |
setStatusDate(java.util.Date statusDate)
Sets the status date of this sxp blueprint.
|
void |
setSXPBlueprintId(long sxpBlueprintId)
Sets the sxp blueprint ID of this sxp blueprint.
|
void |
setTitle(java.lang.String title)
Sets the title of this sxp blueprint.
|
void |
setTitle(java.lang.String title,
java.util.Locale locale)
Sets the localized title of this sxp blueprint in the language.
|
void |
setTitle(java.lang.String title,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized title of this sxp blueprint in the language, and sets the default locale.
|
void |
setTitleCurrentLanguageId(java.lang.String languageId) |
void |
setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)
Sets the localized titles of this sxp blueprint from the map of locales and localized titles.
|
void |
setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Locale defaultLocale)
Sets the localized titles of this sxp blueprint from the map of locales and localized titles, and sets the default locale.
|
void |
setUserId(long userId)
Sets the user ID of this sxp blueprint.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this sxp blueprint.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this sxp blueprint.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this sxp blueprint.
|
void |
setVersion(java.lang.String version)
Sets the version of this sxp blueprint.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this sxp blueprintlong getMvccVersion()
getMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
mvccVersion
- the mvcc version of this sxp blueprint@AutoEscape java.lang.String getUuid()
getUuid
in interface com.liferay.portal.kernel.model.StagedModel
void setUuid(java.lang.String uuid)
setUuid
in interface com.liferay.portal.kernel.model.StagedModel
uuid
- the uuid of this sxp blueprint@AutoEscape java.lang.String getExternalReferenceCode()
void setExternalReferenceCode(java.lang.String externalReferenceCode)
externalReferenceCode
- the external reference code of this sxp blueprintlong getSXPBlueprintId()
void setSXPBlueprintId(long sxpBlueprintId)
sxpBlueprintId
- the sxp blueprint ID of this sxp blueprintlong getCompanyId()
getCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
getCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
setCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
setCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
companyId
- the company ID of this sxp blueprintlong getUserId()
getUserId
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserId(long userId)
setUserId
in interface com.liferay.portal.kernel.model.AuditedModel
userId
- the user ID of this sxp blueprintjava.lang.String getUserUuid()
getUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserUuid(java.lang.String userUuid)
setUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
userUuid
- the user uuid of this sxp blueprint@AutoEscape java.lang.String getUserName()
getUserName
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserName(java.lang.String userName)
setUserName
in interface com.liferay.portal.kernel.model.AuditedModel
userName
- the user name of this sxp blueprintjava.util.Date getCreateDate()
getCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
getCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
void setCreateDate(java.util.Date createDate)
setCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
setCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
createDate
- the create date of this sxp blueprintjava.util.Date getModifiedDate()
getModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
getModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
void setModifiedDate(java.util.Date modifiedDate)
setModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
setModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
modifiedDate
- the modified date of this sxp blueprint@AutoEscape java.lang.String getConfigurationJSON()
void setConfigurationJSON(java.lang.String configurationJSON)
configurationJSON
- the configuration json of this sxp blueprintjava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getDescription(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getDescription(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getDescription(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description
- the description of this sxp blueprintvoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this sxp blueprintlocale
- the locale of the languagevoid setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale)
description
- the localized description of this sxp blueprintlocale
- the locale of the languagedefaultLocale
- the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap
- the locales and localized descriptions of this sxp blueprintvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this sxp blueprintdefaultLocale
- the default locale@AutoEscape java.lang.String getElementInstancesJSON()
void setElementInstancesJSON(java.lang.String elementInstancesJSON)
elementInstancesJSON
- the element instances json of this sxp blueprint@AutoEscape java.lang.String getSchemaVersion()
void setSchemaVersion(java.lang.String schemaVersion)
schemaVersion
- the schema version of this sxp blueprintjava.lang.String getTitle()
@AutoEscape java.lang.String getTitle(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getTitle(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getTitle(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getTitle(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getTitleCurrentLanguageId()
@AutoEscape java.lang.String getTitleCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getTitleMap()
void setTitle(java.lang.String title)
title
- the title of this sxp blueprintvoid setTitle(java.lang.String title, java.util.Locale locale)
title
- the localized title of this sxp blueprintlocale
- the locale of the languagevoid setTitle(java.lang.String title, java.util.Locale locale, java.util.Locale defaultLocale)
title
- the localized title of this sxp blueprintlocale
- the locale of the languagedefaultLocale
- the default localevoid setTitleCurrentLanguageId(java.lang.String languageId)
void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)
titleMap
- the locales and localized titles of this sxp blueprintvoid setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Locale defaultLocale)
titleMap
- the locales and localized titles of this sxp blueprintdefaultLocale
- the default locale@AutoEscape java.lang.String getVersion()
void setVersion(java.lang.String version)
version
- the version of this sxp blueprintint getStatus()
getStatus
in interface com.liferay.portal.kernel.model.WorkflowedModel
void setStatus(int status)
setStatus
in interface com.liferay.portal.kernel.model.WorkflowedModel
status
- the status of this sxp blueprintlong getStatusByUserId()
getStatusByUserId
in interface com.liferay.portal.kernel.model.WorkflowedModel
void setStatusByUserId(long statusByUserId)
setStatusByUserId
in interface com.liferay.portal.kernel.model.WorkflowedModel
statusByUserId
- the status by user ID of this sxp blueprintjava.lang.String getStatusByUserUuid()
getStatusByUserUuid
in interface com.liferay.portal.kernel.model.WorkflowedModel
void setStatusByUserUuid(java.lang.String statusByUserUuid)
setStatusByUserUuid
in interface com.liferay.portal.kernel.model.WorkflowedModel
statusByUserUuid
- the status by user uuid of this sxp blueprint@AutoEscape java.lang.String getStatusByUserName()
getStatusByUserName
in interface com.liferay.portal.kernel.model.WorkflowedModel
void setStatusByUserName(java.lang.String statusByUserName)
setStatusByUserName
in interface com.liferay.portal.kernel.model.WorkflowedModel
statusByUserName
- the status by user name of this sxp blueprintjava.util.Date getStatusDate()
getStatusDate
in interface com.liferay.portal.kernel.model.WorkflowedModel
void setStatusDate(java.util.Date statusDate)
setStatusDate
in interface com.liferay.portal.kernel.model.WorkflowedModel
statusDate
- the status date of this sxp blueprintboolean isApproved()
true
if this sxp blueprint is approved.isApproved
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is approved; false
otherwiseboolean isDenied()
true
if this sxp blueprint is denied.isDenied
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is denied; false
otherwiseboolean isDraft()
true
if this sxp blueprint is a draft.isDraft
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is a draft; false
otherwiseboolean isExpired()
true
if this sxp blueprint is expired.isExpired
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is expired; false
otherwiseboolean isInactive()
true
if this sxp blueprint is inactive.isInactive
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is inactive; false
otherwiseboolean isIncomplete()
true
if this sxp blueprint is incomplete.isIncomplete
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is incomplete; false
otherwiseboolean isPending()
true
if this sxp blueprint is pending.isPending
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is pending; false
otherwiseboolean isScheduled()
true
if this sxp blueprint is scheduled.isScheduled
in interface com.liferay.portal.kernel.model.WorkflowedModel
true
if this sxp blueprint is scheduled; false
otherwisejava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface com.liferay.portal.kernel.model.LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface com.liferay.portal.kernel.model.LocalizedModel
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
SXPBlueprint cloneWithOriginalValues()
cloneWithOriginalValues
in interface com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>