org.jasig.schedassist.portlet
Interface PortletSchedulingAssistantService

All Known Implementing Classes:

PortletSchedulingAssistantServiceImpl

public interface PortletSchedulingAssistantService

Service object mimicking methods within SchedulingAssistantService, RelationshipDao, and AvailableScheduleDao tailored for the portlet. The main differences correspond to the limited amount of data available for customer accounts (both visitors and owners).

Version:

$Id: PortletAvailableService.java 2359 2010-08-12 14:10:38Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

List<AvailableBlock>	calculateVisitorConflicts(String visitorUsername, long ownerId, int weekStart)
EventCancellation	cancelAppointment(String visitorUsername, long ownerId, AvailableBlock block, String cancelReason)
AvailableBlock	getTargetBlock(IScheduleOwner owner, Date startTime)
AvailableBlock	getTargetDoubleLengthBlock(IScheduleOwner owner, Date startTime)
VisibleSchedule	getVisibleSchedule(String visitorUsername, long ownerId)
VisibleSchedule	getVisibleSchedule(String visitorUsername, long ownerId, int weekStart)
boolean	isEligible(String visitorUsername)
List<Relationship>	relationshipsForVisitor(String visitorUsername)
net.fortuna.ical4j.model.component.VEvent	scheduleAppointment(String visitorUsername, long ownerId, AvailableBlock block, String eventDescription)

Method Detail

isEligible

boolean isEligible(String visitorUsername)

Parameters:

visitorUsername -

Returns:

true if the customer account specified by visitorUsername is eligible for service

cancelAppointment

EventCancellation cancelAppointment(String visitorUsername,
                                    long ownerId,
                                    AvailableBlock block,
                                    String cancelReason)
                                    throws SchedulingException

Parameters:

visitorUsername -

ownerId -

block -

Returns:

the event that was canceled

Throws:

SchedulingException

See Also:

SchedulingAssistantService.cancelAppointment(org.jasig.schedassist.model.IScheduleVisitor, IScheduleOwner, VEvent, AvailableBlock, String)

getVisibleSchedule

VisibleSchedule getVisibleSchedule(String visitorUsername,
                                   long ownerId)

Parameters:

visitorUsername -

ownerId -

Returns:

See Also:

SchedulingAssistantService.getVisibleSchedule(org.jasig.schedassist.model.IScheduleVisitor, IScheduleOwner)

getVisibleSchedule

VisibleSchedule getVisibleSchedule(String visitorUsername,
                                   long ownerId,
                                   int weekStart)

Parameters:

visitorUsername -

ownerId -

Returns:

See Also:

SchedulingAssistantService.getVisibleSchedule(org.jasig.schedassist.model.IScheduleVisitor, IScheduleOwner, Date, Date)

calculateVisitorConflicts

List<AvailableBlock> calculateVisitorConflicts(String visitorUsername,
                                               long ownerId,
                                               int weekStart)

Parameters:

visitorUsername -

ownerId -

weekStart -

Returns:

See Also:

SchedulingAssistantService.calculateVisitorConflicts(org.jasig.schedassist.model.IScheduleVisitor, IScheduleOwner, Date, Date)

getTargetBlock

AvailableBlock getTargetBlock(IScheduleOwner owner,
                              Date startTime)

Parameters:

owner -

startTime -

Returns:

See Also:

AvailableScheduleDao#retrieveTargetBlock(IScheduleOwner, Date)

getTargetDoubleLengthBlock

AvailableBlock getTargetDoubleLengthBlock(IScheduleOwner owner,
                                          Date startTime)

Parameters:

owner -

startTime -

Returns:

See Also:

AvailableScheduleDao#retrieveTargetDoubleLengthBlock(IScheduleOwner, Date)

scheduleAppointment

net.fortuna.ical4j.model.component.VEvent scheduleAppointment(String visitorUsername,
                                                              long ownerId,
                                                              AvailableBlock block,
                                                              String eventDescription)
                                                              throws SchedulingException

Parameters:

visitorUsername -

ownerId -

block -

eventDescription -

Returns:

Throws:

SchedulingException

See Also:

SchedulingAssistantService.scheduleAppointment(org.jasig.schedassist.model.IScheduleVisitor, IScheduleOwner, AvailableBlock, String)

relationshipsForVisitor

List<Relationship> relationshipsForVisitor(String visitorUsername)

Parameters:

visitor -

Returns:

See Also:

RelationshipDao.forVisitor(org.jasig.schedassist.model.IScheduleVisitor)