com.liferay.counter.model
Interface CounterModel

All Superinterfaces:

BaseModel<Counter>, Cloneable, Comparable<Counter>, Serializable

All Known Subinterfaces:

Counter

All Known Implementing Classes:

CounterImpl, CounterModelImpl, CounterWrapper

public interface CounterModel
extends BaseModel<Counter>

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

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

Never modify or reference this interface directly. All methods that expect a counter model instance should use the Counter interface instead.

See Also:

Counter, CounterImpl, CounterModelImpl

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(Counter counter)
long	getCurrentId() Gets the current id of this counter.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getName() Gets the name of this counter.
String	getPrimaryKey() Gets the primary key of this counter.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
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	setCurrentId(long currentId) Sets the current id of this counter.
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 counter.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(String pk) Sets the primary key of this counter
Counter	toEscapedModel() Gets a copy of this counter 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

String getPrimaryKey()

Gets the primary key of this counter.

Returns:

the primary key of this counter

setPrimaryKey

void setPrimaryKey(String pk)

Sets the primary key of this counter

Parameters:

pk - the primary key of this counter

getName

@AutoEscape
String getName()

Gets the name of this counter.

Returns:

the name of this counter

setName

void setName(String name)

Sets the name of this counter.

Parameters:

name - the name of this counter

getCurrentId

long getCurrentId()

Gets the current id of this counter.

Returns:

the current id of this counter

setCurrentId

void setCurrentId(long currentId)

Sets the current id of this counter.

Parameters:

currentId - the current id of this counter

toEscapedModel

Counter toEscapedModel()

Gets a copy of this counter 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<Counter>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Counter counter)

Specified by:

compareTo in interface Comparable<Counter>

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

Returns:

the XML representation of this model instance