Package com.liferay.commerce.model
Interface CommerceOrderTypeModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<CommerceOrderType>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<CommerceOrderType>,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:
CommerceOrderType
- All Known Implementing Classes:
CommerceOrderTypeWrapper
@ProviderType
public interface CommerceOrderTypeModel
extends com.liferay.portal.kernel.model.BaseModel<CommerceOrderType>, 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 CommerceOrderType service. Represents a row in the "CommerceOrderType" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.commerce.model.impl.CommerceOrderTypeModelImpl 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.commerce.model.impl.CommerceOrderTypeImpl.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the active of this commerce order type.String[]longReturns the commerce order type ID of this commerce order type.longReturns the company ID of this commerce order type.Returns the create date of this commerce order type.Returns the description of this commerce order type.getDescription(String languageId) Returns the localized description of this commerce order type in the language.getDescription(String languageId, boolean useDefault) Returns the localized description of this commerce order type 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 commerce order type in the language.getDescription(Locale locale, boolean useDefault) Returns the localized description of this commerce order type 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 commerce order type.Returns the display date of this commerce order type.intReturns the display order of this commerce order type.Returns the expiration date of this commerce order type.Returns the external reference code of this commerce order type.Returns the last publish date of this commerce order type.Returns the modified date of this commerce order type.longReturns the mvcc version of this commerce order type.getName()Returns the name of this commerce order type.Returns the localized name of this commerce order type in the language.Returns the localized name of this commerce order type in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this commerce order type in the language.Returns the localized name of this commerce order type 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 commerce order type.longReturns the primary key of this commerce order type.intReturns the status of this commerce order type.longReturns the status by user ID of this commerce order type.Returns the status by user name of this commerce order type.Returns the status by user uuid of this commerce order type.Returns the status date of this commerce order type.longReturns the user ID of this commerce order type.Returns the user name of this commerce order type.Returns the user uuid of this commerce order type.getUuid()Returns the uuid of this commerce order type.booleanisActive()Returnstrueif this commerce order type is active.booleanReturnstrueif this commerce order type is approved.booleanisDenied()Returnstrueif this commerce order type is denied.booleanisDraft()Returnstrueif this commerce order type is a draft.booleanReturnstrueif this commerce order type is expired.booleanReturnstrueif this commerce order type is inactive.booleanReturnstrueif this commerce order type is incomplete.booleanReturnstrueif this commerce order type is pending.booleanReturnstrueif this commerce order type is scheduled.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetActive(boolean active) Sets whether this commerce order type is active.voidsetCommerceOrderTypeId(long commerceOrderTypeId) Sets the commerce order type ID of this commerce order type.voidsetCompanyId(long companyId) Sets the company ID of this commerce order type.voidsetCreateDate(Date createDate) Sets the create date of this commerce order type.voidsetDescription(String description) Sets the description of this commerce order type.voidsetDescription(String description, Locale locale) Sets the localized description of this commerce order type in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this commerce order type in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this commerce order type from the map of locales and localized descriptions.voidsetDescriptionMap(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this commerce order type from the map of locales and localized descriptions, and sets the default locale.voidsetDisplayDate(Date displayDate) Sets the display date of this commerce order type.voidsetDisplayOrder(int displayOrder) Sets the display order of this commerce order type.voidsetExpirationDate(Date expirationDate) Sets the expiration date of this commerce order type.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this commerce order type.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this commerce order type.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this commerce order type.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this commerce order type.voidSets the name of this commerce order type.voidSets the localized name of this commerce order type in the language.voidSets the localized name of this commerce order type in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this commerce order type from the map of locales and localized names.voidsetNameMap(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this commerce order type from the map of locales and localized names, and sets the default locale.voidsetPrimaryKey(long primaryKey) Sets the primary key of this commerce order type.voidsetStatus(int status) Sets the status of this commerce order type.voidsetStatusByUserId(long statusByUserId) Sets the status by user ID of this commerce order type.voidsetStatusByUserName(String statusByUserName) Sets the status by user name of this commerce order type.voidsetStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this commerce order type.voidsetStatusDate(Date statusDate) Sets the status date of this commerce order type.voidsetUserId(long userId) Sets the user ID of this commerce order type.voidsetUserName(String userName) Sets the user name of this commerce order type.voidsetUserUuid(String userUuid) Sets the user uuid of this commerce order type.voidSets the uuid of this commerce order type.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 commerce order type.- Returns:
- the primary key of this commerce order type
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this commerce order type.- Parameters:
primaryKey- the primary key of this commerce order type
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this commerce order type.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this commerce order type
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this commerce order type.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this commerce order type
-
getUuid
Returns the uuid of this commerce order type.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this commerce order type
-
setUuid
Sets the uuid of this commerce order type.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this commerce order type
-
getExternalReferenceCode
Returns the external reference code of this commerce order type.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this commerce order type
-
setExternalReferenceCode
Sets the external reference code of this commerce order type.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this commerce order type
-
getCommerceOrderTypeId
long getCommerceOrderTypeId()Returns the commerce order type ID of this commerce order type.- Returns:
- the commerce order type ID of this commerce order type
-
setCommerceOrderTypeId
void setCommerceOrderTypeId(long commerceOrderTypeId) Sets the commerce order type ID of this commerce order type.- Parameters:
commerceOrderTypeId- the commerce order type ID of this commerce order type
-
getCompanyId
long getCompanyId()Returns the company ID of this commerce order type.- 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 commerce order type
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this commerce order type.- 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 commerce order type
-
getUserId
long getUserId()Returns the user ID of this commerce order type.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this commerce order type
-
setUserId
void setUserId(long userId) Sets the user ID of this commerce order type.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this commerce order type
-
getUserUuid
String getUserUuid()Returns the user uuid of this commerce order type.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this commerce order type
-
setUserUuid
Sets the user uuid of this commerce order type.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this commerce order type
-
getUserName
Returns the user name of this commerce order type.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this commerce order type
-
setUserName
Sets the user name of this commerce order type.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this commerce order type
-
getCreateDate
Date getCreateDate()Returns the create date of this commerce order type.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this commerce order type
-
setCreateDate
Sets the create date of this commerce order type.- 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 commerce order type
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this commerce order type.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this commerce order type
-
setModifiedDate
Sets the modified date of this commerce order type.- 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 commerce order type
-
getName
String getName()Returns the name of this commerce order type.- Returns:
- the name of this commerce order type
-
getName
Returns the localized name of this commerce order type 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 commerce order type
-
getName
Returns the localized name of this commerce order type 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 commerce order type. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this commerce order type 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 commerce order type
-
getName
Returns the localized name of this commerce order type 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 commerce order type
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this commerce order type.- Returns:
- the locales and localized names of this commerce order type
-
setName
Sets the name of this commerce order type.- Parameters:
name- the name of this commerce order type
-
setName
Sets the localized name of this commerce order type in the language.- Parameters:
name- the localized name of this commerce order typelocale- the locale of the language
-
setName
Sets the localized name of this commerce order type in the language, and sets the default locale.- Parameters:
name- the localized name of this commerce order typelocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this commerce order type from the map of locales and localized names.- Parameters:
nameMap- the locales and localized names of this commerce order type
-
setNameMap
Sets the localized names of this commerce order type from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap- the locales and localized names of this commerce order typedefaultLocale- the default locale
-
getDescription
String getDescription()Returns the description of this commerce order type.- Returns:
- the description of this commerce order type
-
getDescription
Returns the localized description of this commerce order type 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 commerce order type
-
getDescription
Returns the localized description of this commerce order type 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 commerce order type. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this commerce order type 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 commerce order type
-
getDescription
Returns the localized description of this commerce order type 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 commerce order type
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this commerce order type.- Returns:
- the locales and localized descriptions of this commerce order type
-
setDescription
Sets the description of this commerce order type.- Parameters:
description- the description of this commerce order type
-
setDescription
Sets the localized description of this commerce order type in the language.- Parameters:
description- the localized description of this commerce order typelocale- the locale of the language
-
setDescription
Sets the localized description of this commerce order type in the language, and sets the default locale.- Parameters:
description- the localized description of this commerce order typelocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this commerce order type from the map of locales and localized descriptions.- Parameters:
descriptionMap- the locales and localized descriptions of this commerce order type
-
setDescriptionMap
Sets the localized descriptions of this commerce order type from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap- the locales and localized descriptions of this commerce order typedefaultLocale- the default locale
-
getActive
boolean getActive()Returns the active of this commerce order type.- Returns:
- the active of this commerce order type
-
isActive
boolean isActive()Returnstrueif this commerce order type is active.- Returns:
trueif this commerce order type is active;falseotherwise
-
setActive
void setActive(boolean active) Sets whether this commerce order type is active.- Parameters:
active- the active of this commerce order type
-
getDisplayDate
Date getDisplayDate()Returns the display date of this commerce order type.- Returns:
- the display date of this commerce order type
-
setDisplayDate
Sets the display date of this commerce order type.- Parameters:
displayDate- the display date of this commerce order type
-
getDisplayOrder
int getDisplayOrder()Returns the display order of this commerce order type.- Returns:
- the display order of this commerce order type
-
setDisplayOrder
void setDisplayOrder(int displayOrder) Sets the display order of this commerce order type.- Parameters:
displayOrder- the display order of this commerce order type
-
getExpirationDate
Date getExpirationDate()Returns the expiration date of this commerce order type.- Returns:
- the expiration date of this commerce order type
-
setExpirationDate
Sets the expiration date of this commerce order type.- Parameters:
expirationDate- the expiration date of this commerce order type
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this commerce order type.- Returns:
- the last publish date of this commerce order type
-
setLastPublishDate
Sets the last publish date of this commerce order type.- Parameters:
lastPublishDate- the last publish date of this commerce order type
-
getStatus
int getStatus()Returns the status of this commerce order type.- Specified by:
getStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status of this commerce order type
-
setStatus
void setStatus(int status) Sets the status of this commerce order type.- Specified by:
setStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
status- the status of this commerce order type
-
getStatusByUserId
long getStatusByUserId()Returns the status by user ID of this commerce order type.- Specified by:
getStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user ID of this commerce order type
-
setStatusByUserId
void setStatusByUserId(long statusByUserId) Sets the status by user ID of this commerce order type.- Specified by:
setStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserId- the status by user ID of this commerce order type
-
getStatusByUserUuid
String getStatusByUserUuid()Returns the status by user uuid of this commerce order type.- Specified by:
getStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user uuid of this commerce order type
-
setStatusByUserUuid
Sets the status by user uuid of this commerce order type.- Specified by:
setStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserUuid- the status by user uuid of this commerce order type
-
getStatusByUserName
Returns the status by user name of this commerce order type.- Specified by:
getStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user name of this commerce order type
-
setStatusByUserName
Sets the status by user name of this commerce order type.- Specified by:
setStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserName- the status by user name of this commerce order type
-
getStatusDate
Date getStatusDate()Returns the status date of this commerce order type.- Specified by:
getStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status date of this commerce order type
-
setStatusDate
Sets the status date of this commerce order type.- Specified by:
setStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusDate- the status date of this commerce order type
-
isApproved
boolean isApproved()Returnstrueif this commerce order type is approved.- Specified by:
isApprovedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is approved;falseotherwise
-
isDenied
boolean isDenied()Returnstrueif this commerce order type is denied.- Specified by:
isDeniedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is denied;falseotherwise
-
isDraft
boolean isDraft()Returnstrueif this commerce order type is a draft.- Specified by:
isDraftin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is a draft;falseotherwise
-
isExpired
boolean isExpired()Returnstrueif this commerce order type is expired.- Specified by:
isExpiredin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is expired;falseotherwise
-
isInactive
boolean isInactive()Returnstrueif this commerce order type is inactive.- Specified by:
isInactivein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is inactive;falseotherwise
-
isIncomplete
boolean isIncomplete()Returnstrueif this commerce order type is incomplete.- Specified by:
isIncompletein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is incomplete;falseotherwise
-
isPending
boolean isPending()Returnstrueif this commerce order type is pending.- Specified by:
isPendingin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type is pending;falseotherwise
-
isScheduled
boolean isScheduled()Returnstrueif this commerce order type is scheduled.- Specified by:
isScheduledin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this commerce order type 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
CommerceOrderType cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<CommerceOrderType>
-
toXmlString
-