be.ehealth.businessconnector.ehboxV2.session
Interface EhealthBoxServiceV2

All Known Implementing Classes:
EhealthBoxServiceV2Impl

public interface EhealthBoxServiceV2

The Business Connector for General Practitioners provides a simplified interface to access the eHealth Box by providing the following functionality:

Pre-Requisites:
An active and valid eHealth-platform session (initiated via the Session Management component)

Default impl : EhealthBoxServiceV2Impl Factory : ServiceFactory


Method Summary
 DeleteMessageResponse deleteMessage(DeleteMessageRequest request)
           
 GetBoxInfoResponse getBoxInfo(GetBoxInfoRequest getBoxInfoRequest)
           To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all available messages, etc.).
 GetFullMessageResponse getFullMessage(MessageRequestType request)
           Retrieves the entire message from the eHealth Box based on its unique identifier.
 GetMessageAcknowledgmentsStatusResponse getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request)
           Gets the acknowlegment status.
 GetHistoryResponse getMessageHistory(MessageRequestType request)
           With the 'Get History' operation, a messages history can be consulted.
 GetMessageListResponseType getMessageList(GetMessagesListRequest request)
           The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent).
 ResponseType moveMessage(MoveMessageRequest request)
           Moves a message back to the inbox.
 SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest)
           The �Send Message� operation allows a message to be sent to one or more recipients.
 

Method Detail

sendMessage

SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest)
                                throws TechnicalConnectorException,
                                       EhboxBusinessConnectorException,
                                       SessionManagementException

The �Send Message� operation allows a message to be sent to one or more recipients. The sender has to be option to:

Only one of the above parameters can be present.

Parameters:
sendMessageRequest -
Returns:
Response containing an id, the status and the publication ID.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

getBoxInfo

GetBoxInfoResponse getBoxInfo(GetBoxInfoRequest getBoxInfoRequest)
                              throws TechnicalConnectorException,
                                     EhboxBusinessConnectorException,
                                     SessionManagementException

To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all available messages, etc.).

Parameters:
getBoxInfoRequest -
Returns:
Details about the inbox.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

getMessageList

GetMessageListResponseType getMessageList(GetMessagesListRequest request)
                                          throws TechnicalConnectorException,
                                                 EhboxBusinessConnectorException,
                                                 SessionManagementException

The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent). The result contains a list of available messages, but only with partial information. To retrieve the entire message contents, the 'Get Full Message' operation must be invoked.

Parameters:
request - Indicates the folder for which the list of messages is returned (inbox, bin, sent).
Returns:
A list of Messages for the specified folder.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

getFullMessage

GetFullMessageResponse getFullMessage(MessageRequestType request)
                                      throws TechnicalConnectorException,
                                             EhboxBusinessConnectorException,
                                             SessionManagementException

Retrieves the entire message from the eHealth Box based on its unique identifier. Typically, first a list of new messages is retrieved via the 'Get Message List' operation and afterwards the individual message is claimed via this operation.

Parameters:
request - The message id.
Returns:
Information about the Sender and Message.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

moveMessage

ResponseType moveMessage(MoveMessageRequest request)
                         throws TechnicalConnectorException,
                                EhboxBusinessConnectorException,
                                SessionManagementException

Moves a message back to the inbox. The unique message identifier must be provided as input parameter.

Parameters:
request - The message id.
Returns:
Status of the operation.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

getMessageHistory

GetHistoryResponse getMessageHistory(MessageRequestType request)
                                     throws TechnicalConnectorException,
                                            EhboxBusinessConnectorException,
                                            SessionManagementException

With the 'Get History' operation, a messages history can be consulted.

Parameters:
request - The message id.
Returns:
List of MessageId from the older message versions.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

getMessageAcknowledgmentsStatusRequest

GetMessageAcknowledgmentsStatusResponse getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request)
                                                                               throws TechnicalConnectorException,
                                                                                      EhboxBusinessConnectorException,
                                                                                      SessionManagementException

Gets the acknowlegment status.

Parameters:
request - the message id.
Returns:
The acknolegment status.
Throws:
TechnicalConnectorException - the technical connector exception
EhboxBusinessConnectorException - the business connector exception
SessionManagementException

deleteMessage

DeleteMessageResponse deleteMessage(DeleteMessageRequest request)
                                    throws SessionManagementException,
                                           TechnicalConnectorException,
                                           EhboxBusinessConnectorException
Throws:
SessionManagementException
TechnicalConnectorException
EhboxBusinessConnectorException



Connector Packaging PERSPHYSICIAN 3.10.2 API
Copyright © {inceptionYear}-2016 eHealth. All Rights Reserved.