Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## be.ehealth.businessconnector.ehboxV2.session.impl
Class EhealthBoxServiceV2Impl

    java.lang.Object
      be.ehealth.businessconnector.ehboxV2.session.impl.EhealthBoxServiceV2Impl

All Implemented Interfaces:
  EhealthBoxServiceV2, ConfigurationModuleBootstrap.ModuleBootstrapHook

    public class EhealthBoxServiceV2Impl

extends Object
implements EhealthBoxServiceV2, ConfigurationModuleBootstrap.ModuleBootstrapHook

Implementation of `EhealthBoxServiceV2`

Constructor Summary
`EhealthBoxServiceV2Impl()` default constructor, needed for ModuleBootstrapHook.
`EhealthBoxServiceV2Impl(SessionValidator sessionValidator, EhboxReplyValidator replyValidator)`

Method Summary
`void` | `bootstrap()`
`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.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### EhealthBoxServiceV2Impl

    public EhealthBoxServiceV2Impl(SessionValidator sessionValidator,
                                   EhboxReplyValidator replyValidator)
                            throws TechnicalConnectorException,
                                   EhboxBusinessConnectorException

Parameters:
  `sessionValidator` -
  `replyValidator` -
Throws:
  `TechnicalConnectorException`
  `EhboxBusinessConnectorException`

### EhealthBoxServiceV2Impl

    public EhealthBoxServiceV2Impl()

  default constructor, needed for ModuleBootstrapHook.

Method Detail

### sendMessage

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

  Description copied from interface: `EhealthBoxServiceV2`

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

  - Provide one or more recipients (parameter �destinationContexts� provided as part of the request)
  - Send the new message in reply of an existing message to all original recipients, including the sender (parameter �messageIdForReplyToAll� provided as part of the request)
  - Send the new message in reply of an existing message to the original sender (parameter 'messageIdForReply' provided as part of the request)
  Only one of the above parameters can be present.

  Specified by:
    `sendMessage` in interface `EhealthBoxServiceV2`
  Returns:
    Response containing an id, the status and the publication ID.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.sendMessage(be.fgov.ehealth.ehbox.publication.protocol.v2.SendMessageRequest)`

### getBoxInfo

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

  Description copied from interface: `EhealthBoxServiceV2`

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

  Specified by:
    `getBoxInfo` in interface `EhealthBoxServiceV2`
  Returns:
    Details about the inbox.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.getBoxInfo(be.fgov.ehealth.ehbox.consultation.protocol.v2.GetBoxInfoRequest)`

### getMessageList

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

  Description copied from interface: `EhealthBoxServiceV2`

  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.

  Specified by:
    `getMessageList` in interface `EhealthBoxServiceV2`
  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
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.getMessageList(be.fgov.ehealth.ehbox.consultation.protocol.v2.GetMessagesListRequest)`

### getFullMessage

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

  Description copied from interface: `EhealthBoxServiceV2`

  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.

  Specified by:
    `getFullMessage` in interface `EhealthBoxServiceV2`
  Parameters:
    `request` - The message id.
  Returns:
    Information about the Sender and Message.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.getFullMessage(be.fgov.ehealth.ehbox.consultation.protocol.v2.MessageRequestType)`

### moveMessage

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

  Description copied from interface: `EhealthBoxServiceV2`

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

  Specified by:
    `moveMessage` in interface `EhealthBoxServiceV2`
  Parameters:
    `request` - The message id.
  Returns:
    Status of the operation.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.moveMessage(be.fgov.ehealth.ehbox.consultation.protocol.v2.MoveMessageRequest)`

### getMessageHistory

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

  Description copied from interface: `EhealthBoxServiceV2`

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

  Specified by:
    `getMessageHistory` in interface `EhealthBoxServiceV2`
  Parameters:
    `request` - The message id.
  Returns:
    List of MessageId from the older message versions.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.getMessageHistory(be.fgov.ehealth.ehbox.consultation.protocol.v2.MessageRequestType)`

### getMessageAcknowledgmentsStatusRequest

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

  Description copied from interface: `EhealthBoxServiceV2`

  Gets the acknowlegment status.

  Specified by:
    `getMessageAcknowledgmentsStatusRequest` in interface `EhealthBoxServiceV2`
  Parameters:
    `request` - the message id.
  Returns:
    The acknolegment status.
  Throws:
    `TechnicalConnectorException` - the technical connector exception
    `SessionManagementException`
    `EhboxBusinessConnectorException` - the business connector exception
  See Also:
    `EhealthBoxServiceV2.getMessageAcknowledgmentsStatusRequest(be.fgov.ehealth.ehbox.consultation.protocol.v2.GetMessageAcknowledgmentsStatusRequest)`

### deleteMessage

    public DeleteMessageResponse deleteMessage(DeleteMessageRequest request)
                                        throws TechnicalConnectorException,
                                               EhboxBusinessConnectorException

  Specified by:
    `deleteMessage` in interface `EhealthBoxServiceV2`
  Throws:
    `EhboxBusinessConnectorException`
    `TechnicalConnectorException`
  See Also:
    `EhealthBoxServiceV2.deleteMessage(be.fgov.ehealth.ehbox.consultation.protocol.v2.DeleteMessageRequest)`

### bootstrap

    public void bootstrap()

  Specified by:
    `bootstrap` in interface `ConfigurationModuleBootstrap.ModuleBootstrapHook`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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