com.liferay.portal.model
Interface PluginSettingModel

All Superinterfaces:

BaseModel<PluginSetting>, Cloneable, Comparable<PluginSetting>, Serializable

All Known Subinterfaces:

PluginSetting

All Known Implementing Classes:

PluginSettingImpl, PluginSettingModelImpl, PluginSettingWrapper

public interface PluginSettingModel
extends BaseModel<PluginSetting>

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

This interface and its corresponding implementation PluginSettingModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in PluginSettingImpl.

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

See Also:

PluginSetting, PluginSettingImpl, PluginSettingModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(PluginSetting pluginSetting)
boolean	getActive() Gets the active of this plugin setting.
long	getCompanyId() Gets the company id of this plugin setting.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getPluginId() Gets the plugin id of this plugin setting.
long	getPluginSettingId() Gets the plugin setting id of this plugin setting.
String	getPluginType() Gets the plugin type of this plugin setting.
long	getPrimaryKey() Gets the primary key of this plugin setting.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getRoles() Gets the roles of this plugin setting.
int	hashCode()
boolean	isActive() Determines whether this plugin setting is active.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setActive(boolean active) Sets whether this {$entity.humanName} 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	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
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) 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 pk) Sets the primary key of this plugin setting
void	setRoles(String roles) Sets the roles of this plugin setting.
PluginSetting	toEscapedModel() Gets a copy of this plugin setting as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this plugin setting.

Returns:

the primary key of this plugin setting

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this plugin setting

Parameters:

pk - the primary key of this plugin setting

getPluginSettingId

long getPluginSettingId()

Gets the plugin setting id of this plugin setting.

Returns:

the plugin setting id of this plugin setting

setPluginSettingId

void setPluginSettingId(long pluginSettingId)

Sets the plugin setting id of this plugin setting.

Parameters:

pluginSettingId - the plugin setting id of this plugin setting

getCompanyId

long getCompanyId()

Gets the company id of this plugin setting.

Returns:

the company id of this plugin setting

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this plugin setting.

Parameters:

companyId - the company id of this plugin setting

getPluginId

@AutoEscape
String getPluginId()

Gets the plugin id of this plugin setting.

Returns:

the plugin id of this plugin setting

setPluginId

void setPluginId(String pluginId)

Sets the plugin id of this plugin setting.

Parameters:

pluginId - the plugin id of this plugin setting

getPluginType

@AutoEscape
String getPluginType()

Gets the plugin type of this plugin setting.

Returns:

the plugin type of this plugin setting

setPluginType

void setPluginType(String pluginType)

Sets the plugin type of this plugin setting.

Parameters:

pluginType - the plugin type of this plugin setting

getRoles

@AutoEscape
String getRoles()

Gets the roles of this plugin setting.

Returns:

the roles of this plugin setting

setRoles

void setRoles(String roles)

Sets the roles of this plugin setting.

Parameters:

roles - the roles of this plugin setting

getActive

boolean getActive()

Gets the active of this plugin setting.

Returns:

the active of this plugin setting

isActive

boolean isActive()

Determines whether this plugin setting is active.

Returns:

whether this plugin setting is active

setActive

void setActive(boolean active)

Sets whether this {$entity.humanName} is active.

Parameters:

active - the active of this plugin setting

toEscapedModel

PluginSetting toEscapedModel()

Gets a copy of this plugin setting as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

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>

Returns:

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

setNew

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>

Parameters:

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

isCachedModel

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>

Returns:

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

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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>

Parameters:

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

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<PluginSetting>

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<PluginSetting>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<PluginSetting>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<PluginSetting>

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

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>

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<PluginSetting>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(PluginSetting pluginSetting)

Specified by:

compareTo in interface Comparable<PluginSetting>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<PluginSetting>

Returns:

the XML representation of this model instance