com.liferay.portlet.journal.model
Interface JournalTemplateModel

All Superinterfaces:

BaseModel<JournalTemplate>, Cloneable, Comparable<JournalTemplate>, Serializable

All Known Subinterfaces:

JournalTemplate

All Known Implementing Classes:

JournalTemplateImpl, JournalTemplateModelImpl, JournalTemplateWrapper

public interface JournalTemplateModel
extends BaseModel<JournalTemplate>

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

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

Never modify or reference this interface directly. All methods that expect a journal template model instance should use the JournalTemplate interface instead.

See Also:

JournalTemplate, JournalTemplateImpl, JournalTemplateModelImpl

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

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(JournalTemplate journalTemplate)
boolean	getCacheable() Gets the cacheable of this journal template.
long	getCompanyId() Gets the company id of this journal template.
Date	getCreateDate() Gets the create date of this journal template.
String	getDescription() Gets the description of this journal template.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this journal template.
long	getId() Gets the id of this journal template.
String	getLangType() Gets the lang type of this journal template.
Date	getModifiedDate() Gets the modified date of this journal template.
String	getName() Gets the name of this journal template.
long	getPrimaryKey() Gets the primary key of this journal template.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
boolean	getSmallImage() Gets the small image of this journal template.
long	getSmallImageId() Gets the small image id of this journal template.
String	getSmallImageURL() Gets the small image u r l of this journal template.
String	getStructureId() Gets the structure id of this journal template.
String	getTemplateId() Gets the template id of this journal template.
long	getUserId() Gets the user id of this journal template.
String	getUserName() Gets the user name of this journal template.
String	getUserUuid() Gets the user uuid of this journal template.
String	getUuid() Gets the uuid of this journal template.
String	getXsl() Gets the xsl of this journal template.
int	hashCode()
boolean	isCacheable() Determines whether this journal template is cacheable.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isSmallImage() Determines whether this journal template is small image.
void	setCacheable(boolean cacheable) Sets whether this {$entity.humanName} is cacheable.
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 template.
void	setCreateDate(Date createDate) Sets the create date of this journal template.
void	setDescription(String description) Sets the description of this journal template.
void	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
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 template.
void	setId(long id) Sets the id of this journal template.
void	setLangType(String langType) Sets the lang type of this journal template.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this journal template.
void	setName(String name) Sets the name of this journal template.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this journal template
void	setSmallImage(boolean smallImage) Sets whether this {$entity.humanName} is small image.
void	setSmallImageId(long smallImageId) Sets the small image id of this journal template.
void	setSmallImageURL(String smallImageURL) Sets the small image u r l of this journal template.
void	setStructureId(String structureId) Sets the structure id of this journal template.
void	setTemplateId(String templateId) Sets the template id of this journal template.
void	setUserId(long userId) Sets the user id of this journal template.
void	setUserName(String userName) Sets the user name of this journal template.
void	setUserUuid(String userUuid) Sets the user uuid of this journal template.
void	setUuid(String uuid) Sets the uuid of this journal template.
void	setXsl(String xsl) Sets the xsl of this journal template.
JournalTemplate	toEscapedModel() Gets a copy of this journal template as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this journal template.

Returns:

the primary key of this journal template

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this journal template

Parameters:

pk - the primary key of this journal template

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this journal template.

Returns:

the uuid of this journal template

setUuid

void setUuid(String uuid)

Sets the uuid of this journal template.

Parameters:

uuid - the uuid of this journal template

getId

long getId()

Gets the id of this journal template.

Returns:

the id of this journal template

setId

void setId(long id)

Sets the id of this journal template.

Parameters:

id - the id of this journal template

getGroupId

long getGroupId()

Gets the group id of this journal template.

Returns:

the group id of this journal template

setGroupId

void setGroupId(long groupId)

Sets the group id of this journal template.

Parameters:

groupId - the group id of this journal template

getCompanyId

long getCompanyId()

Gets the company id of this journal template.

Returns:

the company id of this journal template

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this journal template.

Parameters:

companyId - the company id of this journal template

getUserId

long getUserId()

Gets the user id of this journal template.

Returns:

the user id of this journal template

setUserId

void setUserId(long userId)

Sets the user id of this journal template.

Parameters:

userId - the user id of this journal template

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this journal template.

Returns:

the user uuid of this journal template

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this journal template.

Parameters:

userUuid - the user uuid of this journal template

getUserName

@AutoEscape
String getUserName()

Gets the user name of this journal template.

Returns:

the user name of this journal template

setUserName

void setUserName(String userName)

Sets the user name of this journal template.

Parameters:

userName - the user name of this journal template

getCreateDate

Date getCreateDate()

Gets the create date of this journal template.

Returns:

the create date of this journal template

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this journal template.

Parameters:

createDate - the create date of this journal template

getModifiedDate

Date getModifiedDate()

Gets the modified date of this journal template.

Returns:

the modified date of this journal template

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this journal template.

Parameters:

modifiedDate - the modified date of this journal template

getTemplateId

String getTemplateId()

Gets the template id of this journal template.

Returns:

the template id of this journal template

setTemplateId

void setTemplateId(String templateId)

Sets the template id of this journal template.

Parameters:

templateId - the template id of this journal template

getStructureId

String getStructureId()

Gets the structure id of this journal template.

Returns:

the structure id of this journal template

setStructureId

void setStructureId(String structureId)

Sets the structure id of this journal template.

Parameters:

structureId - the structure id of this journal template

getName

@AutoEscape
String getName()

Gets the name of this journal template.

Returns:

the name of this journal template

setName

void setName(String name)

Sets the name of this journal template.

Parameters:

name - the name of this journal template

getDescription

@AutoEscape
String getDescription()

Gets the description of this journal template.

Returns:

the description of this journal template

setDescription

void setDescription(String description)

Sets the description of this journal template.

Parameters:

description - the description of this journal template

getXsl

@AutoEscape
String getXsl()

Gets the xsl of this journal template.

Returns:

the xsl of this journal template

setXsl

void setXsl(String xsl)

Sets the xsl of this journal template.

Parameters:

xsl - the xsl of this journal template

getLangType

@AutoEscape
String getLangType()

Gets the lang type of this journal template.

Returns:

the lang type of this journal template

setLangType

void setLangType(String langType)

Sets the lang type of this journal template.

Parameters:

langType - the lang type of this journal template

getCacheable

boolean getCacheable()

Gets the cacheable of this journal template.

Returns:

the cacheable of this journal template

isCacheable

boolean isCacheable()

Determines whether this journal template is cacheable.

Returns:

whether this journal template is cacheable

setCacheable

void setCacheable(boolean cacheable)

Sets whether this {$entity.humanName} is cacheable.

Parameters:

cacheable - the cacheable of this journal template

getSmallImage

boolean getSmallImage()

Gets the small image of this journal template.

Returns:

the small image of this journal template

isSmallImage

boolean isSmallImage()

Determines whether this journal template is small image.

Returns:

whether this journal template is small image

setSmallImage

void setSmallImage(boolean smallImage)

Sets whether this {$entity.humanName} is small image.

Parameters:

smallImage - the small image of this journal template

getSmallImageId

long getSmallImageId()

Gets the small image id of this journal template.

Returns:

the small image id of this journal template

setSmallImageId

void setSmallImageId(long smallImageId)

Sets the small image id of this journal template.

Parameters:

smallImageId - the small image id of this journal template

getSmallImageURL

@AutoEscape
String getSmallImageURL()

Gets the small image u r l of this journal template.

Returns:

the small image u r l of this journal template

setSmallImageURL

void setSmallImageURL(String smallImageURL)

Sets the small image u r l of this journal template.

Parameters:

smallImageURL - the small image u r l of this journal template

toEscapedModel

JournalTemplate toEscapedModel()

Gets a copy of this journal template as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

boolean isNew()

Description copied from interface: BaseModel

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

Specified by:

isNew in interface BaseModel<JournalTemplate>

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<JournalTemplate>

Parameters:

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

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Determines if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<JournalTemplate>

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<JournalTemplate>

Parameters:

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

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<JournalTemplate>

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<JournalTemplate>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<JournalTemplate>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<JournalTemplate>

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<JournalTemplate>

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<JournalTemplate>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(JournalTemplate journalTemplate)

Specified by:

compareTo in interface Comparable<JournalTemplate>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<JournalTemplate>

Returns:

the XML representation of this model instance