com.liferay.portal.reports.engine.console.model

Interface DefinitionModel

All Superinterfaces:

AuditedModel, BaseModel<Definition>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Definition>, GroupedModel, LocalizedModel, java.io.Serializable, ShardedModel, StagedGroupedModel, StagedModel

All Known Subinterfaces:

Definition

All Known Implementing Classes:

DefinitionWrapper

@ProviderType
public interface DefinitionModel
extends BaseModel<Definition>, LocalizedModel, ShardedModel, StagedGroupedModel

The base model interface for the Definition service. Represents a row in the "Reports_Definition" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.reports.engine.console.model.impl.DefinitionModelImpl 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.portal.reports.engine.console.model.impl.DefinitionImpl.

See Also:

Definition

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this definition.
java.util.Date	getCreateDate() Returns the create date of this definition.
java.lang.String	getDefaultLanguageId()
long	getDefinitionId() Returns the definition ID of this definition.
java.lang.String	getDescription() Returns the description of this definition.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this definition in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this definition 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 definition in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this definition 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 definition.
long	getGroupId() Returns the group ID of this definition.
java.util.Date	getLastPublishDate() Returns the last publish date of this definition.
java.util.Date	getModifiedDate() Returns the modified date of this definition.
java.lang.String	getName() Returns the name of this definition.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this definition in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this definition 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 definition in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this definition 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 definition.
long	getPrimaryKey() Returns the primary key of this definition.
java.lang.String	getReportName() Returns the report name of this definition.
java.lang.String	getReportParameters() Returns the report parameters of this definition.
long	getSourceId() Returns the source ID of this definition.
long	getUserId() Returns the user ID of this definition.
java.lang.String	getUserName() Returns the user name of this definition.
java.lang.String	getUserUuid() Returns the user uuid of this definition.
java.lang.String	getUuid() Returns the uuid of this definition.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCompanyId(long companyId) Sets the company ID of this definition.
void	setCreateDate(java.util.Date createDate) Sets the create date of this definition.
void	setDefinitionId(long definitionId) Sets the definition ID of this definition.
void	setDescription(java.lang.String description) Sets the description of this definition.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this definition in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this definition 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 definition 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 definition from the map of locales and localized descriptions, and sets the default locale.
void	setGroupId(long groupId) Sets the group ID of this definition.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this definition.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this definition.
void	setName(java.lang.String name) Sets the name of this definition.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this definition in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this definition 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 definition 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 definition from the map of locales and localized names, and sets the default locale.
void	setPrimaryKey(long primaryKey) Sets the primary key of this definition.
void	setReportName(java.lang.String reportName) Sets the report name of this definition.
void	setReportParameters(java.lang.String reportParameters) Sets the report parameters of this definition.
void	setSourceId(long sourceId) Sets the source ID of this definition.
void	setUserId(long userId) Sets the user ID of this definition.
void	setUserName(java.lang.String userName) Sets the user name of this definition.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this definition.
void	setUuid(java.lang.String uuid) Sets the uuid of this definition.

Methods 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, toUnescapedModel, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this definition.

Returns:

the primary key of this definition

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this definition.

Parameters:

primaryKey - the primary key of this definition

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this definition.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this definition

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this definition.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this definition

getDefinitionId

long getDefinitionId()

Returns the definition ID of this definition.

Returns:

the definition ID of this definition

setDefinitionId

void setDefinitionId(long definitionId)

Sets the definition ID of this definition.

Parameters:

definitionId - the definition ID of this definition

getGroupId

long getGroupId()

Returns the group ID of this definition.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this definition

setGroupId

void setGroupId(long groupId)

Sets the group ID of this definition.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this definition

getCompanyId

long getCompanyId()

Returns the company ID of this definition.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this definition

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this definition.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface ShardedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this definition

getUserId

long getUserId()

Returns the user ID of this definition.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this definition

setUserId

void setUserId(long userId)

Sets the user ID of this definition.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this definition

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this definition.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this definition

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this definition.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this definition

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this definition.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this definition

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this definition.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this definition

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this definition.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this definition

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this definition.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this definition

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this definition.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this definition

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this definition.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this definition

getName

java.lang.String getName()

Returns the name of this definition.

Returns:

the name of this definition

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale)

Returns the localized name of this definition 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 definition

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale,
                                     boolean useDefault)

Returns the localized name of this definition in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this definition. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId)

Returns the localized name of this definition 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 definition

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId,
                                     boolean useDefault)

Returns the localized name of this definition in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this definition

getNameCurrentLanguageId

@AutoEscape
java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this definition.

Returns:

the locales and localized names of this definition

setName

void setName(java.lang.String name)

Sets the name of this definition.

Parameters:

name - the name of this definition

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the localized name of this definition in the language.

Parameters:

name - the localized name of this definition

locale - the locale of the language

setName

void setName(java.lang.String name,
             java.util.Locale locale,
             java.util.Locale defaultLocale)

Sets the localized name of this definition in the language, and sets the default locale.

Parameters:

name - the localized name of this definition

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(java.lang.String languageId)

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)

Sets the localized names of this definition from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this definition

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                java.util.Locale defaultLocale)

Sets the localized names of this definition from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this definition

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this definition.

Returns:

the description of this definition

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of this definition 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 definition

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale,
                                            boolean useDefault)

Returns the localized description of this definition in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this definition. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

Returns the localized description of this definition 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 definition

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
                                            boolean useDefault)

Returns the localized description of this definition in the language, optionally using the default language if no localization exists for the requested language.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this definition

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this definition.

Returns:

the locales and localized descriptions of this definition

setDescription

void setDescription(java.lang.String description)

Sets the description of this definition.

Parameters:

description - the description of this definition

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this definition in the language.

Parameters:

description - the localized description of this definition

locale - the locale of the language

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized description of this definition in the language, and sets the default locale.

Parameters:

description - the localized description of this definition

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

Sets the localized descriptions of this definition from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this definition

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

Sets the localized descriptions of this definition from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this definition

defaultLocale - the default locale

getSourceId

long getSourceId()

Returns the source ID of this definition.

Returns:

the source ID of this definition

setSourceId

void setSourceId(long sourceId)

Sets the source ID of this definition.

Parameters:

sourceId - the source ID of this definition

getReportName

@AutoEscape
java.lang.String getReportName()

Returns the report name of this definition.

Returns:

the report name of this definition

setReportName

void setReportName(java.lang.String reportName)

Sets the report name of this definition.

Parameters:

reportName - the report name of this definition

getReportParameters

@AutoEscape
java.lang.String getReportParameters()

Returns the report parameters of this definition.

Returns:

the report parameters of this definition

setReportParameters

void setReportParameters(java.lang.String reportParameters)

Sets the report parameters of this definition.

Parameters:

reportParameters - the report parameters of this definition

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this definition.

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this definition

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this definition.

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this definition

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface LocalizedModel

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface LocalizedModel

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException