Liferay 6.0-ee-sp2

com.liferay.portlet.imagegallery.model
Interface IGFolderModel

All Superinterfaces:
AuditedModel, BaseModel<IGFolder>, ClassedModel, Cloneable, Comparable<IGFolder>, GroupedModel, Serializable
All Known Subinterfaces:
IGFolder
All Known Implementing Classes:
IGFolderWrapper

public interface IGFolderModel
extends BaseModel<IGFolder>, GroupedModel

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

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

See Also:
IGFolder, IGFolderImpl, IGFolderModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(IGFolder igFolder)
           
 long getCompanyId()
          Gets the company ID of this i g folder.
 Date getCreateDate()
          Gets the create date of this i g folder.
 String getDescription()
          Gets the description of this i g folder.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getFolderId()
          Gets the folder ID of this i g folder.
 long getGroupId()
          Gets the group ID of this i g folder.
 Date getModifiedDate()
          Gets the modified date of this i g folder.
 String getName()
          Gets the name of this i g folder.
 long getParentFolderId()
          Gets the parent folder ID of this i g folder.
 long getPrimaryKey()
          Gets the primary key of this i g folder.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getUserId()
          Gets the user ID of this i g folder.
 String getUserName()
          Gets the user name of this i g folder.
 String getUserUuid()
          Gets the user uuid of this i g folder.
 String getUuid()
          Gets the uuid of this i g folder.
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 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 i g folder.
 void setCreateDate(Date createDate)
          Sets the create date of this i g folder.
 void setDescription(String description)
          Sets the description of this i g folder.
 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 setFolderId(long folderId)
          Sets the folder ID of this i g folder.
 void setGroupId(long groupId)
          Sets the group ID of this i g folder.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this i g folder.
 void setName(String name)
          Sets the name of this i g folder.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentFolderId(long parentFolderId)
          Sets the parent folder ID of this i g folder.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this i g folder
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setUserId(long userId)
          Sets the user ID of this i g folder.
 void setUserName(String userName)
          Sets the user name of this i g folder.
 void setUserUuid(String userUuid)
          Sets the user uuid of this i g folder.
 void setUuid(String uuid)
          Sets the uuid of this i g folder.
 CacheModel<IGFolder> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 IGFolder toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this i g folder.

Returns:
the primary key of this i g folder

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this i g folder

Parameters:
primaryKey - the primary key of this i g folder

getUuid

@AutoEscape
String getUuid()
Gets the uuid of this i g folder.

Returns:
the uuid of this i g folder

setUuid

void setUuid(String uuid)
Sets the uuid of this i g folder.

Parameters:
uuid - the uuid of this i g folder

getFolderId

long getFolderId()
Gets the folder ID of this i g folder.

Returns:
the folder ID of this i g folder

setFolderId

void setFolderId(long folderId)
Sets the folder ID of this i g folder.

Parameters:
folderId - the folder ID of this i g folder

getGroupId

long getGroupId()
Gets the group ID of this i g folder.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this i g folder

setGroupId

void setGroupId(long groupId)
Sets the group ID of this i g folder.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this i g folder

getCompanyId

long getCompanyId()
Gets the company ID of this i g folder.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this i g folder

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this i g folder.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this i g folder

getUserId

long getUserId()
Gets the user ID of this i g folder.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this i g folder

setUserId

void setUserId(long userId)
Sets the user ID of this i g folder.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this i g folder

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this i g folder.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this i g folder
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this i g folder.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this i g folder

getUserName

@AutoEscape
String getUserName()
Gets the user name of this i g folder.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this i g folder

setUserName

void setUserName(String userName)
Sets the user name of this i g folder.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this i g folder

getCreateDate

Date getCreateDate()
Gets the create date of this i g folder.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this i g folder

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this i g folder.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this i g folder

getModifiedDate

Date getModifiedDate()
Gets the modified date of this i g folder.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this i g folder

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this i g folder.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this i g folder

getParentFolderId

long getParentFolderId()
Gets the parent folder ID of this i g folder.

Returns:
the parent folder ID of this i g folder

setParentFolderId

void setParentFolderId(long parentFolderId)
Sets the parent folder ID of this i g folder.

Parameters:
parentFolderId - the parent folder ID of this i g folder

getName

@AutoEscape
String getName()
Gets the name of this i g folder.

Returns:
the name of this i g folder

setName

void setName(String name)
Sets the name of this i g folder.

Parameters:
name - the name of this i g folder

getDescription

@AutoEscape
String getDescription()
Gets the description of this i g folder.

Returns:
the description of this i g folder

setDescription

void setDescription(String description)
Sets the description of this i g folder.

Parameters:
description - the description of this i g folder

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<IGFolder>
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<IGFolder>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<IGFolder>
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<IGFolder>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<IGFolder>
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<IGFolder>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<IGFolder>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<IGFolder>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<IGFolder>
Specified by:
getExpandoBridge in interface ClassedModel
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<IGFolder>
Parameters:
serviceContext - the service context
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<IGFolder>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(IGFolder igFolder)
Specified by:
compareTo in interface Comparable<IGFolder>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<IGFolder> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<IGFolder>
Returns:
the cache model object

toEscapedModel

IGFolder toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<IGFolder>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<IGFolder>
Returns:
the XML representation of this model instance

Liferay 6.0-ee-sp2