com.exlibris.dps.sdk.producer

Interface ProducerWebServices

All Superinterfaces:

com.exlibris.core.infra.svc.api.GenericWebService

public interface ProducerWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService

Defines the API for creating/getting/removing/updating Producers, Producer Agents, and contacts.

Author:

zvif

Method Summary

Modifier and Type	Method and Description
java.lang.String	createContact(java.lang.String pdsHandle, java.lang.String userInfoXML) API for creating a new contact.
java.lang.String	createProducer(java.lang.String pdsHandle, java.lang.String producerInfoXml) API for creating a new Producer.
java.lang.String	createProducerAgent(java.lang.String pdsHandle, java.lang.String userInfoXML) API for creating a new Producer Agent.
java.lang.String	getContact(java.lang.String pdsHandle, java.lang.String userId) API for retrieving an existing contact.
java.lang.String	getInternalUserIdByExternalId(java.lang.String externalId) API for getting the InternalId by ExternalId(userName).
java.lang.String	getMaterialFlowsOfProducer(java.lang.String producerId) API for getting a material flow list for the given Producer
java.lang.String	getProducerAgent(java.lang.String pdsHandle, java.lang.String userId) API for retrieving an existing Producer Agent.
java.lang.String	getProducerDetails(java.lang.String pdsHandle, java.lang.String prodcuerId) API for retrieving an existing Producer.
java.lang.String	getProducersOfProducerAgent(java.lang.String producerAgentId) API for getting a list of Producers that are attached to the given Producer Agent
java.lang.String	getProducersOfProducerAgentWithIns(java.lang.String producerAgentId, java.lang.String institution) API for getting a list of Producers that are attached to the given Producer Agent
java.lang.String	isUserExists(java.lang.String pdsHandle, java.lang.String userName) API for checking if user exist in the system
java.lang.String	linkContactToProdcuer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String userId, java.lang.String primaryContact) Deprecated. Replaced by: linkContactToProducer(String, String, String, String)
java.lang.String	linkContactToProducer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String userId, java.lang.String primaryContact)
java.lang.String	linkProducerAgentToProdcuer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String producerAgentId) Deprecated.
java.lang.String	linkProducerAgentToProducer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String producerAgentId) API for linking a Producer Agent to a Producer
java.lang.String	removeContact(java.lang.String pdsHandle, java.lang.String userID) API for removing an existing contact.
java.lang.String	removeProducer(java.lang.String pdsHandle, java.lang.String prodcuerId) API for removing an existing Producer.
java.lang.String	removeProducerAgent(java.lang.String pdsHandle, java.lang.String userId) API for removing an existing Producer Agent.
java.lang.String	unLinkContactFromProdcuer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String userId) Deprecated.
java.lang.String	unLinkContactFromProducer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String userId) API for unlinking a Producer Agent from a Producer
java.lang.String	unLinkProducerAgentFromProdcuer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String producerAgentId) Deprecated.
java.lang.String	unLinkProducerAgentFromProducer(java.lang.String pdsHandle, java.lang.String producerId, java.lang.String producerAgentId) API for unlinking a Producer Agent from a Producer
java.lang.String	updateContact(java.lang.String pdsHandle, java.lang.String userId, java.lang.String userInfoXML) API for updating an existing contact.
java.lang.String	updateProducer(java.lang.String pdsHandle, java.lang.String prodcuerId, java.lang.String producerInfoXml) API for updating an existing Producer.
java.lang.String	updateProducerAgent(java.lang.String pdsHandle, java.lang.String userId, java.lang.String userInfoXml) API for updating an existing Producer Agent.

Methods inherited from interface com.exlibris.core.infra.svc.api.GenericWebService

getHeartBit

Method Detail

getProducersOfProducerAgent

java.lang.String getProducersOfProducerAgent(java.lang.String producerAgentId)

API for getting a list of Producers that are attached to the given Producer Agent

Parameters:

producerAgentId - the ID of the Producer Agent

Returns:

a list of Producers that are attached to the given Producer Agent.

getProducersOfProducerAgentWithIns

java.lang.String getProducersOfProducerAgentWithIns(java.lang.String producerAgentId,
                                                    java.lang.String institution)

API for getting a list of Producers that are attached to the given Producer Agent

Parameters:

producerAgentId - the ID of the Producer Agent

institution -

Returns:

a list of Producers that are attached to the given Producer Agent and institution.

getMaterialFlowsOfProducer

java.lang.String getMaterialFlowsOfProducer(java.lang.String producerId)
                                     throws java.lang.Exception

API for getting a material flow list for the given Producer

Parameters:

producerId - the ID of the Producer

Returns:

list of the Producer's material flows

Throws:

java.lang.Exception

getInternalUserIdByExternalId

java.lang.String getInternalUserIdByExternalId(java.lang.String externalId)

API for getting the InternalId by ExternalId(userName).

Parameters:

externalId -

Returns:

internalId

createProducer

java.lang.String createProducer(java.lang.String pdsHandle,
                                java.lang.String producerInfoXml)

API for creating a new Producer.

Parameters:

pdsHandle - of a logged-in user

producerInfoXml - created using the producer_info.xsd; holds all the data needed for creating a Producer

Returns:

XML reply created using the ws_response.xsd. If a new Producer is created, an ID is returned and if this action fails, an error is returned.

removeProducer

java.lang.String removeProducer(java.lang.String pdsHandle,
                                java.lang.String prodcuerId)

API for removing an existing Producer.

Parameters:

pdsHandle - of a logged-in user

producerId - of the existing Producer to be removed

Returns:

XML reply created using the ws_response.xsd. If an existing Producer is removed, an ID is returned and if this action fails, an error is returned.

updateProducer

java.lang.String updateProducer(java.lang.String pdsHandle,
                                java.lang.String prodcuerId,
                                java.lang.String producerInfoXml)

API for updating an existing Producer.

Parameters:

pdsHandle - of a logged-in user

producerId - of the existing Producer to be updated

producerInfoXml - created using the producer_info.xsd; holds all the data needed for updating an existing Producer

Returns:

XML reply created using the ws_response.xsd. If the Producer is updated, an ID is returned and if this action fails, an error is returned.

getProducerDetails

java.lang.String getProducerDetails(java.lang.String pdsHandle,
                                    java.lang.String prodcuerId)

API for retrieving an existing Producer.

Parameters:

pdsHandle - of a logged-in user

producerId - of the existing Producer to be retrieved

Returns:

XML reply created using the producer_info.xsd. Returns the requested Producer data; if this action fails, an error is returned using the ws_response.xsd.

createProducerAgent

java.lang.String createProducerAgent(java.lang.String pdsHandle,
                                     java.lang.String userInfoXML)

API for creating a new Producer Agent.

Parameters:

pdsHandle - of a logged-in user

userInfoXml - created using the user_info.xsd; holds all the data needed for creating a new Producer Agent

Returns:

XML reply created using the ws_response.xsd. If a new Producer Agent is created, an ID is returned and if this action fails, an error is returned.

removeProducerAgent

java.lang.String removeProducerAgent(java.lang.String pdsHandle,
                                     java.lang.String userId)

API for removing an existing Producer Agent.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing Producer Agent to be removed

Returns:

XML reply created using the ws_response.xsd. If an existing Producer Agent is removed, an ID is returned and if this action fails, an error is returned.

updateProducerAgent

java.lang.String updateProducerAgent(java.lang.String pdsHandle,
                                     java.lang.String userId,
                                     java.lang.String userInfoXml)

API for updating an existing Producer Agent.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing Producer Agent to be updated

userInfoXml - created using the user_info.xsd; holds all the data needed for updating an existing Producer Agent

Returns:

XML reply created using the ws_response.xsd. If an existing Producer Agent is updated, an ID is returned and if this action fails, an error is returned.

getProducerAgent

java.lang.String getProducerAgent(java.lang.String pdsHandle,
                                  java.lang.String userId)

API for retrieving an existing Producer Agent.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing Producer Agent to be retrieved

Returns:

XML reply created using the user_info.xsd. Returns the requested Producer Agent data; if this action fails, an error is returned using the ws_response.xsd.

linkProducerAgentToProdcuer

@Deprecated
java.lang.String linkProducerAgentToProdcuer(java.lang.String pdsHandle,
                                                         java.lang.String producerId,
                                                         java.lang.String producerAgentId)

Deprecated.

API for linking a Producer Agent to a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be linked to

producerAgentId - of the Producer Agent to be linked

Returns:

reply created using the ws_response.xsd; if this action fails, an error is returned

linkProducerAgentToProducer

java.lang.String linkProducerAgentToProducer(java.lang.String pdsHandle,
                                             java.lang.String producerId,
                                             java.lang.String producerAgentId)

API for linking a Producer Agent to a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be linked to

producerAgentId - of the Producer Agent to be linked

Returns:

reply created using the ws_response.xsd; if this action fails, an error is returned

unLinkProducerAgentFromProdcuer

@Deprecated
java.lang.String unLinkProducerAgentFromProdcuer(java.lang.String pdsHandle,
                                                             java.lang.String producerId,
                                                             java.lang.String producerAgentId)

Deprecated.

API for unlinking a Producer Agent from a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be unlinked from

producerAgentId - of the Producer Agent to be unlinked

Returns:

reply created using the ws_response.xsd; if this action fails, an error is returned

unLinkProducerAgentFromProducer

java.lang.String unLinkProducerAgentFromProducer(java.lang.String pdsHandle,
                                                 java.lang.String producerId,
                                                 java.lang.String producerAgentId)

API for unlinking a Producer Agent from a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be unlinked from

producerAgentId - of the Producer Agent to be unlinked

Returns:

reply created using the ws_response.xsd; if this action fails, an error is returned

createContact

java.lang.String createContact(java.lang.String pdsHandle,
                               java.lang.String userInfoXML)

API for creating a new contact.

Parameters:

pdsHandle - of a logged-in user

userInfoXml - created using the user_info.xsd; holds all the data needed for creating a new contact

Returns:

XML reply created using the ws_response.xsd; if this action is successful, an ID is returned and if it fails, an error is returned

removeContact

java.lang.String removeContact(java.lang.String pdsHandle,
                               java.lang.String userID)

API for removing an existing contact.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing contact to be removed

Returns:

XML reply created using the ws_response.xsd. If this action is successful, an ID is returned and if it fails, an error is returned.

updateContact

java.lang.String updateContact(java.lang.String pdsHandle,
                               java.lang.String userId,
                               java.lang.String userInfoXML)

API for updating an existing contact.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing contact to be updated

userInfoXml - created using the user_info.xsd; holds all the data needed for updating an existing contact

Returns:

XML reply created using the ws_response.xsd. If this action is successful, an a ID is returned and if it fails, an error is returned.

getContact

java.lang.String getContact(java.lang.String pdsHandle,
                            java.lang.String userId)

API for retrieving an existing contact.

Parameters:

pdsHandle - of a logged-in user

userId - of the existing contact to be retrieved

Returns:

XML reply created using the user_info.xsd. Returns the requested contact data; if the action failed, an error is returned using the ws_response.xsd.

linkContactToProdcuer

@Deprecated
java.lang.String linkContactToProdcuer(java.lang.String pdsHandle,
                                                   java.lang.String producerId,
                                                   java.lang.String userId,
                                                   java.lang.String primaryContact)

Deprecated. Replaced by: linkContactToProducer(String, String, String, String)

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be linked to

userId - of the contact to be linked

primaryContact - TRUE/FALSE determines whether the linked contact is primary

Returns:

reply created using the ws_response.xsd. If the action fails, an error is returned.

linkContactToProducer

java.lang.String linkContactToProducer(java.lang.String pdsHandle,
                                       java.lang.String producerId,
                                       java.lang.String userId,
                                       java.lang.String primaryContact)

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be linked to

userId - of the contact to be linked

primaryContact - TRUE/FALSE determines whether the linked contact is primary

Returns:

reply created using the ws_response.xsd. If the action fails, an error is returned.

unLinkContactFromProdcuer

@Deprecated
java.lang.String unLinkContactFromProdcuer(java.lang.String pdsHandle,
                                                       java.lang.String producerId,
                                                       java.lang.String userId)

Deprecated.

API for unlinking a Producer Agent from a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be unlinked from

userId - of the contact to be unlinked

Returns:

reply created using the ws_response.xsd. If this action fails, an error is returned.

unLinkContactFromProducer

java.lang.String unLinkContactFromProducer(java.lang.String pdsHandle,
                                           java.lang.String producerId,
                                           java.lang.String userId)

API for unlinking a Producer Agent from a Producer

Parameters:

pdsHandle - of a logged-in user

producerId - of the Producer to be unlinked from

userId - of the contact to be unlinked

Returns:

reply created using the ws_response.xsd. If this action fails, an error is returned.

isUserExists

java.lang.String isUserExists(java.lang.String pdsHandle,
                              java.lang.String userName)

API for checking if user exist in the system

Parameters:

pdsHandle - of a logged-in user

userName - of the checked user

Returns:

reply created using the ws_response.xsd. If this action fails, an error is returned.