/*
* Copyright (c) 2011 Lockheed Martin Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eurekastreams.server.domain;
import java.io.Serializable;
import java.util.Date;
/**
* A notification for display within the application.
*/
public class InAppNotificationDTO implements Serializable
{
/** Fingerprint. */
private static final long serialVersionUID = 6548226026108187196L;
/** ID of notification. */
private long id;
/** Type of notification being sent. */
private NotificationType notificationType;
/** The date the notification was added. */
private Date notificationDate;
/** The text of the notification. */
private String message;
/** A URL the notification will link to. May be absolute or relative (just an anchor for URLs in app). */
private String url;
/** If high priority. */
private boolean highPriority;
/** If read. */
private boolean isRead;
/** Type of entity from which the notification came (person, group, app, or NOTSET=system). */
private EntityType sourceType;
/** Unique ID of source. */
private String sourceUniqueId;
/** Display name of source (to show in filters). */
private String sourceName;
/** Type of entity whose avatar will be displayed with the notification (person, group, app, or NOTSET=system). */
private EntityType avatarOwnerType;
/** Unique ID of entity whose avatar will be displayed. */
private String avatarOwnerUniqueId;
/** ID of the avatar to display. */
private String avatarId;
/** Filter category. May be null. */
private String filterCategory;
/**
* Constructor.
*/
public InAppNotificationDTO()
{
}
/**
* Constructor for Hibernate query to build the DTO.
*
* @param inId
* DB ID.
* @param inNotificationType
* Type.
* @param inNotificationDate
* Date generated.
* @param inMessage
* Text message.
* @param inUrl
* URL to link to.
* @param inHighPriority
* High or normal.
* @param inIsRead
* If read.
* @param inSourceType
* Type of source (for filter).
* @param inSourceUniqueId
* String ID of source.
* @param inSourceName
* Display name of source.
* @param inAvatarOwnerType
* Type of entity for avatar.
* @param inAvatarOwnerUniqueId
* String ID of entity for avatar.
*/
public InAppNotificationDTO(final long inId, final NotificationType inNotificationType,
final Date inNotificationDate, final String inMessage, final String inUrl, final boolean inHighPriority,
final boolean inIsRead, final EntityType inSourceType, final String inSourceUniqueId,
final String inSourceName, final EntityType inAvatarOwnerType, final String inAvatarOwnerUniqueId)
{
id = inId;
notificationType = inNotificationType;
notificationDate = inNotificationDate;
message = inMessage;
url = inUrl;
highPriority = inHighPriority;
isRead = inIsRead;
sourceType = inSourceType;
sourceUniqueId = inSourceUniqueId;
sourceName = inSourceName;
avatarOwnerType = inAvatarOwnerType;
avatarOwnerUniqueId = inAvatarOwnerUniqueId;
}
/**
* @return the notificationType
*/
public NotificationType getNotificationType()
{
return notificationType;
}
/**
* @param inNotificationType the notificationType to set
*/
public void setNotificationType(final NotificationType inNotificationType)
{
notificationType = inNotificationType;
}
/**
* @return the notificationDate
*/
public Date getNotificationDate()
{
return notificationDate;
}
/**
* @param inNotificationDate the notificationDate to set
*/
public void setNotificationDate(final Date inNotificationDate)
{
notificationDate = inNotificationDate;
}
/**
* @return the message
*/
public String getMessage()
{
return message;
}
/**
* @param inMessage the message to set
*/
public void setMessage(final String inMessage)
{
message = inMessage;
}
/**
* @return the url
*/
public String getUrl()
{
return url;
}
/**
* @param inUrl the url to set
*/
public void setUrl(final String inUrl)
{
url = inUrl;
}
/**
* @return If high priority.
*/
public boolean isHighPriority()
{
return highPriority;
}
/**
* @param inPriority the priority to set
*/
public void setHighPriority(final boolean inPriority)
{
highPriority = inPriority;
}
/**
* @return the isRead
*/
public boolean isRead()
{
return isRead;
}
/**
* @param inIsRead the isRead to set
*/
public void setRead(final boolean inIsRead)
{
isRead = inIsRead;
}
/**
* @return the sourceType
*/
public EntityType getSourceType()
{
return sourceType;
}
/**
* @param inSourceType the sourceType to set
*/
public void setSourceType(final EntityType inSourceType)
{
sourceType = inSourceType;
}
/**
* @return the sourceUniqueId
*/
public String getSourceUniqueId()
{
return sourceUniqueId;
}
/**
* @param inSourceUniqueId the sourceUniqueId to set
*/
public void setSourceUniqueId(final String inSourceUniqueId)
{
sourceUniqueId = inSourceUniqueId;
}
/**
* @return the sourceName
*/
public String getSourceName()
{
return sourceName;
}
/**
* @param inSourceName the sourceName to set
*/
public void setSourceName(final String inSourceName)
{
sourceName = inSourceName;
}
/**
* @return the id
*/
public long getId()
{
return id;
}
/**
* @param inId
* the id to set
*/
public void setId(final long inId)
{
id = inId;
}
/**
* @return the avatarOwnerType
*/
public EntityType getAvatarOwnerType()
{
return avatarOwnerType;
}
/**
* @param inAvatarOwnerType
* the avatarOwnerType to set
*/
public void setAvatarOwnerType(final EntityType inAvatarOwnerType)
{
avatarOwnerType = inAvatarOwnerType;
}
/**
* @return the avatarOwnerUniqueId
*/
public String getAvatarOwnerUniqueId()
{
return avatarOwnerUniqueId;
}
/**
* @param inAvatarOwnerUniqueId
* the avatarOwnerUniqueId to set
*/
public void setAvatarOwnerUniqueId(final String inAvatarOwnerUniqueId)
{
avatarOwnerUniqueId = inAvatarOwnerUniqueId;
}
/**
* @return the avatarId
*/
public String getAvatarId()
{
return avatarId;
}
/**
* @param inAvatarId
* the avatarId to set
*/
public void setAvatarId(final String inAvatarId)
{
avatarId = inAvatarId;
}
/**
* @return the filterCategory
*/
public String getFilterCategory()
{
return filterCategory;
}
/**
* @param inFilterCategory
* the filterCategory to set
*/
public void setFilterCategory(final String inFilterCategory)
{
filterCategory = inFilterCategory;
}
}