com.liferay.portal.kernel.model

Interface PluginSetting

All Superinterfaces:

BaseModel<PluginSetting>, ClassedModel, Cloneable, Comparable<PluginSetting>, MVCCModel, PersistedModel, PluginSettingModel, Serializable, ShardedModel

All Known Implementing Classes:

PluginSettingWrapper

@ProviderType
public interface PluginSetting
extends PersistedModel, PluginSettingModel

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

Author:

Brian Wing Shun Chan

See Also:

PluginSettingModel

{$generated.description}

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<PluginSetting,Long>	PLUGIN_SETTING_ID_ACCESSOR NOTE FOR DEVELOPERS: Never modify this interface directly.

Method Summary

Modifier and Type	Method and Description
void	addRole(String role) Adds a role to the list of roles.
String[]	getRolesArray() Returns an array of required roles of the plugin.
boolean	hasPermission(long userId) Returns true if the user has permission to use this plugin
boolean	hasRoleWithName(String roleName) Returns true if the plugin has a role with the specified name.
void	setRolesArray(String[] rolesArray) Sets an array of required roles of the plugin.

Methods inherited from interface com.liferay.portal.kernel.model.PersistedModel

persist

Methods inherited from interface com.liferay.portal.kernel.model.PluginSettingModel

getActive, getCompanyId, getMvccVersion, getPluginId, getPluginSettingId, getPluginType, getPrimaryKey, getRoles, isActive, setActive, setCompanyId, setMvccVersion, setPluginId, setPluginSettingId, setPluginType, setPrimaryKey, setRoles

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

clone, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface Comparable

compareTo

Field Detail

PLUGIN_SETTING_ID_ACCESSOR

static final Accessor<PluginSetting,Long> PLUGIN_SETTING_ID_ACCESSOR

NOTE FOR DEVELOPERS: Never modify this interface directly. Add methods to com.liferay.portal.model.impl.PluginSettingImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Method Detail

addRole

void addRole(String role)

Adds a role to the list of roles.

getRolesArray

String[] getRolesArray()

Returns an array of required roles of the plugin.

Returns:

an array of required roles of the plugin

hasPermission

boolean hasPermission(long userId)

Returns true if the user has permission to use this plugin

Parameters:

userId - the primary key of the user

Returns:

true if the user has permission to use this plugin

hasRoleWithName

boolean hasRoleWithName(String roleName)

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

Parameters:

roleName - the role name

Returns:

true if the plugin has a role with the specified name

setRolesArray

void setRolesArray(String[] rolesArray)

Sets an array of required roles of the plugin.