com.liferay.portlet.expando.model
Interface ExpandoColumnModel

All Superinterfaces:

BaseModel<ExpandoColumn>, Cloneable, Comparable<ExpandoColumn>, Serializable

All Known Subinterfaces:

ExpandoColumn

All Known Implementing Classes:

ExpandoColumnImpl, ExpandoColumnModelImpl, ExpandoColumnWrapper

public interface ExpandoColumnModel
extends BaseModel<ExpandoColumn>

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

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

Never modify or reference this interface directly. All methods that expect a expando column model instance should use the ExpandoColumn interface instead.

See Also:

ExpandoColumn, ExpandoColumnImpl, ExpandoColumnModelImpl

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(ExpandoColumn expandoColumn)
long	getColumnId() Gets the column id of this expando column.
long	getCompanyId() Gets the company id of this expando column.
String	getDefaultData() Gets the default data of this expando column.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getName() Gets the name of this expando column.
long	getPrimaryKey() Gets the primary key of this expando column.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getTableId() Gets the table id of this expando column.
int	getType() Gets the type of this expando column.
String	getTypeSettings() Gets the type settings of this expando column.
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	setColumnId(long columnId) Sets the column id of this expando column.
void	setCompanyId(long companyId) Sets the company id of this expando column.
void	setDefaultData(String defaultData) Sets the default data of this expando column.
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	setName(String name) Sets the name of this expando column.
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 expando column
void	setTableId(long tableId) Sets the table id of this expando column.
void	setType(int type) Sets the type of this expando column.
void	setTypeSettings(String typeSettings) Sets the type settings of this expando column.
ExpandoColumn	toEscapedModel() Gets a copy of this expando column 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 expando column.

Returns:

the primary key of this expando column

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this expando column

Parameters:

pk - the primary key of this expando column

getColumnId

long getColumnId()

Gets the column id of this expando column.

Returns:

the column id of this expando column

setColumnId

void setColumnId(long columnId)

Sets the column id of this expando column.

Parameters:

columnId - the column id of this expando column

getCompanyId

long getCompanyId()

Gets the company id of this expando column.

Returns:

the company id of this expando column

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this expando column.

Parameters:

companyId - the company id of this expando column

getTableId

long getTableId()

Gets the table id of this expando column.

Returns:

the table id of this expando column

setTableId

void setTableId(long tableId)

Sets the table id of this expando column.

Parameters:

tableId - the table id of this expando column

getName

@AutoEscape
String getName()

Gets the name of this expando column.

Returns:

the name of this expando column

setName

void setName(String name)

Sets the name of this expando column.

Parameters:

name - the name of this expando column

getType

int getType()

Gets the type of this expando column.

Returns:

the type of this expando column

setType

void setType(int type)

Sets the type of this expando column.

Parameters:

type - the type of this expando column

getDefaultData

@AutoEscape
String getDefaultData()

Gets the default data of this expando column.

Returns:

the default data of this expando column

setDefaultData

void setDefaultData(String defaultData)

Sets the default data of this expando column.

Parameters:

defaultData - the default data of this expando column

getTypeSettings

@AutoEscape
String getTypeSettings()

Gets the type settings of this expando column.

Returns:

the type settings of this expando column

setTypeSettings

void setTypeSettings(String typeSettings)

Sets the type settings of this expando column.

Parameters:

typeSettings - the type settings of this expando column

toEscapedModel

ExpandoColumn toEscapedModel()

Gets a copy of this expando column 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<ExpandoColumn>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(ExpandoColumn expandoColumn)

Specified by:

compareTo in interface Comparable<ExpandoColumn>

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

Returns:

the XML representation of this model instance