com.liferay.portal.model
Interface PermissionModel

All Superinterfaces:

BaseModel<Permission>, Cloneable, Comparable<Permission>, Serializable

All Known Subinterfaces:

Permission

All Known Implementing Classes:

PermissionImpl, PermissionModelImpl, 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.

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

See Also:

Permission, PermissionImpl, PermissionModelImpl

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(Permission permission)
String	getActionId() Gets the action id of this permission.
long	getCompanyId() Gets the company id of this permission.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getPermissionId() Gets the permission id of this permission.
long	getPrimaryKey() Gets the primary key of this permission.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getResourceId() Gets the resource id of this permission.
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	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	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	setPermissionId(long permissionId) Sets the permission id of this permission.
void	setPrimaryKey(long pk) Sets the primary key of this permission
void	setResourceId(long resourceId) Sets the resource id of this permission.
Permission	toEscapedModel() Gets a copy of this permission 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 permission.

Returns:

the primary key of this permission

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this permission

Parameters:

pk - the primary key of this permission

getPermissionId

long getPermissionId()

Gets 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()

Gets 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()

Gets 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()

Gets 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

toEscapedModel

Permission toEscapedModel()

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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Permission>

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

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

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

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

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

Returns:

the XML representation of this model instance