Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface ResourceModel

All Superinterfaces:
BaseModel<Resource>, ClassedModel, Cloneable, Comparable<Resource>, Serializable
All Known Subinterfaces:
Resource
All Known Implementing Classes:
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.

See Also:
Resource, ResourceImpl, ResourceModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Resource resource)
           
 long getCodeId()
          Returns the code ID of this resource.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getPrimaryKey()
          Returns the primary key of this resource.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getPrimKey()
          Returns the prim key of this resource.
 long getResourceId()
          Returns the resource ID of this resource.
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true 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 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 primaryKey)
          Sets the primary key of this resource.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setPrimKey(String primKey)
          Sets the prim key of this resource.
 void setResourceId(long resourceId)
          Sets the resource ID of this resource.
 CacheModel<Resource> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Resource toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Resource toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this resource.

Returns:
the primary key of this resource

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this resource.

Parameters:
primaryKey - the primary key of this resource

getResourceId

long getResourceId()
Returns 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()
Returns 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()
Returns 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

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true 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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Resource>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Resource>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<Resource>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Resource>
Specified by:
getExpandoBridge in interface ClassedModel
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
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

toCacheModel

CacheModel<Resource> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<Resource>
Returns:
the cache model object

toEscapedModel

Resource toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<Resource>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

Resource toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<Resource>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<Resource>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3