org.springframework.social.greenhouse
Interface GreenhouseOperations

All Known Implementing Classes:
GreenhouseTemplate

public interface GreenhouseOperations

Interface specifying a basic set of operations for interacting with Greenhouse. Implemented by GreenhouseTemplate. Not often used directly, but a useful option to enhance testability, as it can easily be mocked or stubbed.

The methods contained in this interface require OAuth authentication with Greenhouse. When a method's description speaks of the "current user", it is referring to the user for whom access has been granted.


Method Summary
 java.util.List<Event> getEventsAfter(java.util.Date date)
          Retrieve a list of events that take place after a given time.
 java.util.List<EventSession> getSessionsOnDay(long eventId, java.util.Date date)
          Retrieves a list of sessions for an event that take place on a given day.
 java.util.List<Event> getUpcomingEvents()
          Retrieve a list of upcoming events.
 GreenhouseProfile getUserProfile()
          Retrieve the current user's Greenhouse profile information.
 

Method Detail

getUserProfile

GreenhouseProfile getUserProfile()
Retrieve the current user's Greenhouse profile information.

Returns:
the user's profile information.

getUpcomingEvents

java.util.List<Event> getUpcomingEvents()
Retrieve a list of upcoming events.

Returns:
A list of events that take place after the current time.

getEventsAfter

java.util.List<Event> getEventsAfter(java.util.Date date)
Retrieve a list of events that take place after a given time.

Parameters:
date - the starting point used to filter the list of events.
Returns:
a list of events that take place after the given time.

getSessionsOnDay

java.util.List<EventSession> getSessionsOnDay(long eventId,
                                              java.util.Date date)
Retrieves a list of sessions for an event that take place on a given day.

Parameters:
eventId - the ID of the event
date - the day to retrieve events for
Returns:
a list of sessions for the given event and day