Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface PermissionModel

All Superinterfaces:
BaseModel<Permission>, ClassedModel, Cloneable, Comparable<Permission>, Serializable
All Known Subinterfaces:
Permission
All Known Implementing Classes:
PermissionWrapper

public interface PermissionModel
extends BaseModel<Permission>

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

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

See Also:
Permission, PermissionImpl, PermissionModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Permission permission)
           
 String getActionId()
          Returns the action ID of this permission.
 long getCompanyId()
          Returns the company ID of this permission.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getPermissionId()
          Returns the permission ID of this permission.
 long getPrimaryKey()
          Returns the primary key of this permission.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getResourceId()
          Returns the resource ID of this permission.
 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 setActionId(String actionId)
          Sets the action ID of this permission.
 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 permission.
 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 setPermissionId(long permissionId)
          Sets the permission ID of this permission.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this permission.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setResourceId(long resourceId)
          Sets the resource ID of this permission.
 CacheModel<Permission> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Permission toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Permission 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 permission.

Returns:
the primary key of this permission

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this permission

getPermissionId

long getPermissionId()
Returns the permission ID of this permission.

Returns:
the permission ID of this permission

setPermissionId

void setPermissionId(long permissionId)
Sets the permission ID of this permission.

Parameters:
permissionId - the permission ID of this permission

getCompanyId

long getCompanyId()
Returns the company ID of this permission.

Returns:
the company ID of this permission

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this permission.

Parameters:
companyId - the company ID of this permission

getActionId

@AutoEscape
String getActionId()
Returns the action ID of this permission.

Returns:
the action ID of this permission

setActionId

void setActionId(String actionId)
Sets the action ID of this permission.

Parameters:
actionId - the action ID of this permission

getResourceId

long getResourceId()
Returns the resource ID of this permission.

Returns:
the resource ID of this permission

setResourceId

void setResourceId(long resourceId)
Sets the resource ID of this permission.

Parameters:
resourceId - the resource ID of this permission

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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
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<Permission>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(Permission permission)
Specified by:
compareTo in interface Comparable<Permission>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

Permission 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<Permission>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

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

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<Permission>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3