Liferay 6.0.5

com.liferay.portlet.social.model
Interface SocialRequestModel

All Superinterfaces:
BaseModel<SocialRequest>, Cloneable, Comparable<SocialRequest>, Serializable
All Known Subinterfaces:
SocialRequest
All Known Implementing Classes:
SocialRequestImpl, SocialRequestModelImpl, SocialRequestWrapper

public interface SocialRequestModel
extends BaseModel<SocialRequest>

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

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

Never modify or reference this interface directly. All methods that expect a social request model instance should use the SocialRequest interface instead.

See Also:
SocialRequest, SocialRequestImpl, SocialRequestModelImpl
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(SocialRequest socialRequest)
           
 String getClassName()
          Gets the class name of the model instance this social request is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this social request.
 long getClassPK()
          Gets the class p k of this social request.
 long getCompanyId()
          Gets the company id of this social request.
 long getCreateDate()
          Gets the create date of this social request.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getExtraData()
          Gets the extra data of this social request.
 long getGroupId()
          Gets the group id of this social request.
 long getModifiedDate()
          Gets the modified date of this social request.
 long getPrimaryKey()
          Gets the primary key of this social request.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getReceiverUserId()
          Gets the receiver user id of this social request.
 String getReceiverUserUuid()
          Gets the receiver user uuid of this social request.
 long getRequestId()
          Gets the request id of this social request.
 int getStatus()
          Gets the status of this social request.
 int getType()
          Gets the type of this social request.
 long getUserId()
          Gets the user id of this social request.
 String getUserUuid()
          Gets the user uuid of this social request.
 String getUuid()
          Gets the uuid of this social request.
 int hashCode()
           
 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 setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassNameId(long classNameId)
          Sets the class name id of this social request.
 void setClassPK(long classPK)
          Sets the class p k of this social request.
 void setCompanyId(long companyId)
          Sets the company id of this social request.
 void setCreateDate(long createDate)
          Sets the create date of this social request.
 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 setExtraData(String extraData)
          Sets the extra data of this social request.
 void setGroupId(long groupId)
          Sets the group id of this social request.
 void setModifiedDate(long modifiedDate)
          Sets the modified date of this social request.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long pk)
          Sets the primary key of this social request
 void setReceiverUserId(long receiverUserId)
          Sets the receiver user id of this social request.
 void setReceiverUserUuid(String receiverUserUuid)
          Sets the receiver user uuid of this social request.
 void setRequestId(long requestId)
          Sets the request id of this social request.
 void setStatus(int status)
          Sets the status of this social request.
 void setType(int type)
          Sets the type of this social request.
 void setUserId(long userId)
          Sets the user id of this social request.
 void setUserUuid(String userUuid)
          Sets the user uuid of this social request.
 void setUuid(String uuid)
          Sets the uuid of this social request.
 SocialRequest toEscapedModel()
          Gets a copy of this social request 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 social request.

Returns:
the primary key of this social request

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this social request

Parameters:
pk - the primary key of this social request

getUuid

@AutoEscape
String getUuid()
Gets the uuid of this social request.

Returns:
the uuid of this social request

setUuid

void setUuid(String uuid)
Sets the uuid of this social request.

Parameters:
uuid - the uuid of this social request

getRequestId

long getRequestId()
Gets the request id of this social request.

Returns:
the request id of this social request

setRequestId

void setRequestId(long requestId)
Sets the request id of this social request.

Parameters:
requestId - the request id of this social request

getGroupId

long getGroupId()
Gets the group id of this social request.

Returns:
the group id of this social request

setGroupId

void setGroupId(long groupId)
Sets the group id of this social request.

Parameters:
groupId - the group id of this social request

getCompanyId

long getCompanyId()
Gets the company id of this social request.

Returns:
the company id of this social request

setCompanyId

void setCompanyId(long companyId)
Sets the company id of this social request.

Parameters:
companyId - the company id of this social request

getUserId

long getUserId()
Gets the user id of this social request.

Returns:
the user id of this social request

setUserId

void setUserId(long userId)
Sets the user id of this social request.

Parameters:
userId - the user id of this social request

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this social request.

Returns:
the user uuid of this social request
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this social request.

Parameters:
userUuid - the user uuid of this social request

getCreateDate

long getCreateDate()
Gets the create date of this social request.

Returns:
the create date of this social request

setCreateDate

void setCreateDate(long createDate)
Sets the create date of this social request.

Parameters:
createDate - the create date of this social request

getModifiedDate

long getModifiedDate()
Gets the modified date of this social request.

Returns:
the modified date of this social request

setModifiedDate

void setModifiedDate(long modifiedDate)
Sets the modified date of this social request.

Parameters:
modifiedDate - the modified date of this social request

getClassName

String getClassName()
Gets the class name of the model instance this social request is polymorphically associated with.

Returns:
the class name of the model instance this social request is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name id of this social request.

Returns:
the class name id of this social request

setClassNameId

void setClassNameId(long classNameId)
Sets the class name id of this social request.

Parameters:
classNameId - the class name id of this social request

getClassPK

long getClassPK()
Gets the class p k of this social request.

Returns:
the class p k of this social request

setClassPK

void setClassPK(long classPK)
Sets the class p k of this social request.

Parameters:
classPK - the class p k of this social request

getType

int getType()
Gets the type of this social request.

Returns:
the type of this social request

setType

void setType(int type)
Sets the type of this social request.

Parameters:
type - the type of this social request

getExtraData

@AutoEscape
String getExtraData()
Gets the extra data of this social request.

Returns:
the extra data of this social request

setExtraData

void setExtraData(String extraData)
Sets the extra data of this social request.

Parameters:
extraData - the extra data of this social request

getReceiverUserId

long getReceiverUserId()
Gets the receiver user id of this social request.

Returns:
the receiver user id of this social request

setReceiverUserId

void setReceiverUserId(long receiverUserId)
Sets the receiver user id of this social request.

Parameters:
receiverUserId - the receiver user id of this social request

getReceiverUserUuid

String getReceiverUserUuid()
                           throws SystemException
Gets the receiver user uuid of this social request.

Returns:
the receiver user uuid of this social request
Throws:
SystemException - if a system exception occurred

setReceiverUserUuid

void setReceiverUserUuid(String receiverUserUuid)
Sets the receiver user uuid of this social request.

Parameters:
receiverUserUuid - the receiver user uuid of this social request

getStatus

int getStatus()
Gets the status of this social request.

Returns:
the status of this social request

setStatus

void setStatus(int status)
Sets the status of this social request.

Parameters:
status - the status of this social request

toEscapedModel

SocialRequest toEscapedModel()
Gets a copy of this social request 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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
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<SocialRequest>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(SocialRequest socialRequest)
Specified by:
compareTo in interface Comparable<SocialRequest>

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<SocialRequest>
Returns:
the XML representation of this model instance

Liferay 6.0.5