com.objectplanet.survey.plugin.api

Class InviteeList

java.lang.Object

com.objectplanet.survey.plugin.api.InviteeList

public class InviteeList
extends java.lang.Object

This class represents a reusable invitee list.

Author:

Irina Brun

Constructor Summary

Constructors

Constructor and Description
InviteeList() Constructs an empty InviteeList.
InviteeList(java.lang.String name) Constructor for the InviteeList object

Method Summary

Modifier and Type	Method and Description
long	getInviteeListId() Gets the inviteeListId attribute of the InviteeList object
java.lang.String	getInvitees() Gets the invitees.
java.lang.String	getName() Gets the name attribute of the InviteeList object
boolean	getSortOn() Gets the sortOn attribute (alphabetic sort)
void	setInvitees(java.lang.String invitees) Adds invitees to the invitee list.
void	setName(java.lang.String name) Sets the name attribute of the InviteeList object
void	setSortOn(boolean sortOn) Sets the alphabetic sort on/off.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InviteeList

public InviteeList()

Constructs an empty InviteeList.

InviteeList

public InviteeList(java.lang.String name)

Constructor for the InviteeList object

Parameters:

name - Name of the invitation list

Method Detail

setName

public void setName(java.lang.String name)

Sets the name attribute of the InviteeList object

Parameters:

name - The new name value

setInvitees

public void setInvitees(java.lang.String invitees)

Adds invitees to the invitee list. Invitees should be separated with new line. Use space to separate email and name.
Example:

  StringBuffer invitees = new StringBuffer();
  invitees.append("smith@smth.com").append("\n");
  invitees.append("brown@smth.com Michael Brown").append("\n");
  inviteeList.setInvitees(invitees);
 

Two invitees will be created:

1. Email: smith@smth.com
   Name:
2. Email: brown@smth.com
   Name: Michael Brown

Parameters:

invitees - List of invitees, one per line.

setSortOn

public void setSortOn(boolean sortOn)

Sets the alphabetic sort on/off.

Parameters:

sortOn - The new sortOn value

getInviteeListId

public long getInviteeListId()

Gets the inviteeListId attribute of the InviteeList object

Returns:

The inviteeListId value

getName

public java.lang.String getName()

Gets the name attribute of the InviteeList object

Returns:

The name value

getInvitees

public java.lang.String getInvitees()

Gets the invitees. Invitees are separated by new line (\n)

Returns:

The invitees value

getSortOn

public boolean getSortOn()

Gets the sortOn attribute (alphabetic sort)

Returns:

The sortOn value