org.jasig.schedassist.model
Interface ICalendarAccount

All Superinterfaces:

Serializable

All Known Subinterfaces:

IDelegateCalendarAccount

All Known Implementing Classes:

AbstractCalendarAccount

public interface ICalendarAccount
extends Serializable

Interface to describe common properties of accounts with a remote calendar system.

Version:

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

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

Map<String,List<String>>	getAttributes()
String	getAttributeValue(String attributeName) Get the value of the specified single-valued attribute on the account.
List<String>	getAttributeValues(String attributeName) Get the list of values of the specified multi-valued attribute on the account.
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.
boolean	isDelegate()
boolean	isEligible()

Method Detail

getDisplayName

String getDisplayName()

The "display name" for the account.

Returns:

The "display name" for the account.

getUsername

String getUsername()

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

Returns:

The common "username" for the account.

getEmailAddress

String getEmailAddress()

Returns:

the email address for the account

getCalendarLoginId

String getCalendarLoginId()

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

Returns:

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

getCalendarUniqueId

String getCalendarUniqueId()

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

Returns:

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

getAttributeValue

String getAttributeValue(String attributeName)

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

Parameters:

attributeName -

Returns:

the value of the attribute

getAttributeValues

List<String> getAttributeValues(String attributeName)

Get the list of values of the specified multi-valued attribute on the account.

Parameters:

attributeName -

Returns:

getAttributes

Map<String,List<String>> getAttributes()

Returns:

a map of the account's attributes

isEligible

boolean isEligible()

Returns:

true if this account is eligible for calendar service

isDelegate

boolean isDelegate()

Returns:

true if this account is a delegate account