Package com.liferay.portal.kernel.model
Class PluginSettingWrapper
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<PluginSetting>
com.liferay.portal.kernel.model.PluginSettingWrapper
- All Implemented Interfaces:
BaseModel<PluginSetting>
,ClassedModel
,ModelWrapper<PluginSetting>
,MVCCModel
,PersistedModel
,PluginSetting
,PluginSettingModel
,ShardedModel
,Serializable
,Cloneable
,Comparable<PluginSetting>
public class PluginSettingWrapper
extends BaseModelWrapper<PluginSetting>
implements ModelWrapper<PluginSetting>, PluginSetting
This class is a wrapper for PluginSetting
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
model
Fields inherited from interface com.liferay.portal.kernel.model.PluginSetting
PLUGIN_SETTING_ID_ACCESSOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a role to the list of roles.boolean
Returns the active of this plugin setting.long
Returns the company ID of this plugin setting.long
Returns the mvcc version of this plugin setting.Returns the plugin ID of this plugin setting.long
Returns the plugin setting ID of this plugin setting.Returns the plugin type of this plugin setting.long
Returns the primary key of this plugin setting.getRoles()
Returns the roles of this plugin setting.String[]
Returns an array of required roles of the plugin.boolean
hasPermission
(long userId) Returnstrue
if the user has permission to use this pluginboolean
hasPermission
(long userId, long groupId) Returnstrue
if the user has permission to use this pluginboolean
hasRoleWithName
(String roleName) Returnstrue
if the plugin has a role with the specified name.boolean
isActive()
Returnstrue
if this plugin setting is active.void
persist()
Updates this model instance in the database or adds it if it does not yet exist.void
setActive
(boolean active) Sets whether this plugin setting is active.void
setCompanyId
(long companyId) Sets the company ID of this plugin setting.void
setModelAttributes
(Map<String, Object> attributes) void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this plugin setting.void
setPluginId
(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
(String pluginType) Sets the plugin type of this plugin setting.void
setPrimaryKey
(long primaryKey) Sets the primary key of this plugin setting.void
Sets the roles of this plugin setting.void
setRolesArray
(String[] rolesArray) Sets an array of required roles of the plugin.protected PluginSettingWrapper
wrap
(PluginSetting pluginSetting) Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModel
-
Constructor Details
-
PluginSettingWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributes
in interfaceBaseModel<PluginSetting>
-
setModelAttributes
- Specified by:
setModelAttributes
in interfaceBaseModel<PluginSetting>
-
addRole
Adds a role to the list of roles.- Specified by:
addRole
in interfacePluginSetting
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<PluginSetting>
- Specified by:
cloneWithOriginalValues
in interfacePluginSettingModel
-
getActive
public boolean getActive()Returns the active of this plugin setting.- Specified by:
getActive
in interfacePluginSettingModel
- Returns:
- the active of this plugin setting
-
getCompanyId
public long getCompanyId()Returns the company ID of this plugin setting.- Specified by:
getCompanyId
in interfacePluginSettingModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Returns:
- the company ID of this plugin setting
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this plugin setting.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Specified by:
getMvccVersion
in interfacePluginSettingModel
- Returns:
- the mvcc version of this plugin setting
-
getPluginId
Returns the plugin ID of this plugin setting.- Specified by:
getPluginId
in interfacePluginSettingModel
- Returns:
- the plugin ID of this plugin setting
-
getPluginSettingId
public long getPluginSettingId()Returns the plugin setting ID of this plugin setting.- Specified by:
getPluginSettingId
in interfacePluginSettingModel
- Returns:
- the plugin setting ID of this plugin setting
-
getPluginType
Returns the plugin type of this plugin setting.- Specified by:
getPluginType
in interfacePluginSettingModel
- Returns:
- the plugin type of this plugin setting
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this plugin setting.- Specified by:
getPrimaryKey
in interfacePluginSettingModel
- Returns:
- the primary key of this plugin setting
-
getRoles
Returns the roles of this plugin setting.- Specified by:
getRoles
in interfacePluginSettingModel
- Returns:
- the roles of this plugin setting
-
getRolesArray
Returns an array of required roles of the plugin.- Specified by:
getRolesArray
in interfacePluginSetting
- Returns:
- an array of required roles of the plugin
-
hasPermission
public boolean hasPermission(long userId) Returnstrue
if the user has permission to use this plugin- Specified by:
hasPermission
in interfacePluginSetting
- Parameters:
userId
- the primary key of the user- Returns:
true
if the user has permission to use this plugin
-
hasPermission
public boolean hasPermission(long userId, long groupId) Returnstrue
if the user has permission to use this plugin- Specified by:
hasPermission
in interfacePluginSetting
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group- Returns:
true
if the user has permission to use this plugin
-
hasRoleWithName
Returnstrue
if the plugin has a role with the specified name.- Specified by:
hasRoleWithName
in interfacePluginSetting
- Parameters:
roleName
- the role name- Returns:
true
if the plugin has a role with the specified name
-
isActive
public boolean isActive()Returnstrue
if this plugin setting is active.- Specified by:
isActive
in interfacePluginSettingModel
- Returns:
true
if this plugin setting is active;false
otherwise
-
persist
public void persist()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 interfacePersistedModel
-
setActive
public void setActive(boolean active) Sets whether this plugin setting is active.- Specified by:
setActive
in interfacePluginSettingModel
- Parameters:
active
- the active of this plugin setting
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this plugin setting.- Specified by:
setCompanyId
in interfacePluginSettingModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Parameters:
companyId
- the company ID of this plugin setting
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this plugin setting.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Specified by:
setMvccVersion
in interfacePluginSettingModel
- Parameters:
mvccVersion
- the mvcc version of this plugin setting
-
setPluginId
Sets the plugin ID of this plugin setting.- Specified by:
setPluginId
in interfacePluginSettingModel
- Parameters:
pluginId
- the plugin ID of this plugin setting
-
setPluginSettingId
public void setPluginSettingId(long pluginSettingId) Sets the plugin setting ID of this plugin setting.- Specified by:
setPluginSettingId
in interfacePluginSettingModel
- Parameters:
pluginSettingId
- the plugin setting ID of this plugin setting
-
setPluginType
Sets the plugin type of this plugin setting.- Specified by:
setPluginType
in interfacePluginSettingModel
- Parameters:
pluginType
- the plugin type of this plugin setting
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this plugin setting.- Specified by:
setPrimaryKey
in interfacePluginSettingModel
- Parameters:
primaryKey
- the primary key of this plugin setting
-
setRoles
Sets the roles of this plugin setting.- Specified by:
setRoles
in interfacePluginSettingModel
- Parameters:
roles
- the roles of this plugin setting
-
setRolesArray
Sets an array of required roles of the plugin.- Specified by:
setRolesArray
in interfacePluginSetting
-
toXmlString
- Specified by:
toXmlString
in interfacePluginSettingModel
-
wrap
- Specified by:
wrap
in classBaseModelWrapper<PluginSetting>
-