com.liferay.portlet.journal.model
Interface JournalStructureModel

All Superinterfaces:

BaseModel<JournalStructure>, Cloneable, Comparable<JournalStructure>, Serializable

All Known Subinterfaces:

JournalStructure

All Known Implementing Classes:

JournalStructureImpl, JournalStructureModelImpl, JournalStructureWrapper

public interface JournalStructureModel
extends BaseModel<JournalStructure>

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.

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

See Also:

JournalStructure, JournalStructureImpl, JournalStructureModelImpl

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(JournalStructure journalStructure)
long	getCompanyId() Gets the company id of this journal structure.
Date	getCreateDate() Gets the create date of this journal structure.
String	getDescription() Gets the description of this journal structure.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this journal structure.
long	getId() Gets the id of this journal structure.
Date	getModifiedDate() Gets the modified date of this journal structure.
String	getName() Gets the name of this journal structure.
String	getParentStructureId() Gets the parent structure id of this journal structure.
long	getPrimaryKey() Gets the primary key of this journal structure.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getStructureId() Gets the structure id of this journal structure.
long	getUserId() Gets the user id of this journal structure.
String	getUserName() Gets the user name of this journal structure.
String	getUserUuid() Gets the user uuid of this journal structure.
String	getUuid() Gets the uuid of this journal structure.
String	getXsd() Gets the xsd of this journal structure.
int	hashCode()
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.
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	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 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	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 pk) Sets the primary key of this journal structure
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.
JournalStructure	toEscapedModel() Gets a copy of this journal structure 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 structure.

Returns:

the primary key of this journal structure

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this journal structure

Parameters:

pk - the primary key of this journal structure

getUuid

@AutoEscape
String getUuid()

Gets 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()

Gets 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()

Gets the group id of this journal structure.

Returns:

the group id of this journal structure

setGroupId

void setGroupId(long groupId)

Sets the group id of this journal structure.

Parameters:

groupId - the group id of this journal structure

getCompanyId

long getCompanyId()

Gets the company id of this journal structure.

Returns:

the company id of this journal structure

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this journal structure.

Parameters:

companyId - the company id of this journal structure

getUserId

long getUserId()

Gets the user id of this journal structure.

Returns:

the user id of this journal structure

setUserId

void setUserId(long userId)

Sets the user id of this journal structure.

Parameters:

userId - the user id of this journal structure

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this journal structure.

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.

Parameters:

userUuid - the user uuid of this journal structure

getUserName

@AutoEscape
String getUserName()

Gets the user name of this journal structure.

Returns:

the user name of this journal structure

setUserName

void setUserName(String userName)

Sets the user name of this journal structure.

Parameters:

userName - the user name of this journal structure

getCreateDate

Date getCreateDate()

Gets the create date of this journal structure.

Returns:

the create date of this journal structure

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this journal structure.

Parameters:

createDate - the create date of this journal structure

getModifiedDate

Date getModifiedDate()

Gets the modified date of this journal structure.

Returns:

the modified date of this journal structure

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this journal structure.

Parameters:

modifiedDate - the modified date of this journal structure

getStructureId

String getStructureId()

Gets 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()

Gets 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

@AutoEscape
String getName()

Gets the name of this journal structure.

Returns:

the name of this journal structure

setName

void setName(String name)

Sets the name of this journal structure.

Parameters:

name - the name of this journal structure

getDescription

@AutoEscape
String getDescription()

Gets the description of this journal structure.

Returns:

the description of this journal structure

setDescription

void setDescription(String description)

Sets the description of this journal structure.

Parameters:

description - the description of this journal structure

getXsd

@AutoEscape
String getXsd()

Gets 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

toEscapedModel

JournalStructure toEscapedModel()

Gets a copy of this journal structure 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<JournalStructure>

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

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

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

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

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

Returns:

the XML representation of this model instance