UserNotificationEventModel (Liferay 7.0-ga7 portal-kernel API)

All Superinterfaces:

BaseModel<UserNotificationEvent>, ClassedModel, Cloneable, Comparable<UserNotificationEvent>, MVCCModel, Serializable, ShardedModel

All Known Subinterfaces:

UserNotificationEvent

All Known Implementing Classes:

UserNotificationEventWrapper
```
@ProviderType
public interface UserNotificationEventModel
extends BaseModel<UserNotificationEvent>, MVCCModel, ShardedModel
```
The base model interface for the UserNotificationEvent service. Represents a row in the "UserNotificationEvent" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation UserNotificationEventModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in UserNotificationEventImpl.

Author:

Brian Wing Shun Chan

See Also:

UserNotificationEvent, UserNotificationEventImpl, UserNotificationEventModelImpl

{$generated.description}

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a shallow clone of this model instance.
`int`	`compareTo(UserNotificationEvent userNotificationEvent)`
`boolean`	`getActionRequired()` Returns the action required of this user notification event.
`boolean`	`getArchived()` Returns the archived of this user notification event.
`long`	`getCompanyId()` Returns the company ID of this user notification event.
`long`	`getDeliverBy()` Returns the deliver by of this user notification event.
`boolean`	`getDelivered()` Returns the delivered of this user notification event.
`int`	`getDeliveryType()` Returns the delivery type of this user notification event.
`ExpandoBridge`	`getExpandoBridge()` Returns the expando bridge for this model instance.
`long`	`getMvccVersion()` Returns the mvcc version of this user notification event.
`String`	`getPayload()` Returns the payload of this user notification event.
`long`	`getPrimaryKey()` Returns the primary key of this user notification event.
`Serializable`	`getPrimaryKeyObj()` Returns the primary key of this model instance.
`long`	`getTimestamp()` Returns the timestamp of this user notification event.
`String`	`getType()` Returns the type of this user notification event.
`long`	`getUserId()` Returns the user ID of this user notification event.
`long`	`getUserNotificationEventId()` Returns the user notification event ID of this user notification event.
`String`	`getUserUuid()` Returns the user uuid of this user notification event.
`String`	`getUuid()` Returns the uuid of this user notification event.
`int`	`hashCode()`
`boolean`	`isActionRequired()` Returns `true` if this user notification event is action required.
`boolean`	`isArchived()` Returns `true` if this user notification event is archived.
`boolean`	`isCachedModel()` Returns `true` if this model instance was retrieved from the entity cache.
`boolean`	`isDelivered()` Returns `true` if this user notification event is delivered.
`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`	`setActionRequired(boolean actionRequired)` Sets whether this user notification event is action required.
`void`	`setArchived(boolean archived)` Sets whether this user notification event is archived.
`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 user notification event.
`void`	`setDeliverBy(long deliverBy)` Sets the deliver by of this user notification event.
`void`	`setDelivered(boolean delivered)` Sets whether this user notification event is delivered.
`void`	`setDeliveryType(int deliveryType)` Sets the delivery type of this user notification event.
`void`	`setExpandoBridgeAttributes(BaseModel<?> baseModel)`
`void`	`setExpandoBridgeAttributes(ExpandoBridge expandoBridge)`
`void`	`setExpandoBridgeAttributes(ServiceContext serviceContext)` Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
`void`	`setMvccVersion(long mvccVersion)` Sets the mvcc version of this user notification event.
`void`	`setNew(boolean n)` Sets whether this model instance does not yet exist in the database.
`void`	`setPayload(String payload)` Sets the payload of this user notification event.
`void`	`setPrimaryKey(long primaryKey)` Sets the primary key of this user notification event.
`void`	`setPrimaryKeyObj(Serializable primaryKeyObj)` Sets the primary key of this model instance.
`void`	`setTimestamp(long timestamp)` Sets the timestamp of this user notification event.
`void`	`setType(String type)` Sets the type of this user notification event.
`void`	`setUserId(long userId)` Sets the user ID of this user notification event.
`void`	`setUserNotificationEventId(long userNotificationEventId)` Sets the user notification event ID of this user notification event.
`void`	`setUserUuid(String userUuid)` Sets the user uuid of this user notification event.
`void`	`setUuid(String uuid)` Sets the uuid of this user notification event.
`CacheModel<UserNotificationEvent>`	`toCacheModel()` Returns a cache model object for this entity used by entity cache.
`UserNotificationEvent`	`toEscapedModel()` Returns a copy of this entity as an escaped model instance by wrapping it with an `AutoEscapeBeanHandler`.
`String`	`toString()`
`UserNotificationEvent`	`toUnescapedModel()`
`String`	`toXmlString()` Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName

- Method Detail
  - getPrimaryKey
```
long getPrimaryKey()
```
    Returns the primary key of this user notification event.
    
    Returns:
    
    the primary key of this user notification event
  - setPrimaryKey
```
void setPrimaryKey(long primaryKey)
```
    Sets the primary key of this user notification event.
    
    Parameters:
    
    primaryKey - the primary key of this user notification event
  - getMvccVersion
```
long getMvccVersion()
```
    Returns the mvcc version of this user notification event.
    
    Specified by:
    
    getMvccVersion in interface MVCCModel
    
    Returns:
    
    the mvcc version of this user notification event
  - setMvccVersion
```
void setMvccVersion(long mvccVersion)
```
    Sets the mvcc version of this user notification event.
    
    Specified by:
    
    setMvccVersion in interface MVCCModel
    
    Parameters:
    
    mvccVersion - the mvcc version of this user notification event
  - getUuid
```
@AutoEscape
String getUuid()
```
    Returns the uuid of this user notification event.
    
    Returns:
    
    the uuid of this user notification event
  - setUuid
```
void setUuid(String uuid)
```
    Sets the uuid of this user notification event.
    
    Parameters:
    
    uuid - the uuid of this user notification event
  - getUserNotificationEventId
```
long getUserNotificationEventId()
```
    Returns the user notification event ID of this user notification event.
    
    Returns:
    
    the user notification event ID of this user notification event
  - setUserNotificationEventId
```
void setUserNotificationEventId(long userNotificationEventId)
```
    Sets the user notification event ID of this user notification event.
    
    Parameters:
    
    userNotificationEventId - the user notification event ID of this user notification event
  - getCompanyId
```
long getCompanyId()
```
    Returns the company ID of this user notification event.
    
    Specified by:
    
    getCompanyId in interface ShardedModel
    
    Returns:
    
    the company ID of this user notification event
  - setCompanyId
```
void setCompanyId(long companyId)
```
    Sets the company ID of this user notification event.
    
    Specified by:
    
    setCompanyId in interface ShardedModel
    
    Parameters:
    
    companyId - the company ID of this user notification event
  - getUserId
```
long getUserId()
```
    Returns the user ID of this user notification event.
    
    Returns:
    
    the user ID of this user notification event
  - setUserId
```
void setUserId(long userId)
```
    Sets the user ID of this user notification event.
    
    Parameters:
    
    userId - the user ID of this user notification event
  - getUserUuid
```
String getUserUuid()
```
    Returns the user uuid of this user notification event.
    
    Returns:
    
    the user uuid of this user notification event
  - setUserUuid
```
void setUserUuid(String userUuid)
```
    Sets the user uuid of this user notification event.
    
    Parameters:
    
    userUuid - the user uuid of this user notification event
  - getType
```
@AutoEscape
String getType()
```
    Returns the type of this user notification event.
    
    Returns:
    
    the type of this user notification event
  - setType
```
void setType(String type)
```
    Sets the type of this user notification event.
    
    Parameters:
    
    type - the type of this user notification event
  - getTimestamp
```
long getTimestamp()
```
    Returns the timestamp of this user notification event.
    
    Returns:
    
    the timestamp of this user notification event
  - setTimestamp
```
void setTimestamp(long timestamp)
```
    Sets the timestamp of this user notification event.
    
    Parameters:
    
    timestamp - the timestamp of this user notification event
  - getDeliveryType
```
int getDeliveryType()
```
    Returns the delivery type of this user notification event.
    
    Returns:
    
    the delivery type of this user notification event
  - setDeliveryType
```
void setDeliveryType(int deliveryType)
```
    Sets the delivery type of this user notification event.
    
    Parameters:
    
    deliveryType - the delivery type of this user notification event
  - getDeliverBy
```
long getDeliverBy()
```
    Returns the deliver by of this user notification event.
    
    Returns:
    
    the deliver by of this user notification event
  - setDeliverBy
```
void setDeliverBy(long deliverBy)
```
    Sets the deliver by of this user notification event.
    
    Parameters:
    
    deliverBy - the deliver by of this user notification event
  - getDelivered
```
boolean getDelivered()
```
    Returns the delivered of this user notification event.
    
    Returns:
    
    the delivered of this user notification event
  - isDelivered
```
boolean isDelivered()
```
    Returns true if this user notification event is delivered.
    
    Returns:
    
    true if this user notification event is delivered; false otherwise
  - setDelivered
```
void setDelivered(boolean delivered)
```
    Sets whether this user notification event is delivered.
    
    Parameters:
    
    delivered - the delivered of this user notification event
  - getPayload
```
@AutoEscape
String getPayload()
```
    Returns the payload of this user notification event.
    
    Returns:
    
    the payload of this user notification event
  - setPayload
```
void setPayload(String payload)
```
    Sets the payload of this user notification event.
    
    Parameters:
    
    payload - the payload of this user notification event
  - getActionRequired
```
boolean getActionRequired()
```
    Returns the action required of this user notification event.
    
    Returns:
    
    the action required of this user notification event
  - isActionRequired
```
boolean isActionRequired()
```
    Returns true if this user notification event is action required.
    
    Returns:
    
    true if this user notification event is action required; false otherwise
  - setActionRequired
```
void setActionRequired(boolean actionRequired)
```
    Sets whether this user notification event is action required.
    
    Parameters:
    
    actionRequired - the action required of this user notification event
  - getArchived
```
boolean getArchived()
```
    Returns the archived of this user notification event.
    
    Returns:
    
    the archived of this user notification event
  - isArchived
```
boolean isArchived()
```
    Returns true if this user notification event is archived.
    
    Returns:
    
    true if this user notification event is archived; false otherwise
  - setArchived
```
void setArchived(boolean archived)
```
    Sets whether this user notification event is archived.
    
    Parameters:
    
    archived - the archived of this user notification event
  - 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<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    Returns:
    
    true if this model instance is escaped; false otherwise
  - getPrimaryKeyObj
```
Serializable getPrimaryKeyObj()
```
    Description copied from interface: BaseModel
    
    Returns the primary key of this model instance.
    
    Specified by:
    
    getPrimaryKeyObj in interface BaseModel<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    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<UserNotificationEvent>
    
    Specified by:
    
    getExpandoBridge in interface ClassedModel
    
    Returns:
    
    the expando bridge for this model instance
  - setExpandoBridgeAttributes
```
void setExpandoBridgeAttributes(BaseModel<?> baseModel)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<UserNotificationEvent>
  - setExpandoBridgeAttributes
```
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<UserNotificationEvent>
  - 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<UserNotificationEvent>
    
    Parameters:
    
    serviceContext - the service context to be applied
    
    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<UserNotificationEvent>
    
    Returns:
    
    the shallow clone of this model instance
  - compareTo
```
int compareTo(UserNotificationEvent userNotificationEvent)
```
    Specified by:
    
    compareTo in interface Comparable<UserNotificationEvent>
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toCacheModel
```
CacheModel<UserNotificationEvent> toCacheModel()
```
    Description copied from interface: BaseModel
    
    Returns a cache model object for this entity used by entity cache.
    
    Specified by:
    
    toCacheModel in interface BaseModel<UserNotificationEvent>
    
    Returns:
    
    the cache model object
  - toEscapedModel
```
UserNotificationEvent 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<UserNotificationEvent>
    
    Returns:
    
    the escaped model instance
    
    See Also:
    
    AutoEscapeBeanHandler
  - toUnescapedModel
```
UserNotificationEvent toUnescapedModel()
```
    Specified by:
    
    toUnescapedModel in interface BaseModel<UserNotificationEvent>
  - 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<UserNotificationEvent>
    
    Returns:
    
    the XML representation of this model instance

Interface UserNotificationEventModel

Method Summary

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

Method Detail

getPrimaryKey

setPrimaryKey

getMvccVersion

setMvccVersion

getUuid

setUuid

getUserNotificationEventId

setUserNotificationEventId

getCompanyId

setCompanyId

getUserId

setUserId

getUserUuid

setUserUuid

getType

setType

getTimestamp

setTimestamp

getDeliveryType

setDeliveryType

getDeliverBy

setDeliverBy

getDelivered

isDelivered

setDelivered

getPayload

setPayload

getActionRequired

isActionRequired

setActionRequired

getArchived

isArchived

setArchived

isNew

setNew

isCachedModel

setCachedModel

isEscapedModel

getPrimaryKeyObj

setPrimaryKeyObj

getExpandoBridge

setExpandoBridgeAttributes

setExpandoBridgeAttributes

setExpandoBridgeAttributes

clone

compareTo

hashCode

toCacheModel

toEscapedModel

toUnescapedModel

toString

toXmlString