com.liferay.portal.model
Interface ResourceModel

All Superinterfaces:

BaseModel<Resource>, Cloneable, Comparable<Resource>, Serializable

All Known Subinterfaces:

Resource

All Known Implementing Classes:

ResourceImpl, ResourceModelImpl, ResourceWrapper

public interface ResourceModel
extends BaseModel<Resource>

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

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

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

See Also:

Resource, ResourceImpl, ResourceModelImpl

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(Resource resource)
long	getCodeId() Gets the code id of this resource.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getPrimaryKey() Gets the primary key of this resource.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getPrimKey() Gets the prim key of this resource.
long	getResourceId() Gets the resource id of this resource.
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	setCodeId(long codeId) Sets the code id of this resource.
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	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 resource
void	setPrimKey(String primKey) Sets the prim key of this resource.
void	setResourceId(long resourceId) Sets the resource id of this resource.
Resource	toEscapedModel() Gets a copy of this resource 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 resource.

Returns:

the primary key of this resource

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this resource

Parameters:

pk - the primary key of this resource

getResourceId

long getResourceId()

Gets the resource id of this resource.

Returns:

the resource id of this resource

setResourceId

void setResourceId(long resourceId)

Sets the resource id of this resource.

Parameters:

resourceId - the resource id of this resource

getCodeId

long getCodeId()

Gets the code id of this resource.

Returns:

the code id of this resource

setCodeId

void setCodeId(long codeId)

Sets the code id of this resource.

Parameters:

codeId - the code id of this resource

getPrimKey

@AutoEscape
String getPrimKey()

Gets the prim key of this resource.

Returns:

the prim key of this resource

setPrimKey

void setPrimKey(String primKey)

Sets the prim key of this resource.

Parameters:

primKey - the prim key of this resource

toEscapedModel

Resource toEscapedModel()

Gets a copy of this resource 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<Resource>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Resource resource)

Specified by:

compareTo in interface Comparable<Resource>

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

Returns:

the XML representation of this model instance