org.jasig.schedassist.model
Class AbstractCalendarAccount

java.lang.Object
  org.jasig.schedassist.model.AbstractCalendarAccount

All Implemented Interfaces:

Serializable, ICalendarAccount

public abstract class AbstractCalendarAccount
extends Object
implements ICalendarAccount

Abstract super type for ICalendarAccount.

Version:

$Id: AbstractCalendarAccount.java 1898 2010-04-14 21:07:32Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

See Also:

Serialized Form

Field Summary

protected String	calendarUniqueId
protected String	displayName
protected boolean	eligible
protected String	emailAddress
protected String	username

Constructor Summary

AbstractCalendarAccount()

Method Summary

boolean	equals(Object obj)
abstract Map<String,String>	getAttributes()
abstract String	getAttributeValue(String attributeName) Get the value of the specified single-valued attribute on the account.
abstract String	getCalendarLoginId() Get the ID (as a String) used to authenticate with the calendar system.
String	getCalendarUniqueId() Get the unique identifier (as a String) for this account in the calendar system.
String	getDisplayName() The "display name" for the account.
String	getEmailAddress()
String	getUsername() The common "username" for the account.
int	hashCode()
boolean	isEligible()
void	setCalendarUniqueId(String calendarUniqueId)
void	setDisplayName(String displayName)
void	setEligible(boolean eligible)
void	setEmailAddress(String emailAddress)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

calendarUniqueId

protected String calendarUniqueId

emailAddress

protected String emailAddress

displayName

protected String displayName

username

protected String username

eligible

protected boolean eligible

Constructor Detail

AbstractCalendarAccount

public AbstractCalendarAccount()

Method Detail

getCalendarUniqueId

public String getCalendarUniqueId()

Description copied from interface: ICalendarAccount

Get the unique identifier (as a String) for this account in the calendar system. May or may not be identical to ICalendarAccount.getCalendarLoginId(), depending on the calendar system (or account type).

Specified by:

getCalendarUniqueId in interface ICalendarAccount

Returns:

the unique identifier (as a String) for this account in the calendar system.

getEmailAddress

public String getEmailAddress()

Specified by:

getEmailAddress in interface ICalendarAccount

Returns:

the email address for the account

getDisplayName

public String getDisplayName()

Description copied from interface: ICalendarAccount

The "display name" for the account.

Specified by:

getDisplayName in interface ICalendarAccount

Returns:

The "display name" for the account.

getUsername

public String getUsername()

Description copied from interface: ICalendarAccount

The common "username" for the account. May or may not be identical to ICalendarAccount.getCalendarLoginId(), depending on the calendar system (or account type).

Specified by:

getUsername in interface ICalendarAccount

Returns:

The common "username" for the account.

isEligible

public boolean isEligible()

Specified by:

isEligible in interface ICalendarAccount

Returns:

true if this account is eligible for calendar service

setCalendarUniqueId

public void setCalendarUniqueId(String calendarUniqueId)

Parameters:

calendarUniqueId - the calendarUniqueId to set

setEmailAddress

public void setEmailAddress(String emailAddress)

Parameters:

emailAddress - the emailAddress to set

setDisplayName

public void setDisplayName(String displayName)

Parameters:

displayName - the name to set

setUsername

public void setUsername(String username)

Parameters:

username - the username to set

setEligible

public void setEligible(boolean eligible)

Parameters:

eligible - the eligible to set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getAttributeValue

public abstract String getAttributeValue(String attributeName)

Description copied from interface: ICalendarAccount

Get the value of the specified single-valued attribute on the account.

Specified by:

getAttributeValue in interface ICalendarAccount

Returns:

the value of the attribute

getAttributes

public abstract Map<String,String> getAttributes()

Specified by:

getAttributes in interface ICalendarAccount

Returns:

a map of the account's single-valued attributes

getCalendarLoginId

public abstract String getCalendarLoginId()

Description copied from interface: ICalendarAccount

Get the ID (as a String) used to authenticate with the calendar system.

Specified by:

getCalendarLoginId in interface ICalendarAccount

Returns:

the ID (as a String) used to authenticate with the calendar system.