Package org.gcube.social_networking.socialnetworking.model.beans.catalogue

Class CatalogueEvent

java.lang.Object

org.gcube.social_networking.socialnetworking.model.beans.catalogue.CatalogueEvent

public class CatalogueEvent
extends Object

The CatalogueEvent super class

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	idsAsGroup	optionl field, set to true if the idsToNotify are contexts, default is false
protected @NotNull(message="recipients cannot be missing, use usernames or contexts") String[]	idsToNotify	the username of the user you wish to notify
protected @NotNull(message="itemId cannot be missing") String	itemId	the item identifier or name (it is used in the subject of the email)
protected @NotNull(message="itemURL cannot be missing, use catalogue resolver URL") URL	itemURL	the URL to redirect when clicking on the notification
protected @NotNull(message="notifyText cannot be missing") String	notifyText	the text that you want to write in the notification (text/plain format)
protected CatalogueEventType	type

Constructor Summary

Constructors

Constructor	Description
CatalogueEvent()
CatalogueEvent(CatalogueEventType type, String[] idsToNotify, String itemId, String notifyText, URL itemURL)	for sending to users
CatalogueEvent(CatalogueEventType type, String[] idsToNotify, String itemId, String notifyText, URL itemURL, boolean idsAsGroup)	for sending to users or groups

Method Summary

Modifier and Type	Method	Description
String[]	getIdsToNotify()
String	getItemId()
URL	getItemURL()
String	getNotifyText()
CatalogueEventType	getType()
boolean	idsAsGroup()
boolean	isIdsAsGroup()
void	setIdsAsGroup(boolean idsAsGroup)
void	setIdsToNotify(String[] idsToNotify)
void	setItemId(String itemId)
void	setItemURL(URL itemURL)
void	setNotifyText(String notifyText)
void	setType(CatalogueEventType type)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

type

protected CatalogueEventType type

idsToNotify

@NotNull(message="recipients cannot be missing, use usernames or contexts")
protected @NotNull(message="recipients cannot be missing, use usernames or contexts") String[] idsToNotify

the username of the user you wish to notify

itemId

@NotNull(message="itemId cannot be missing")
protected @NotNull(message="itemId cannot be missing") String itemId

the item identifier or name (it is used in the subject of the email)

notifyText

@NotNull(message="notifyText cannot be missing")
protected @NotNull(message="notifyText cannot be missing") String notifyText

the text that you want to write in the notification (text/plain format)

itemURL

@NotNull(message="itemURL cannot be missing, use catalogue resolver URL")
protected @NotNull(message="itemURL cannot be missing, use catalogue resolver URL") URL itemURL

the URL to redirect when clicking on the notification

idsAsGroup

@DefaultValue("false")
protected boolean idsAsGroup

optionl field, set to true if the idsToNotify are contexts, default is false

Constructor Details

CatalogueEvent

public CatalogueEvent()

CatalogueEvent

public CatalogueEvent(CatalogueEventType type,
 String[] idsToNotify,
 String itemId,
 String notifyText,
 URL itemURL,
 boolean idsAsGroup)

for sending to users or groups

Parameters:

type -

idsToNotify -

itemId -

notifyText -

itemURL -

idsAsGroup -

CatalogueEvent

public CatalogueEvent(CatalogueEventType type,
 String[] idsToNotify,
 String itemId,
 String notifyText,
 URL itemURL)

for sending to users

Parameters:

type -

idsToNotify -

itemId -

notifyText -

itemURL -

Method Details

getType

public CatalogueEventType getType()

setType

public void setType(CatalogueEventType type)

getIdsToNotify

public String[] getIdsToNotify()

setIdsToNotify

public void setIdsToNotify(String[] idsToNotify)

idsAsGroup

public boolean idsAsGroup()

Returns:

true whether the idsToNotify have to be interpreted as groups and not usernames

setIdsAsGroup

public void setIdsAsGroup(boolean idsAsGroup)

Parameters:

idsAsGroup - set true whether the idsToNotify have to be interpreted as groups and not usernames, false otherwise

getItemId

public String getItemId()

setItemId

public void setItemId(String itemId)

getNotifyText

public String getNotifyText()

setNotifyText

public void setNotifyText(String notifyText)

getItemURL

public URL getItemURL()

setItemURL

public void setItemURL(URL itemURL)

isIdsAsGroup

public boolean isIdsAsGroup()

toString

public String toString()

Overrides:

toString in class Object