edu.wisc.cae.emsclient

Class EmsClient

java.lang.Object

org.springframework.ws.client.core.support.WebServiceGatewaySupport

edu.wisc.cae.emsclient.EmsClient

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class EmsClient
extends org.springframework.ws.client.core.support.WebServiceGatewaySupport

Field Summary

Fields inherited from class org.springframework.ws.client.core.support.WebServiceGatewaySupport

logger

Constructor Summary

Constructors

Constructor and Description
EmsClient(String login, String password, org.springframework.ws.client.core.WebServiceTemplate template) EmsClient Constructor

Method Summary

Modifier and Type	Method and Description
Integer	addBooking(int reservationID, int roomID, Date bookingDate, Date startTime, Date endTime, String eventName, int statusID) Adds a booking to a Reservation in EMS
ReservationAddResult	addReservation(int groupID, int roomID, Date bookingDate, Date startTime, Date endTime, String eventName, int statusID) Creates a Reservation in EMS
Integer	addUDF(int parentLevelID, int parentID, int udfDefID, String udfValue) Add a user defined field to a reservation or booking parentLevelID is 0 for reservation, 1 for booking
List<BookingDetail>	getAllBookings(Date startDate, Date endDate, int buildingID, boolean viewComboRoomComponents) Get all bookings for a building for the specified date range.
List<BookingDetail>	getAllBookings2(Date startDate, Date endDate, int buildingID, boolean viewComboRoomComponents, int udfDefID, String udfValue) Get all bookings for the specified date range and buillding.
List<EMSRoomComponent>	getAllComboRoomComponents() Get all combo room components
List<BookingDetail>	getAllRoomBookings(Date startDate, Date endDate, int roomID, boolean viewComboRoomComponents) Search for all bookings in the specified room
List<EMSRoom>	getAllRooms(int buildingID) Get all rooms for the specified building.
APIVersion	getApiVersion() Return the version of the API running on the server
List<EMSArea>	getAreas(int areaID) Get the area details about the specified area.
BookingDetail	getBooking(int bookingID) Get the details for the specified booking ID
List<BookingDetail>	getBookings(Date startDate, Date endDate, List<Integer> buildings, List<Integer> statuses, List<Integer> eventTypes, List<Integer> groupTypes, boolean viewComboRoomComponents) Returns a list of bookings based on the filters provided If a specific filter that is optional and not needed to be filtered on, send a null parameter in.
List<BookingDetail>	getBookings2(int reservationID, Date startDate, Date endDate, List<Integer> buildings, List<Integer> statusTypes, List<Integer> eventTypes, List<Integer> groupTypes, boolean viewComboRoomComponents) Returns a list of bookings based on filters provided and Reservation ID
List<BuildingHoliday>	getBuildingHolidays(List<Integer> buildings, Date requestDate) Returns a list of holidays for a specific date
List<EMSBuildingHours>	getBuildingHours(List<Integer> buildings, Date requestDate) Returns a list of building hours for a specific date
List<Building>	getBuildings() Returns a list of buildings
List<EMSCategory>	getCategories(int buildingID) This API retrieves EMS category information.
List<EMSCategoryState>	getCategoryStates(int categoryID) This API retrieves EMS category state information.
List<BookingDetail>	getChangedBookings(Date startDate, Date endDate, List<Integer> rooms, List<Integer> statuses, List<Integer> eventTypes, List<Integer> groupTypes, boolean viewComboRoomComponents) This call will return bookings that have been changed between the specified start/end dates (date changed field search) and the other filters provided.
List<EMSRoomComponent>	getComboRoomComponents(int roomid) Returns component room details for a specific combo room
List<EMSCommentType>	getCommentTypes() Returns a list of comment types
List<EMSContactDetail>	getContactDetails(int contactID) Returns details for a specific Contact
List<EMSContact>	getContacts(int groupID) Returns Contact list for a Group
List<EMSEventType>	getEventTypes() Returns a list of event types
List<EMSFeature>	getFeatures(int buildingID) Returns a list of Features
List<BookingDetail>	getGroupBookings(Date startDate, Date endDate, int groupID, List<Integer> statuses, List<Integer> statusTypes, boolean viewComboRoomComponents) Returns a list of bookings for a group based on filters provided
List<EMSGroupDetail>	getGroupDetails(int groupID) Returns details for a specific Group
List<EMSGroup>	getGroups(String nameFilter, String emailFilter) Returns a list of groups
List<EMSGroupType>	getGroupTypes() Returns a list of group types
List<EMSPricingMethod>	getPricingMethods() This API returns active pricing methods to use with Service Order Detail API calls.
List<EMSComment>	getReservationComments(int reservationID) Returns Comments list for a Reservation
List<EMSReservationSource>	getReservationSources() Returns a list of Reservation Sources
List<EMSResource>	getResources(int categoryID) This API returns active resource information for the category entered.
boolean	getRoomAvailability(int roomID, Date bookingDate, Date startTime, Date endTime) Returns whether a room is available or not
List<BookingDetail>	getRoomBookings(Date startDate, Date endDate, int roomID, List<Integer> statuses, List<Integer> eventTypes, List<Integer> groupTypes, boolean viewComboRoomComponents) Returns a list of bookings for a specific room based on filters provided
EMSRoomDetail	getRoomDetails(int roomID) Returns details for a specific room
List<EMSRoom>	getRooms(List<Integer> buildings) Returns list of rooms for multiple buildings
List<EMSSetupType>	getSetupTypes() Returns a list of event types
List<EMSStatus>	getStatuses() Returns a list of statuses
List<UDFDefinition>	getUDFDefinitions() Returns a list of User Defined Field Definitions
List<EMSMessage>	updateBooking(int bookingID, Date bookingDate, Date startTime, Date endTime, int statusID, int roomID) Updates a single Booking in EMS
List<EMSMessage>	updateBooking2(int bookingID, Date bookingDate, Date startTime, Date endTime, int statusID, int roomID, String eventName) Updates a single Booking in EMS, includes event name
List<EMSMessage>	updateReservation(int reservationID, int bookingID, int webUserID, int webTemplateID, int reservationSourceID, String billingReference) Updates a single Reservation in EMS

Methods inherited from class org.springframework.ws.client.core.support.WebServiceGatewaySupport

afterPropertiesSet, getDefaultUri, getDestinationProvider, getInterceptors, getMarshaller, getMessageFactory, getMessageSenders, getUnmarshaller, getWebServiceTemplate, initGateway, setDefaultUri, setDestinationProvider, setInterceptors, setMarshaller, setMessageFactory, setMessageSender, setMessageSenders, setUnmarshaller, setWebServiceTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmsClient

public EmsClient(String login,
                 String password,
                 org.springframework.ws.client.core.WebServiceTemplate template)

EmsClient Constructor

Parameters:

login - The login name to use for request to the EMS Server

password - The password for the EMS account

template - The web Service Template for the service to use

Method Detail

addBooking

public Integer addBooking(int reservationID,
                          int roomID,
                          Date bookingDate,
                          Date startTime,
                          Date endTime,
                          String eventName,
                          int statusID)
                   throws EmsException

Adds a booking to a Reservation in EMS

Parameters:

reservationID - The reservation ID to add the booking to

roomID - The Room ID for the booking

bookingDate - The booking date (time values must be zero)

startTime - The start time for the booking

endTime - The end time for the booking

eventName - The name of the event

statusID - The status ID for the event

Returns:

Returns the ID for the booking just added

Throws:

EmsException - Thrown on error

Since:

1.1

addReservation

public ReservationAddResult addReservation(int groupID,
                                           int roomID,
                                           Date bookingDate,
                                           Date startTime,
                                           Date endTime,
                                           String eventName,
                                           int statusID)
                                    throws EmsException

Creates a Reservation in EMS

Parameters:

groupID - The ID for the group

roomID - The room ID for the first booking

bookingDate - The date of the first booking

startTime - The start time of the first booking

endTime - The end time of the first booking

eventName - The name of the event

statusID - The status ID for the event

Returns:

Returns a ReservationAddResult containing the Rerservation ID and Booking ID

Throws:

EmsException - Thrown on exception

Since:

1.1

addUDF

public Integer addUDF(int parentLevelID,
                      int parentID,
                      int udfDefID,
                      String udfValue)
               throws EmsException

Add a user defined field to a reservation or booking parentLevelID is 0 for reservation, 1 for booking

Parameters:

parentLevelID - 0 for reservation, 1 for booking

parentID - The ID of the reservation or booking

udfDefID - The ID of the UDF Type

udfValue - The value for the UDF

Returns:

Returns the unique UDFID of the entry that was added

Throws:

EmsException - Thrown on error

Since:

1.1

getAllBookings

public List<BookingDetail> getAllBookings(Date startDate,
                                          Date endDate,
                                          int buildingID,
                                          boolean viewComboRoomComponents)
                                   throws EmsException

Get all bookings for a building for the specified date range. To get all buildings, send the buildingID as -1

Parameters:

startDate - The Start Date to get bookings for

endDate - The end date to get bookings for (single day, use same as start date)

buildingID - The ID of the building to get bookings for. Send -1 for all buildings

viewComboRoomComponents - Should combo room components be returned

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getAllBookings2

public List<BookingDetail> getAllBookings2(Date startDate,
                                           Date endDate,
                                           int buildingID,
                                           boolean viewComboRoomComponents,
                                           int udfDefID,
                                           String udfValue)
                                    throws EmsException

Get all bookings for the specified date range and buillding. Similar to getAllBookings, but this time you can search for a UDF type / Value pair to be present on the reservation or booking as a filter.

Parameters:

startDate - The first date to return bookings for

endDate - The last date to return bookings for

buildingID - The ID of the building to get bookings for, use -1 for all buildings

viewComboRoomComponents - Should combo room compontents be included

udfDefID - The ID of the UDF Type to filter on

udfValue - The value of the UDF to filter on

Returns:

returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getAllComboRoomComponents

public List<EMSRoomComponent> getAllComboRoomComponents()
                                                 throws EmsException

Get all combo room components

Returns:

Returns a List of EMSRoomComponent

Throws:

EmsException - Thrown on error

Since:

1.1

getAllRoomBookings

public List<BookingDetail> getAllRoomBookings(Date startDate,
                                              Date endDate,
                                              int roomID,
                                              boolean viewComboRoomComponents)
                                       throws EmsException

Search for all bookings in the specified room

Parameters:

startDate - The first date to get bookings for

endDate - The last date to get bookings for

roomID - The ID of the room to get bookings for

viewComboRoomComponents - Should combo room components be included

Returns:

Returns aList of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getAllRooms

public List<EMSRoom> getAllRooms(int buildingID)
                          throws EmsException

Get all rooms for the specified building. Set buildingID to -1 if you want all rooms for all buildings returned.

Parameters:

buildingID - The Building ID to get rooms for, -1 for all buildings

Returns:

Returns a List of EMSRoom

Throws:

EmsException - Thrown on error

Since:

1.1

getApiVersion

public APIVersion getApiVersion()
                         throws EmsException

Return the version of the API running on the server

Returns:

Returns APIVersion

Throws:

EmsException - Thrown on error

Since:

1.1

getAreas

public List<EMSArea> getAreas(int areaID)
                       throws EmsException

Get the area details about the specified area. Use -1 to return all areas.

Parameters:

areaID - The ID of the area to get information about, -1 to return all areas

Returns:

Returns a List of EMSArea

Throws:

EmsException - Thrown on error

Since:

1.1

getBooking

public BookingDetail getBooking(int bookingID)
                         throws EmsException

Get the details for the specified booking ID

Parameters:

bookingID - The ID of the booking to get details for

Returns:

Returns BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getBookings

public List<BookingDetail> getBookings(Date startDate,
                                       Date endDate,
                                       List<Integer> buildings,
                                       List<Integer> statuses,
                                       List<Integer> eventTypes,
                                       List<Integer> groupTypes,
                                       boolean viewComboRoomComponents)
                                throws EmsException

Returns a list of bookings based on the filters provided If a specific filter that is optional and not needed to be filtered on, send a null parameter in. A List of zero items will send a zero item list to the server, most likely resulting in no items returned.

Parameters:

startDate - The first date to search from

endDate - The last date to search from

buildings - (optional) The list of buildings to search

statuses - (optional) The list of status types to search

eventTypes - (optional) The list of event types to search

groupTypes - (optional) The list of group types to search

viewComboRoomComponents - Should combo room components be returned

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getBookings2

public List<BookingDetail> getBookings2(int reservationID,
                                        Date startDate,
                                        Date endDate,
                                        List<Integer> buildings,
                                        List<Integer> statusTypes,
                                        List<Integer> eventTypes,
                                        List<Integer> groupTypes,
                                        boolean viewComboRoomComponents)
                                 throws EmsException

Returns a list of bookings based on filters provided and Reservation ID

Parameters:

reservationID - the reservation ID to get bookings for

startDate - The first date to return bookings for

endDate - The last date to return bookings for

buildings - (optional) A list of buildings to get bookings for

statusTypes - (optional) A list of status types to get bookings for

eventTypes - (optional) A list of event types to get bookings for

groupTypes - (optional) A List of group types to get bookings for

viewComboRoomComponents - View combo room components

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getBuildingHolidays

public List<BuildingHoliday> getBuildingHolidays(List<Integer> buildings,
                                                 Date requestDate)
                                          throws EmsException

Returns a list of holidays for a specific date

Parameters:

buildings - The lsit of buildings to get holiday info for

requestDate - The date to get holiday info for

Returns:

Returns a List of BuildingHoliday

Throws:

EmsException - Thrown on error

Since:

1.1

getBuildingHours

public List<EMSBuildingHours> getBuildingHours(List<Integer> buildings,
                                               Date requestDate)
                                        throws EmsException

Returns a list of building hours for a specific date

Parameters:

buildings - (optional) A list of buildings to get hours for

requestDate - The date to get building hours for

Returns:

Returns a List of EMSBuildingHours

Throws:

EmsException - Thrown on error

Since:

1.1

getBuildings

public List<Building> getBuildings()
                            throws EmsException

Returns a list of buildings

Returns:

Returns a {#link List} of Building

Throws:

EmsException - Thrown on error

Since:

1.1

getCategories

public List<EMSCategory> getCategories(int buildingID)
                                throws EmsException

This API retrieves EMS category information. By passing a building parameter, it will only return categories valid for the building ID entered

Parameters:

buildingID - The ID of the building to get categories for

Returns:

Returns a List of EMSCategory

Throws:

EmsException - Thrown on error

Since:

3.0

getCategoryStates

public List<EMSCategoryState> getCategoryStates(int categoryID)
                                         throws EmsException

This API retrieves EMS category state information. By passing a category parameter, it will only return categories valid for the building ID entered

Parameters:

categoryID - The ID of the category to get states for

Returns:

Returns a List of EMSCategoryState

Throws:

EmsException - Thrown on error

Since:

3.0

getChangedBookings

public List<BookingDetail> getChangedBookings(Date startDate,
                                              Date endDate,
                                              List<Integer> rooms,
                                              List<Integer> statuses,
                                              List<Integer> eventTypes,
                                              List<Integer> groupTypes,
                                              boolean viewComboRoomComponents)
                                       throws EmsException

This call will return bookings that have been changed between the specified start/end dates (date changed field search) and the other filters provided. To ignore the filter entries that are optional, send in null.

Parameters:

startDate - The starting date to search

endDate - The ending date to search

rooms - (optional) the list of rooms to search

statuses - (optional) the list of status types to search

eventTypes - (optional) the list of event types to search

groupTypes - (optional) the list of group types to search

viewComboRoomComponents - return combo room components

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getComboRoomComponents

public List<EMSRoomComponent> getComboRoomComponents(int roomid)
                                              throws EmsException

Returns component room details for a specific combo room

Parameters:

roomid - The ID of the room to get components for

Returns:

Returns a List of EMSRoomComponent

Throws:

EmsException - Thrown on error

Since:

1.1

getCommentTypes

public List<EMSCommentType> getCommentTypes()
                                     throws EmsException

Returns a list of comment types

Returns:

Returns a List of EMSCommentType

Throws:

EmsException - Thrown on error

Since:

1.1

getContactDetails

public List<EMSContactDetail> getContactDetails(int contactID)
                                         throws EmsException

Returns details for a specific Contact

Parameters:

contactID - The ID of the contact to get details for

Returns:

Returns a List of EMSContactDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getContacts

public List<EMSContact> getContacts(int groupID)
                             throws EmsException

Returns Contact list for a Group

Parameters:

groupID - The ID of the group to get contacts for

Returns:

Returns a List of EMSContact

Throws:

EmsException - Thrown on error

Since:

1.1

getEventTypes

public List<EMSEventType> getEventTypes()
                                 throws EmsException

Returns a list of event types

Returns:

Returns a List of EMSEventType

Throws:

EmsException - Thrown on error

Since:

1.1

getFeatures

public List<EMSFeature> getFeatures(int buildingID)
                             throws EmsException

Returns a list of Features

Parameters:

buildingID - The ID of the building to get features for, -1 for all buildings

Returns:

Returns a List of EMSFeature

Throws:

EmsException - Thrown on error

Since:

1.1

getGroupBookings

public List<BookingDetail> getGroupBookings(Date startDate,
                                            Date endDate,
                                            int groupID,
                                            List<Integer> statuses,
                                            List<Integer> statusTypes,
                                            boolean viewComboRoomComponents)
                                     throws EmsException

Returns a list of bookings for a group based on filters provided

Parameters:

startDate - The date to start getting bookings for

endDate - The last date to return bookings for

groupID - The ID of the group to get bookings for

statuses - (optional) The list of statuses to get bookings for

statusTypes - (optional) The list of status types to get bookings for

viewComboRoomComponents - Return combo room components

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getGroupDetails

public List<EMSGroupDetail> getGroupDetails(int groupID)
                                     throws EmsException

Returns details for a specific Group

Parameters:

groupID - The ID of the group to get details for

Returns:

Returns a List of EMSGroupDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getGroups

public List<EMSGroup> getGroups(String nameFilter,
                                String emailFilter)
                         throws EmsException

Returns a list of groups

Parameters:

nameFilter - A name filter to use

emailFilter - An email filter to use

Returns:

Returns a List of EMSGroup

Throws:

EmsException - Thrown on error

Since:

1.1

getGroupTypes

public List<EMSGroupType> getGroupTypes()
                                 throws EmsException

Returns a list of group types

Returns:

Returns a List of EMSGroupType

Throws:

EmsException - Thrown on error

Since:

1.1

getPricingMethods

public List<EMSPricingMethod> getPricingMethods()
                                         throws EmsException

This API returns active pricing methods to use with Service Order Detail API calls.

Returns:

Returns a List of EMSPricingMethod

Throws:

EmsException - Thrown on error

Since:

1.1

getReservationComments

public List<EMSComment> getReservationComments(int reservationID)
                                        throws EmsException

Returns Comments list for a Reservation

Parameters:

reservationID - The ID of the reservation to get comments for

Returns:

Returns a List of EMSComment

Throws:

EmsException - Thrown on error

Since:

1.1

getReservationSources

public List<EMSReservationSource> getReservationSources()
                                                 throws EmsException

Returns a list of Reservation Sources

Returns:

Returns a List of EMSReservationSource

Throws:

EmsException - Thrown on error

Since:

1.1

getResources

public List<EMSResource> getResources(int categoryID)
                               throws EmsException

This API returns active resource information for the category entered.

Parameters:

categoryID - The ID of the category to get resources for

Returns:

Returns a List of EMSResource

Throws:

EmsException - Thrown on error

Since:

3.0

getRoomAvailability

public boolean getRoomAvailability(int roomID,
                                   Date bookingDate,
                                   Date startTime,
                                   Date endTime)
                            throws EmsException

Returns whether a room is available or not

Parameters:

roomID - The ID of the room to check

bookingDate - The date of the booking

startTime - The start time of the booking

endTime - The end time of the booking

Returns:

Returns true if the room is available

Throws:

EmsException - Thrown on error

Since:

1.1

getRoomBookings

public List<BookingDetail> getRoomBookings(Date startDate,
                                           Date endDate,
                                           int roomID,
                                           List<Integer> statuses,
                                           List<Integer> eventTypes,
                                           List<Integer> groupTypes,
                                           boolean viewComboRoomComponents)
                                    throws EmsException

Returns a list of bookings for a specific room based on filters provided

Parameters:

startDate - The first date to get bookings for

endDate - The last date to get bookings for

roomID - The ID of the room to get bookings for

statuses - (optional) The list of statuses to get

eventTypes - (optional) The list of event types to get

groupTypes - (optional) The list of groups to get

viewComboRoomComponents - Return combo room components

Returns:

Returns a List of BookingDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getRoomDetails

public EMSRoomDetail getRoomDetails(int roomID)
                             throws EmsException

Returns details for a specific room

Parameters:

roomID - The ID of the room to get details for

Returns:

Returns EMSRoomDetail

Throws:

EmsException - Thrown on error

Since:

1.1

getRooms

public List<EMSRoom> getRooms(List<Integer> buildings)
                       throws EmsException

Returns list of rooms for multiple buildings

Parameters:

buildings - (optional) The list of buildings to get rooms for

Returns:

Returns a List of EMSRoom

Throws:

EmsException - Thrown on error

Since:

1.1

getSetupTypes

public List<EMSSetupType> getSetupTypes()
                                 throws EmsException

Returns a list of event types

Returns:

Returns a List of EMSSetupType

Throws:

EmsException - Thrown on error

Since:

1.1

getStatuses

public List<EMSStatus> getStatuses()
                            throws EmsException

Returns a list of statuses

Returns:

Returns a List of EMSStatus

Throws:

EmsException - Thrown on error

Since:

1.1

getUDFDefinitions

public List<UDFDefinition> getUDFDefinitions()
                                      throws EmsException

Returns a list of User Defined Field Definitions

Returns:

Returns a List of UDFDefinition

Throws:

EmsException - Thrown on error

Since:

1.1

updateBooking

public List<EMSMessage> updateBooking(int bookingID,
                                      Date bookingDate,
                                      Date startTime,
                                      Date endTime,
                                      int statusID,
                                      int roomID)
                               throws EmsException

Updates a single Booking in EMS

Parameters:

bookingID - The ID of the booking to update

bookingDate - The date for the booking

startTime - The start time of the event

endTime - The end time of the event

statusID - The status for the event

roomID - The room for the booking

Returns:

Returns an EMSMessage

Throws:

EmsException - Thrown on error

Since:

1.1

updateBooking2

public List<EMSMessage> updateBooking2(int bookingID,
                                       Date bookingDate,
                                       Date startTime,
                                       Date endTime,
                                       int statusID,
                                       int roomID,
                                       String eventName)
                                throws EmsException

Updates a single Booking in EMS, includes event name

Parameters:

bookingID - The ID of the booking to update

bookingDate - The date for the booking

startTime - The start time of the booking

endTime - The end time of the booking

statusID - The status of the booking

roomID - The ID for the room of the booking

eventName - The name for the event

Returns:

Returns a EMSMessage

Throws:

EmsException - Thrown on error

Since:

1.1

updateReservation

public List<EMSMessage> updateReservation(int reservationID,
                                          int bookingID,
                                          int webUserID,
                                          int webTemplateID,
                                          int reservationSourceID,
                                          String billingReference)
                                   throws EmsException

Updates a single Reservation in EMS

Parameters:

reservationID - The ID of the reservation to update, use -1 to update booking

bookingID - The ID of the booking, use -1 to update reservation

webUserID - The ID of the web user, 0=none, -1=no change

webTemplateID - The ID of the web template, 0=none, -1=no change

reservationSourceID - The ID of the reservation source 0=none, -1=no change

billingReference - The billing reference for the booking

Returns:

Returns a List of EMSMessage

Throws:

EmsException - Thrown on error

Since:

1.1