com.liferay.portlet.journal.model
Interface JournalStructureModel

All Superinterfaces:

AuditedModel, BaseModel<JournalStructure>, ClassedModel, Cloneable, Comparable<JournalStructure>, GroupedModel, Serializable

All Known Subinterfaces:

JournalStructure

All Known Implementing Classes:

JournalStructureBaseImpl, JournalStructureImpl, JournalStructureModelImpl, JournalStructureWrapper

public interface JournalStructureModel
extends BaseModel<JournalStructure>, GroupedModel

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

This interface and its corresponding implementation JournalStructureModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in JournalStructureImpl.

See Also:

JournalStructure, JournalStructureImpl, JournalStructureModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(JournalStructure journalStructure)
long	getCompanyId() Returns the company ID of this journal structure.
Date	getCreateDate() Returns the create date of this journal structure.
String	getDescription() Returns the description of this journal structure.
String	getDescription(Locale locale) Returns the localized description of this journal structure in the language.
String	getDescription(Locale locale, boolean useDefault) Returns the localized description of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
String	getDescription(String languageId) Returns the localized description of this journal structure in the language.
String	getDescription(String languageId, boolean useDefault) Returns the localized description of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
String	getDescriptionCurrentLanguageId()
String	getDescriptionCurrentValue()
Map<Locale,String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this journal structure.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getGroupId() Returns the group ID of this journal structure.
long	getId() Returns the ID of this journal structure.
Date	getModifiedDate() Returns the modified date of this journal structure.
String	getName() Returns the name of this journal structure.
String	getName(Locale locale) Returns the localized name of this journal structure in the language.
String	getName(Locale locale, boolean useDefault) Returns the localized name of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
String	getName(String languageId) Returns the localized name of this journal structure in the language.
String	getName(String languageId, boolean useDefault) Returns the localized name of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
String	getNameCurrentLanguageId()
String	getNameCurrentValue()
Map<Locale,String>	getNameMap() Returns a map of the locales and localized names of this journal structure.
String	getParentStructureId() Returns the parent structure ID of this journal structure.
long	getPrimaryKey() Returns the primary key of this journal structure.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
String	getStructureId() Returns the structure ID of this journal structure.
long	getUserId() Returns the user ID of this journal structure.
String	getUserName() Returns the user name of this journal structure.
String	getUserUuid() Returns the user uuid of this journal structure.
String	getUuid() Returns the uuid of this journal structure.
String	getXsd() Returns the xsd of this journal structure.
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	prepareLocalizedFieldsForImport(Locale defaultImportLocale)
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCompanyId(long companyId) Sets the company ID of this journal structure.
void	setCreateDate(Date createDate) Sets the create date of this journal structure.
void	setDescription(String description) Sets the description of this journal structure.
void	setDescription(String description, Locale locale) Sets the localized description of this journal structure in the language.
void	setDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this journal structure in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(String languageId)
void	setDescriptionMap(Map<Locale,String> descriptionMap) Sets the localized descriptions of this journal structure from the map of locales and localized descriptions.
void	setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this journal structure from the map of locales and localized descriptions, and sets the default locale.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setGroupId(long groupId) Sets the group ID of this journal structure.
void	setId(long id) Sets the ID of this journal structure.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this journal structure.
void	setName(String name) Sets the name of this journal structure.
void	setName(String name, Locale locale) Sets the localized name of this journal structure in the language.
void	setName(String name, Locale locale, Locale defaultLocale) Sets the localized name of this journal structure in the language, and sets the default locale.
void	setNameCurrentLanguageId(String languageId)
void	setNameMap(Map<Locale,String> nameMap) Sets the localized names of this journal structure from the map of locales and localized names.
void	setNameMap(Map<Locale,String> nameMap, Locale defaultLocale) Sets the localized names of this journal structure from the map of locales and localized names, and sets the default locale.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentStructureId(String parentStructureId) Sets the parent structure ID of this journal structure.
void	setPrimaryKey(long primaryKey) Sets the primary key of this journal structure.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setStructureId(String structureId) Sets the structure ID of this journal structure.
void	setUserId(long userId) Sets the user ID of this journal structure.
void	setUserName(String userName) Sets the user name of this journal structure.
void	setUserUuid(String userUuid) Sets the user uuid of this journal structure.
void	setUuid(String uuid) Sets the uuid of this journal structure.
void	setXsd(String xsd) Sets the xsd of this journal structure.
CacheModel<JournalStructure>	toCacheModel() Returns a cache model object for this entity used by entity cache.
JournalStructure	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
JournalStructure	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this journal structure.

Returns:

the primary key of this journal structure

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this journal structure.

Parameters:

primaryKey - the primary key of this journal structure

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this journal structure.

Returns:

the uuid of this journal structure

setUuid

void setUuid(String uuid)

Sets the uuid of this journal structure.

Parameters:

uuid - the uuid of this journal structure

getId

long getId()

Returns the ID of this journal structure.

Returns:

the ID of this journal structure

setId

void setId(long id)

Sets the ID of this journal structure.

Parameters:

id - the ID of this journal structure

getGroupId

long getGroupId()

Returns the group ID of this journal structure.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this journal structure

setGroupId

void setGroupId(long groupId)

Sets the group ID of this journal structure.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this journal structure

getCompanyId

long getCompanyId()

Returns the company ID of this journal structure.

Specified by:

getCompanyId in interface AuditedModel

Returns:

the company ID of this journal structure

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this journal structure.

Specified by:

setCompanyId in interface AuditedModel

Parameters:

companyId - the company ID of this journal structure

getUserId

long getUserId()

Returns the user ID of this journal structure.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this journal structure

setUserId

void setUserId(long userId)

Sets the user ID of this journal structure.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this journal structure

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this journal structure.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this journal structure

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this journal structure.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this journal structure

getUserName

@AutoEscape
String getUserName()

Returns the user name of this journal structure.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this journal structure

setUserName

void setUserName(String userName)

Sets the user name of this journal structure.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this journal structure

getCreateDate

Date getCreateDate()

Returns the create date of this journal structure.

Specified by:

getCreateDate in interface AuditedModel

Returns:

the create date of this journal structure

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this journal structure.

Specified by:

setCreateDate in interface AuditedModel

Parameters:

createDate - the create date of this journal structure

getModifiedDate

Date getModifiedDate()

Returns the modified date of this journal structure.

Specified by:

getModifiedDate in interface AuditedModel

Returns:

the modified date of this journal structure

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this journal structure.

Specified by:

setModifiedDate in interface AuditedModel

Parameters:

modifiedDate - the modified date of this journal structure

getStructureId

String getStructureId()

Returns the structure ID of this journal structure.

Returns:

the structure ID of this journal structure

setStructureId

void setStructureId(String structureId)

Sets the structure ID of this journal structure.

Parameters:

structureId - the structure ID of this journal structure

getParentStructureId

@AutoEscape
String getParentStructureId()

Returns the parent structure ID of this journal structure.

Returns:

the parent structure ID of this journal structure

setParentStructureId

void setParentStructureId(String parentStructureId)

Sets the parent structure ID of this journal structure.

Parameters:

parentStructureId - the parent structure ID of this journal structure

getName

String getName()

Returns the name of this journal structure.

Returns:

the name of this journal structure

getName

@AutoEscape
String getName(Locale locale)

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

getName

@AutoEscape
String getName(Locale locale,
                          boolean useDefault)

Returns the localized name of this journal structure 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 journal structure. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
String getName(String languageId)

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

getName

@AutoEscape
String getName(String languageId,
                          boolean useDefault)

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

getNameCurrentLanguageId

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

Map<Locale,String> getNameMap()

Returns a map of the locales and localized names of this journal structure.

Returns:

the locales and localized names of this journal structure

setName

void setName(String name)

Sets the name of this journal structure.

Parameters:

name - the name of this journal structure

setName

void setName(String name,
             Locale locale)

Sets the localized name of this journal structure in the language.

Parameters:

name - the localized name of this journal structure

locale - the locale of the language

setName

void setName(String name,
             Locale locale,
             Locale defaultLocale)

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

Parameters:

name - the localized name of this journal structure

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(String languageId)

setNameMap

void setNameMap(Map<Locale,String> nameMap)

Sets the localized names of this journal structure from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this journal structure

setNameMap

void setNameMap(Map<Locale,String> nameMap,
                Locale defaultLocale)

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

Parameters:

nameMap - the locales and localized names of this journal structure

defaultLocale - the default locale

getDescription

String getDescription()

Returns the description of this journal structure.

Returns:

the description of this journal structure

getDescription

@AutoEscape
String getDescription(Locale locale)

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

getDescription

@AutoEscape
String getDescription(Locale locale,
                                 boolean useDefault)

Returns the localized description of this journal structure 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 journal structure. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
String getDescription(String languageId)

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

getDescription

@AutoEscape
String getDescription(String languageId,
                                 boolean useDefault)

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

getDescriptionCurrentLanguageId

@AutoEscape
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this journal structure.

Returns:

the locales and localized descriptions of this journal structure

setDescription

void setDescription(String description)

Sets the description of this journal structure.

Parameters:

description - the description of this journal structure

setDescription

void setDescription(String description,
                    Locale locale)

Sets the localized description of this journal structure in the language.

Parameters:

description - the localized description of this journal structure

locale - the locale of the language

setDescription

void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)

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

Parameters:

description - the localized description of this journal structure

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(String languageId)

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)

Sets the localized descriptions of this journal structure from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this journal structure

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)

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

Parameters:

descriptionMap - the locales and localized descriptions of this journal structure

defaultLocale - the default locale

getXsd

@AutoEscape
String getXsd()

Returns the xsd of this journal structure.

Returns:

the xsd of this journal structure

setXsd

void setXsd(String xsd)

Sets the xsd of this journal structure.

Parameters:

xsd - the xsd of this journal structure

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<JournalStructure>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<JournalStructure>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<JournalStructure>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<JournalStructure>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<JournalStructure>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<JournalStructure>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<JournalStructure>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<JournalStructure>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<JournalStructure>

Parameters:

serviceContext - the service context

See Also:

ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException

Throws:

LocaleException

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<JournalStructure>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(JournalStructure journalStructure)

Specified by:

compareTo in interface Comparable<JournalStructure>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<JournalStructure> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<JournalStructure>

Returns:

the cache model object

toEscapedModel

JournalStructure toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<JournalStructure>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

JournalStructure toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<JournalStructure>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<JournalStructure>

Returns:

the XML representation of this model instance