Liferay 6.0.3

com.liferay.portal.model
Class PluginSettingWrapper

java.lang.Object
  extended by com.liferay.portal.model.PluginSettingWrapper
All Implemented Interfaces:
BaseModel<PluginSetting>, PluginSetting, PluginSettingModel, Serializable, Cloneable, Comparable<PluginSetting>

public class PluginSettingWrapper
extends Object
implements PluginSetting

This class is a wrapper for PluginSetting.

See Also:
PluginSetting, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
PluginSettingWrapper(PluginSetting pluginSetting)
           
 
Method Summary
 void addRole(String role)
          Adds a role to the list of roles.
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PluginSetting pluginSetting)
           
 boolean getActive()
           
 long getCompanyId()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getPluginId()
           
 long getPluginSettingId()
           
 String getPluginType()
           
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 String getRoles()
           
 String[] getRolesArray()
          Gets an array of required roles of the plugin.
 PluginSetting getWrappedPluginSetting()
           
 int hashCode()
           
 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.
 boolean isActive()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance has been wrapped with an HTML auto escape handler.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 void setActive(boolean active)
           
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCompanyId(long companyId)
           
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance has been wrapped with an HTML auto escape handler.
 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 setPluginId(String pluginId)
           
 void setPluginSettingId(long pluginSettingId)
           
 void setPluginType(String pluginType)
           
 void setPrimaryKey(long pk)
           
 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.
 PluginSetting toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PluginSettingWrapper

public PluginSettingWrapper(PluginSetting pluginSetting)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Specified by:
getPrimaryKey in interface PluginSettingModel

setPrimaryKey

public void setPrimaryKey(long pk)
Specified by:
setPrimaryKey in interface PluginSettingModel

getPluginSettingId

public long getPluginSettingId()
Specified by:
getPluginSettingId in interface PluginSettingModel

setPluginSettingId

public void setPluginSettingId(long pluginSettingId)
Specified by:
setPluginSettingId in interface PluginSettingModel

getCompanyId

public long getCompanyId()
Specified by:
getCompanyId in interface PluginSettingModel

setCompanyId

public void setCompanyId(long companyId)
Specified by:
setCompanyId in interface PluginSettingModel

getPluginId

public String getPluginId()
Specified by:
getPluginId in interface PluginSettingModel

setPluginId

public void setPluginId(String pluginId)
Specified by:
setPluginId in interface PluginSettingModel

getPluginType

public String getPluginType()
Specified by:
getPluginType in interface PluginSettingModel

setPluginType

public void setPluginType(String pluginType)
Specified by:
setPluginType in interface PluginSettingModel

getRoles

public String getRoles()
Specified by:
getRoles in interface PluginSettingModel

setRoles

public void setRoles(String roles)
Description copied from interface: PluginSetting
Sets a string of ordered comma delimited plugin ids.

Specified by:
setRoles in interface PluginSetting
Specified by:
setRoles in interface PluginSettingModel

getActive

public boolean getActive()
Specified by:
getActive in interface PluginSettingModel

isActive

public boolean isActive()
Specified by:
isActive in interface PluginSettingModel

setActive

public void setActive(boolean active)
Specified by:
setActive in interface PluginSettingModel

toEscapedModel

public PluginSetting toEscapedModel()
Specified by:
toEscapedModel in interface PluginSettingModel

isNew

public 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<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
Determines 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
Determines if this model instance has been wrapped with an HTML auto escape handler.

Specified by:
isEscapedModel in interface BaseModel<PluginSetting>
Specified by:
isEscapedModel in interface PluginSettingModel
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance has been wrapped with an HTML auto escape handler.

A model instance can be wrapped with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<PluginSetting>
Specified by:
setEscapedModel in interface PluginSettingModel
Parameters:
escapedModel - whether this model instance has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key for this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<PluginSetting>
Specified by:
getPrimaryKeyObj in interface PluginSettingModel
Returns:
the primary key

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<PluginSetting>
Specified by:
getExpandoBridge in interface PluginSettingModel
Returns:
the expando bridge

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 retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public 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 Object
Returns:
the clone

compareTo

public int compareTo(PluginSetting pluginSetting)
Specified by:
compareTo in interface PluginSettingModel
Specified by:
compareTo in interface Comparable<PluginSetting>

hashCode

public int hashCode()
Specified by:
hashCode in interface PluginSettingModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface PluginSettingModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets 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

addRole

public void addRole(String role)
Description copied from interface: PluginSetting
Adds a role to the list of roles.

Specified by:
addRole in interface PluginSetting

getRolesArray

public String[] getRolesArray()
Description copied from interface: PluginSetting
Gets an array of required roles of the plugin.

Specified by:
getRolesArray in interface PluginSetting
Returns:
an array of required roles of the plugin

setRolesArray

public void setRolesArray(String[] rolesArray)
Description copied from interface: PluginSetting
Sets an array of required roles of the plugin.

Specified by:
setRolesArray in interface PluginSetting

hasRoleWithName

public boolean hasRoleWithName(String roleName)
Description copied from interface: PluginSetting
Returns true if the plugin has a role with the specified name.

Specified by:
hasRoleWithName in interface PluginSetting
Returns:
true if the plugin has a role with the specified name

hasPermission

public boolean hasPermission(long userId)
Description copied from interface: PluginSetting
Returns true if the user has permission to use this plugin

Specified by:
hasPermission in interface PluginSetting
Returns:
true if the user has permission to use this plugin

getWrappedPluginSetting

public PluginSetting getWrappedPluginSetting()

Liferay 6.0.3