com.client.core.soap.service

Interface BullhornAPI

All Known Implementing Classes:

BullhornAPISoap

public interface BullhornAPI

Main bullhorn api utility class. Handles session creation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	assembleOpenWindowLink(ApiEntityName entity, java.lang.Integer id) Returns a full open window link to the ApiEntityName with the passed in id.
java.lang.String	assembleOpenWindowLink(java.lang.String hostName, ApiEntityName entity, java.lang.Integer id)
<T extends AbstractDto> void	delete(T entity) Deletes an entity
<T extends AbstractDto> T	findEntity(java.lang.String entityType, java.lang.Object id) Finds an entity of type entityType with the passed in id
UserTypeDto	findUserType(int id) Finds the user type of a Corporate User using the id of the user type
ApplicationSettings	getAppSettings()
BullhornLogDAO	getBullhornLogDAO()
int	getCorporationID()
<T extends AbstractDto> java.util.List<T>	getDtosFromIds(java.lang.String entityType, java.util.List<java.lang.Object> ids) Returns a List containing a type of AbstractDto
java.lang.String	getHostName()
<T extends AbstractDto> java.util.List<T>	getQueryResults(java.lang.String entityType, DtoQuery dtoQuery) Takes a dto query and an entity type and returns the result in List
ApiService	getService()
java.lang.String	getSession()
java.util.List<SubscriptionEvent>	getSubscriptionEvents(int numberRequested, java.lang.String subscriptionName) Retreives a list of SubscriptionEvents based on the subscription name passed in.
ApiQueryResult	query(DtoQuery query)
ApiSaveResult	save(AbstractDto entity) Persist an entity to Bullhorn
<T extends AbstractDto> void	saveDtos(java.util.List<T> dtoList) Persist a list of AbstractDtos to Bullhorn
void	setSession(java.lang.String session)

Method Detail

getSubscriptionEvents

java.util.List<SubscriptionEvent> getSubscriptionEvents(int numberRequested,
                                                        java.lang.String subscriptionName)

Retreives a list of SubscriptionEvents based on the subscription name passed in.

Parameters:

numberRequested - the number of events to pull off the queue each time

subscriptionName - the name of the specific subscription

Returns:

a list of SubscriptionEvents generated by bullhorn

findEntity

<T extends AbstractDto> T findEntity(java.lang.String entityType,
                                     java.lang.Object id)

Finds an entity of type entityType with the passed in id

Parameters:

entityType -

id -

Returns:

delete

<T extends AbstractDto> void delete(T entity)

Deletes an entity

Parameters:

entity -

findUserType

UserTypeDto findUserType(int id)

Finds the user type of a Corporate User using the id of the user type

Parameters:

id - the id of the user type

Returns:

a UserTypeDto or null if no user type found

getQueryResults

<T extends AbstractDto> java.util.List<T> getQueryResults(java.lang.String entityType,
                                                          DtoQuery dtoQuery)

Takes a dto query and an entity type and returns the result in List

Parameters:

entityType - the bullhorn entity type, see ApiEntityName

dtoQuery - a query

Returns:

A list of DTOs of type entityType based on the dtoQuery.

getDtosFromIds

<T extends AbstractDto> java.util.List<T> getDtosFromIds(java.lang.String entityType,
                                                         java.util.List<java.lang.Object> ids)

Returns a List containing a type of AbstractDto

Parameters:

entityType - the entity type to return

ids - the list of entity ids

Returns:

query

ApiQueryResult query(DtoQuery query)

save

ApiSaveResult save(AbstractDto entity)

Persist an entity to Bullhorn

Parameters:

entity - the entity to persist

Returns:

ApiSaveResult

saveDtos

<T extends AbstractDto> void saveDtos(java.util.List<T> dtoList)

Persist a list of AbstractDtos to Bullhorn

Parameters:

dtoList - the entities to persist

getService

ApiService getService()

getSession

java.lang.String getSession()

setSession

void setSession(java.lang.String session)

getCorporationID

int getCorporationID()

getAppSettings

ApplicationSettings getAppSettings()

getBullhornLogDAO

BullhornLogDAO getBullhornLogDAO()

getHostName

java.lang.String getHostName()

assembleOpenWindowLink

java.lang.String assembleOpenWindowLink(java.lang.String hostName,
                                        ApiEntityName entity,
                                        java.lang.Integer id)

assembleOpenWindowLink

java.lang.String assembleOpenWindowLink(ApiEntityName entity,
                                        java.lang.Integer id)

Returns a full open window link to the ApiEntityName with the passed in id.

Parameters:

entity -

id -

Returns: