Liferay 6.0-ee

com.liferay.portal.model
Interface PluginSetting

All Superinterfaces:
BaseModel<PluginSetting>, Cloneable, Comparable<PluginSetting>, PluginSettingModel, Serializable
All Known Implementing Classes:
PluginSettingImpl, PluginSettingWrapper

public interface PluginSetting
extends PluginSettingModel

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

Never modify this interface directly. Add methods to PluginSettingImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Never reference this interface directly. All methods that expect a plugin setting model instance should use the PluginSetting interface instead.

See Also:
PluginSettingModel, PluginSettingImpl, PluginSettingModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void addRole(String role)
          Adds a role to the list of roles.
 String[] getRolesArray()
          Gets 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 setRoles(String roles)
          Sets a string of ordered comma delimited plugin ids.
 void setRolesArray(String[] rolesArray)
          Sets an array of required roles of the plugin.
 
Methods inherited from interface com.liferay.portal.model.PluginSettingModel
clone, compareTo, getActive, getCompanyId, getExpandoBridge, getPluginId, getPluginSettingId, getPluginType, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setEscapedModel, setExpandoBridgeAttributes, setNew, setPluginId, setPluginSettingId, setPluginType, setPrimaryKey, toEscapedModel, toString, toXmlString
 

Method Detail

addRole

void addRole(String role)
Adds a role to the list of roles.


setRoles

void setRoles(String roles)
Sets a string of ordered comma delimited plugin ids.

Specified by:
setRoles in interface PluginSettingModel
Parameters:
roles - the roles of this plugin setting

getRolesArray

String[] getRolesArray()
Gets an array of required roles of the plugin.

Returns:
an array of required roles of the plugin

setRolesArray

void setRolesArray(String[] rolesArray)
Sets an array of required roles of the plugin.


hasRoleWithName

boolean hasRoleWithName(String roleName)
Returns true if the plugin has a role with the specified name.

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

hasPermission

boolean hasPermission(long userId)
Returns true if the user has permission to use this plugin

Returns:
true if the user has permission to use this plugin

Liferay 6.0-ee