@ProviderType public interface CampaignModel extends com.liferay.portal.kernel.model.BaseModel<Campaign>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
This interface and its corresponding implementation com.liferay.content.targeting.model.impl.CampaignModelImpl
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.content.targeting.model.impl.CampaignImpl
.
Campaign
,
com.liferay.content.targeting.model.impl.CampaignImpl
,
com.liferay.content.targeting.model.impl.CampaignModelImpl
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
int |
compareTo(Campaign campaign) |
boolean |
getActive()
Returns the active of this campaign.
|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCampaignId()
Returns the campaign ID of this campaign.
|
long |
getCompanyId()
Returns the company ID of this campaign.
|
java.util.Date |
getCreateDate()
Returns the create date of this campaign.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this campaign.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this campaign in the language.
|
java.lang.String |
getDescription(java.util.Locale locale,
boolean useDefault)
Returns the localized description of this campaign 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 campaign in the language.
|
java.lang.String |
getDescription(java.lang.String languageId,
boolean useDefault)
Returns the localized description of this campaign 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 campaign.
|
java.util.Date |
getEndDate()
Returns the end date of this campaign.
|
com.liferay.expando.kernel.model.ExpandoBridge |
getExpandoBridge() |
long |
getGroupId()
Returns the group ID of this campaign.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this campaign.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this campaign.
|
java.lang.String |
getName()
Returns the name of this campaign.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this campaign in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this campaign in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getName(java.lang.String languageId)
Returns the localized name of this campaign in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this campaign in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getNameCurrentLanguageId() |
java.lang.String |
getNameCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getNameMap()
Returns a map of the locales and localized names of this campaign.
|
long |
getPrimaryKey()
Returns the primary key of this campaign.
|
java.io.Serializable |
getPrimaryKeyObj() |
int |
getPriority()
Returns the priority of this campaign.
|
java.util.Date |
getStartDate()
Returns the start date of this campaign.
|
java.lang.String |
getTimeZoneId()
Returns the time zone ID of this campaign.
|
long |
getUserId()
Returns the user ID of this campaign.
|
java.lang.String |
getUserName()
Returns the user name of this campaign.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this campaign.
|
java.lang.String |
getUuid()
Returns the uuid of this campaign.
|
int |
hashCode() |
boolean |
isActive()
Returns
true if this campaign is active. |
boolean |
isCachedModel() |
boolean |
isEscapedModel() |
boolean |
isNew() |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setActive(boolean active)
Sets whether this campaign is active.
|
void |
setCachedModel(boolean cachedModel) |
void |
setCampaignId(long campaignId)
Sets the campaign ID of this campaign.
|
void |
setCompanyId(long companyId)
Sets the company ID of this campaign.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this campaign.
|
void |
setDescription(java.lang.String description)
Sets the description of this campaign.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this campaign in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this campaign 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 campaign 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 campaign from the map of locales and localized descriptions, and sets the default locale.
|
void |
setEndDate(java.util.Date endDate)
Sets the end date of this campaign.
|
void |
setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel) |
void |
setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge) |
void |
setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext) |
void |
setGroupId(long groupId)
Sets the group ID of this campaign.
|
void |
setLastPublishDate(java.util.Date lastPublishDate)
Sets the last publish date of this campaign.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this campaign.
|
void |
setName(java.lang.String name)
Sets the name of this campaign.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this campaign in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this campaign in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(java.lang.String languageId) |
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
Sets the localized names of this campaign from the map of locales and localized names.
|
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
Sets the localized names of this campaign from the map of locales and localized names, and sets the default locale.
|
void |
setNew(boolean n) |
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this campaign.
|
void |
setPrimaryKeyObj(java.io.Serializable primaryKeyObj) |
void |
setPriority(int priority)
Sets the priority of this campaign.
|
void |
setStartDate(java.util.Date startDate)
Sets the start date of this campaign.
|
void |
setTimeZoneId(java.lang.String timeZoneId)
Sets the time zone ID of this campaign.
|
void |
setUserId(long userId)
Sets the user ID of this campaign.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this campaign.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this campaign.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this campaign.
|
com.liferay.portal.kernel.model.CacheModel<Campaign> |
toCacheModel() |
Campaign |
toEscapedModel() |
java.lang.String |
toString() |
Campaign |
toUnescapedModel() |
java.lang.String |
toXmlString() |
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this campaign@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 campaignlong getCampaignId()
void setCampaignId(long campaignId)
campaignId
- the campaign ID of this campaignlong getGroupId()
getGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
void setGroupId(long groupId)
setGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
groupId
- the group ID of this campaignlong 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 campaignlong 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 campaignjava.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 campaign@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 campaignjava.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 campaignjava.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 campaignjava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getName(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 getName(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getName(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 getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name
- the name of this campaignvoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this campaignlocale
- the locale of the languagevoid setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale)
name
- the localized name of this campaignlocale
- the locale of the languagedefaultLocale
- the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap
- the locales and localized names of this campaignvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this campaigndefaultLocale
- the default localejava.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 campaignvoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this campaignlocale
- the locale of the languagevoid setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale)
description
- the localized description of this campaignlocale
- 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 campaignvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this campaigndefaultLocale
- the default localejava.util.Date getStartDate()
void setStartDate(java.util.Date startDate)
startDate
- the start date of this campaignjava.util.Date getEndDate()
void setEndDate(java.util.Date endDate)
endDate
- the end date of this campaign@AutoEscape java.lang.String getTimeZoneId()
void setTimeZoneId(java.lang.String timeZoneId)
timeZoneId
- the time zone ID of this campaignint getPriority()
void setPriority(int priority)
priority
- the priority of this campaignboolean getActive()
boolean isActive()
true
if this campaign is active.true
if this campaign is active; false
otherwisevoid setActive(boolean active)
active
- the active of this campaignjava.util.Date getLastPublishDate()
getLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
void setLastPublishDate(java.util.Date lastPublishDate)
setLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
lastPublishDate
- the last publish date of this campaignboolean isNew()
isNew
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
void setNew(boolean n)
setNew
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
boolean isCachedModel()
isCachedModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
void setCachedModel(boolean cachedModel)
setCachedModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
boolean isEscapedModel()
isEscapedModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
java.io.Serializable getPrimaryKeyObj()
getPrimaryKeyObj
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
getPrimaryKeyObj
in interface com.liferay.portal.kernel.model.ClassedModel
void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
setPrimaryKeyObj
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
setPrimaryKeyObj
in interface com.liferay.portal.kernel.model.ClassedModel
com.liferay.expando.kernel.model.ExpandoBridge getExpandoBridge()
getExpandoBridge
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
getExpandoBridge
in interface com.liferay.portal.kernel.model.ClassedModel
void setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
void setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
void setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
java.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
java.lang.Object clone()
clone
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
clone
in interface com.liferay.portal.kernel.model.StagedModel
int compareTo(Campaign campaign)
compareTo
in interface java.lang.Comparable<Campaign>
int hashCode()
hashCode
in class java.lang.Object
com.liferay.portal.kernel.model.CacheModel<Campaign> toCacheModel()
toCacheModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
Campaign toEscapedModel()
toEscapedModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
Campaign toUnescapedModel()
toUnescapedModel
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>
java.lang.String toString()
toString
in class java.lang.Object
java.lang.String toXmlString()
toXmlString
in interface com.liferay.portal.kernel.model.BaseModel<Campaign>