org.jasig.schedassist.model
Interface IScheduleOwner

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractScheduleOwner

public interface IScheduleOwner
extends Serializable

Interface that represents a registered "Schedule Owner" within the Scheduling Assistant.

Version:

$Id: IScheduleOwner.java 2983 2011-01-26 21:52:38Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

ICalendarAccount	getCalendarAccount()
long	getId() Internal identifier within the Scheduling Assistant for an IScheduleOwner.
String	getPreference(Preferences preference)
Map<Preferences,String>	getPreferences()
int	getPreferredDefaultVisitorLimit()
String	getPreferredLocation() Short cut method to return the owner's value for Preferences.LOCATION.
MeetingDurations	getPreferredMeetingDurations() Short cut method to return the owner's value for Preferences.DURATIONS.
int	getPreferredMinimumDuration() Short cut method to return the owner's min value for Preferences.DURATIONS as an integer.
VisibleWindow	getPreferredVisibleWindow() Short cut method to return the owner's value for Preferences.VISIBLE_WINDOW.
Reminders	getRemindersPreference() Short cut method to return the owner's value for Preferences.REMINDERS.
boolean	hasMeetingLimit() Short cut method to determine whether this owner restricts the number of appointments that a visitor can create within a visible window.
boolean	isExceedingMeetingLimit(int visibleScheduleAttendingCount) Short cut method to check if an attendee count for an event exceeds the owner's preferences.
boolean	isReflectSchedule() Short cut method backed by Preferences.REFLECT_SCHEDULE.
boolean	isSamePerson(IScheduleVisitor visitor)

Method Detail

getCalendarAccount

ICalendarAccount getCalendarAccount()

Returns:

the ICalendarAccount that registered this account

getId

long getId()

Internal identifier within the Scheduling Assistant for an IScheduleOwner.

Returns:

the owner's id value

getPreferences

Map<Preferences,String> getPreferences()

Returns:

a map of the owner's String values for their chosen Preferences

getPreference

String getPreference(Preferences preference)

Parameters:

preference -

Returns:

the owner's String value for the specified Preferences

getPreferredLocation

String getPreferredLocation()

Short cut method to return the owner's value for Preferences.LOCATION.

Returns:

the owner's preferred location preference

getPreferredMeetingDurations

MeetingDurations getPreferredMeetingDurations()

Short cut method to return the owner's value for Preferences.DURATIONS.

Returns:

the owner's preferred MeetingDurations

getRemindersPreference

Reminders getRemindersPreference()

Short cut method to return the owner's value for Preferences.REMINDERS.

Returns:

the owner's preferred Reminders

getPreferredMinimumDuration

int getPreferredMinimumDuration()

Short cut method to return the owner's min value for Preferences.DURATIONS as an integer.

Returns:

the owner's min value for Preferences.DURATIONS as an integer.

getPreferredVisibleWindow

VisibleWindow getPreferredVisibleWindow()

Short cut method to return the owner's value for Preferences.VISIBLE_WINDOW.

Returns:

the owner's preferred VisibleWindow

isSamePerson

boolean isSamePerson(IScheduleVisitor visitor)

Parameters:

visitor -

Returns:

true if this instance and the IScheduleVisitor represent the same ICalendarAccount

hasMeetingLimit

boolean hasMeetingLimit()

Short cut method to determine whether this owner restricts the number of appointments that a visitor can create within a visible window.

Returns:

true if the owner's value for Preferences.MEETING_LIMIT is not equal to -1

See Also:

Preferences.MEETING_LIMIT

isExceedingMeetingLimit

boolean isExceedingMeetingLimit(int visibleScheduleAttendingCount)

Short cut method to check if an attendee count for an event exceeds the owner's preferences.

Parameters:

visibleScheduleAttendingCount - the number of available attendees for an event

Returns:

true if the arguments equals or exceeds this owner's value for Preferences.MEETING_LIMIT

isReflectSchedule

boolean isReflectSchedule()

Short cut method backed by Preferences.REFLECT_SCHEDULE.

Returns:

true if the owner has enabled the schedule reflection preference.

getPreferredDefaultVisitorLimit

int getPreferredDefaultVisitorLimit()

Returns:

this owner's preference for Preferences.DEFAULT_VISITOR_LIMIT.