org.sakaiproject.signup.restful

Class SignupSiteItem

java.lang.Object

org.sakaiproject.signup.restful.SignupSiteItem

public class SignupSiteItem
extends Object

This class holds the information of sign-up site. It's a wrapper class for RESTful case.

Constructor Summary

Constructors

Constructor and Description
SignupSiteItem(String title, String siteId)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) check if the two SignupSite object are equal
List<SignupGroupItem>	getSignupGroupItems() get a list of SignupGroup objects, which belong to the site
String	getSiteId() get the Site id, which is a sakai unique site Id
String	getTitle() get the title of the site
int	hashCode()
boolean	isSiteScope() check if the event/meeting is a site scope-wide
void	setSignupGroupItems(List<SignupGroupItem> signupGroupItems) this is a setter
void	setSiteId(String siteId) this is a setter
void	setTitle(String title) this is a setter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignupSiteItem

public SignupSiteItem(String title,
              String siteId)

Method Detail

getSignupGroupItems

public List<SignupGroupItem> getSignupGroupItems()

get a list of SignupGroup objects, which belong to the site

Returns:

a list of SignupGroup objects

setSignupGroupItems

public void setSignupGroupItems(List<SignupGroupItem> signupGroupItems)

this is a setter

Parameters:

signupGroupItem - a list of SignupGroup objects

getSiteId

public String getSiteId()

get the Site id, which is a sakai unique site Id

Returns:

the unique site Id

setSiteId

public void setSiteId(String siteId)

this is a setter

Parameters:

siteId - the unique site Id

getTitle

public String getTitle()

get the title of the site

Returns:

the name of the site

setTitle

public void setTitle(String title)

this is a setter

Parameters:

title - the name of the site

isSiteScope

public boolean isSiteScope()

check if the event/meeting is a site scope-wide

Returns:

true if the event/meeting is a site scope-wide

equals

public boolean equals(Object object)

check if the two SignupSite object are equal

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object