com.liferay.portal.model

Class PluginSettingWrapper

java.lang.Object

com.liferay.portal.model.PluginSettingWrapper

All Implemented Interfaces:

BaseModel<PluginSetting>, ClassedModel, ModelWrapper<PluginSetting>, PersistedModel, PluginSetting, PluginSettingModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<PluginSetting>

@ProviderType
public class PluginSettingWrapper
extends java.lang.Object
implements PluginSetting, ModelWrapper<PluginSetting>

This class is a wrapper for PluginSetting.

Author:

Brian Wing Shun Chan

See Also:

PluginSetting, Serialized Form

Generated:

Constructor Summary

Constructors

Constructor and Description
PluginSettingWrapper(PluginSetting pluginSetting)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(java.lang.String role) Adds a role to the list of roles.
java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(PluginSetting pluginSetting)
boolean	equals(java.lang.Object obj)
boolean	getActive() Returns the active of this plugin setting.
long	getCompanyId() Returns the company ID of this plugin setting.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes()
java.lang.Class<?>	getModelClass()
java.lang.String	getModelClassName()
java.lang.String	getPluginId() Returns the plugin ID of this plugin setting.
long	getPluginSettingId() Returns the plugin setting ID of this plugin setting.
java.lang.String	getPluginType() Returns the plugin type of this plugin setting.
long	getPrimaryKey() Returns the primary key of this plugin setting.
java.io.Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
java.lang.String	getRoles() Returns the roles of this plugin setting.
java.lang.String[]	getRolesArray() Returns an array of required roles of the plugin.
PluginSetting	getWrappedModel()
PluginSetting	getWrappedPluginSetting() Deprecated. As of 6.1.0, replaced by getWrappedModel()
int	hashCode()
boolean	hasPermission(long userId) Returns true if the user has permission to use this plugin
boolean	hasRoleWithName(java.lang.String roleName) Returns true if the plugin has a role with the specified name.
boolean	isActive() Returns true if this plugin setting is active.
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	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	resetOriginalValues() Reset all original fields to current values.
void	setActive(boolean active) Sets whether this plugin setting is active.
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 plugin setting.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPluginId(java.lang.String pluginId) Sets the plugin ID of this plugin setting.
void	setPluginSettingId(long pluginSettingId) Sets the plugin setting ID of this plugin setting.
void	setPluginType(java.lang.String pluginType) Sets the plugin type of this plugin setting.
void	setPrimaryKey(long primaryKey) Sets the primary key of this plugin setting.
void	setPrimaryKeyObj(java.io.Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setRoles(java.lang.String roles) Sets the roles of this plugin setting.
void	setRolesArray(java.lang.String[] rolesArray) Sets an array of required roles of the plugin.
CacheModel<PluginSetting>	toCacheModel() Returns a cache model object for this entity used by entity cache.
PluginSetting	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
PluginSetting	toUnescapedModel()
java.lang.String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginSettingWrapper

public PluginSettingWrapper(PluginSetting pluginSetting)

Method Detail

getModelClass

public java.lang.Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public java.lang.String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<PluginSetting>

setModelAttributes

public void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<PluginSetting>

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this plugin setting.

Specified by:

getPrimaryKey in interface PluginSettingModel

Returns:

the primary key of this plugin setting

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this plugin setting.

Specified by:

setPrimaryKey in interface PluginSettingModel

Parameters:

primaryKey - the primary key of this plugin setting

getPluginSettingId

public long getPluginSettingId()

Returns the plugin setting ID of this plugin setting.

Specified by:

getPluginSettingId in interface PluginSettingModel

Returns:

the plugin setting ID of this plugin setting

setPluginSettingId

public void setPluginSettingId(long pluginSettingId)

Sets the plugin setting ID of this plugin setting.

Specified by:

setPluginSettingId in interface PluginSettingModel

Parameters:

pluginSettingId - the plugin setting ID of this plugin setting

getCompanyId

public long getCompanyId()

Returns the company ID of this plugin setting.

Specified by:

getCompanyId in interface PluginSettingModel

Returns:

the company ID of this plugin setting

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this plugin setting.

Specified by:

setCompanyId in interface PluginSettingModel

Parameters:

companyId - the company ID of this plugin setting

getPluginId

public java.lang.String getPluginId()

Returns the plugin ID of this plugin setting.

Specified by:

getPluginId in interface PluginSettingModel

Returns:

the plugin ID of this plugin setting

setPluginId

public void setPluginId(java.lang.String pluginId)

Sets the plugin ID of this plugin setting.

Specified by:

setPluginId in interface PluginSettingModel

Parameters:

pluginId - the plugin ID of this plugin setting

getPluginType

public java.lang.String getPluginType()

Returns the plugin type of this plugin setting.

Specified by:

getPluginType in interface PluginSettingModel

Returns:

the plugin type of this plugin setting

setPluginType

public void setPluginType(java.lang.String pluginType)

Sets the plugin type of this plugin setting.

Specified by:

setPluginType in interface PluginSettingModel

Parameters:

pluginType - the plugin type of this plugin setting

getRoles

public java.lang.String getRoles()

Returns the roles of this plugin setting.

Specified by:

getRoles in interface PluginSettingModel

Returns:

the roles of this plugin setting

setRoles

public void setRoles(java.lang.String roles)

Sets the roles of this plugin setting.

Specified by:

setRoles in interface PluginSettingModel

Parameters:

roles - the roles of this plugin setting

getActive

public boolean getActive()

Returns the active of this plugin setting.

Specified by:

getActive in interface PluginSettingModel

Returns:

the active of this plugin setting

isActive

public boolean isActive()

Returns true if this plugin setting is active.

Specified by:

isActive in interface PluginSettingModel

Returns:

true if this plugin setting is active; false otherwise

setActive

public void setActive(boolean active)

Sets whether this plugin setting is active.

Specified by:

setActive in interface PluginSettingModel

Parameters:

active - the active of this plugin setting

isNew

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

Specified by:

isNew in interface PluginSettingModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

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

Specified by:

setNew in interface PluginSettingModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

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

Specified by:

isCachedModel in interface PluginSettingModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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

Specified by:

setCachedModel in interface PluginSettingModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<PluginSetting>

Specified by:

isEscapedModel in interface PluginSettingModel

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<PluginSetting>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface PluginSettingModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<PluginSetting>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface PluginSettingModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<PluginSetting>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface PluginSettingModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<PluginSetting>

Specified by:

setExpandoBridgeAttributes in interface PluginSettingModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<PluginSetting>

Specified by:

setExpandoBridgeAttributes in interface PluginSettingModel

setExpandoBridgeAttributes

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

Specified by:

setExpandoBridgeAttributes in interface PluginSettingModel

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

public java.lang.Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<PluginSetting>

Specified by:

clone in interface PluginSettingModel

Overrides:

clone in class java.lang.Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(PluginSetting pluginSetting)

Specified by:

compareTo in interface PluginSettingModel

Specified by:

compareTo in interface java.lang.Comparable<PluginSetting>

hashCode

public int hashCode()

Specified by:

hashCode in interface PluginSettingModel

Overrides:

hashCode in class java.lang.Object

toCacheModel

public CacheModel<PluginSetting> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<PluginSetting>

Specified by:

toCacheModel in interface PluginSettingModel

Returns:

the cache model object

toEscapedModel

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

Specified by:

toEscapedModel in interface PluginSettingModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

public PluginSetting toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<PluginSetting>

Specified by:

toUnescapedModel in interface PluginSettingModel

toString

public java.lang.String toString()

Specified by:

toString in interface PluginSettingModel

Overrides:

toString in class java.lang.Object

toXmlString

public java.lang.String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<PluginSetting>

Specified by:

toXmlString in interface PluginSettingModel

Returns:

the XML representation of this model instance

persist

public void persist()
             throws SystemException

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

Throws:

SystemException - if a system exception occurred

addRole

public void addRole(java.lang.String role)

Adds a role to the list of roles.

Specified by:

addRole in interface PluginSetting

getRolesArray

public java.lang.String[] getRolesArray()

Returns an array of required roles of the plugin.

Specified by:

getRolesArray in interface PluginSetting

Returns:

an array of required roles of the plugin

hasPermission

public boolean hasPermission(long userId)

Returns true if the user has permission to use this plugin

Specified by:

hasPermission in interface PluginSetting

Parameters:

userId - the primary key of the user

Returns:

true if the user has permission to use this plugin

hasRoleWithName

public boolean hasRoleWithName(java.lang.String roleName)

Returns true if the plugin has a role with the specified name.

Specified by:

hasRoleWithName in interface PluginSetting

Parameters:

roleName - the role name

Returns:

true if the plugin has a role with the specified name

setRolesArray

public void setRolesArray(java.lang.String[] rolesArray)

Sets an array of required roles of the plugin.

Specified by:

setRolesArray in interface PluginSetting

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getWrappedPluginSetting

public PluginSetting getWrappedPluginSetting()

Deprecated. As of 6.1.0, replaced by getWrappedModel()

getWrappedModel

public PluginSetting getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<PluginSetting>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<PluginSetting>