public class EhealthBoxServiceV3Impl extends Object implements EhealthBoxServiceV3
EhealthBoxServiceV3
Constructor and Description |
---|
EhealthBoxServiceV3Impl(SessionValidator sessionValidator,
EhboxReplyValidator replyValidator) |
Modifier and Type | Method and Description |
---|---|
DeleteMessageResponse |
deleteMessage(DeleteMessageRequest request)
delete specific message.
|
DeleteOoOResponse |
deleteOoO(DeleteOoORequest request)
delete specific OoO périod.
|
GetAllEhboxesMessagesListResponse |
getAllEhboxesMessagesList(GetAllEhboxesMessagesListRequest request)
retrieves all messages from all mailboxes for user.
|
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(GetFullMessageRequest request)
Retrieves the entire message from the eHealth Box based on its unique identifier.
|
GetFullMessageResponse |
getFullMessage(MessageRequestType request)
Deprecated.
|
GetMessageAcknowledgmentsStatusResponse |
getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request)
Gets the acknowlegment status.
|
GetHistoryResponse |
getMessageHistory(GetHistoryRequest request)
With the 'Get History' operation, a messages history can be consulted.
|
GetHistoryResponse |
getMessageHistory(MessageRequestType request)
With the 'Get History' operation, a messages history can be consulted.
|
GetMessagesListResponse |
getMessageList(GetMessagesListRequest request)
The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent).
|
GetOoOListResponse |
getOoOList(GetOoOListRequest request)
get list of periods of OoO for specific user.
|
InsertOoOResponse |
insertOoO(InsertOoORequest request)
insert Out Of Office period.
|
MoveMessageResponse |
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.
|
public EhealthBoxServiceV3Impl(SessionValidator sessionValidator, EhboxReplyValidator replyValidator) throws TechnicalConnectorException, EhboxBusinessConnectorException
sessionValidator
- replyValidator
- TechnicalConnectorException
EhboxBusinessConnectorException
public final SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws ConnectorException
EhealthBoxServiceV3
The �Send Message� operation allows a message to be sent to one or more recipients. The sender has to be option to:
sendMessage
in interface EhealthBoxServiceV3
ConnectorException
EhealthBoxServiceV3.sendMessage(be.fgov.ehealth.ehbox.publication.protocol.v3.SendMessageRequest)
public final GetBoxInfoResponse getBoxInfo(GetBoxInfoRequest getBoxInfoRequest) throws ConnectorException
EhealthBoxServiceV3
To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all available messages, etc.).
getBoxInfo
in interface EhealthBoxServiceV3
ConnectorException
EhealthBoxServiceV3.getBoxInfo(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetBoxInfoRequest)
public final GetMessagesListResponse getMessageList(GetMessagesListRequest request) throws ConnectorException
EhealthBoxServiceV3
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.
getMessageList
in interface EhealthBoxServiceV3
request
- Indicates the folder for which the list of messages is returned (inbox, bin, sent).ConnectorException
EhealthBoxServiceV3.getMessageList(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetMessagesListRequest)
@Deprecated public final GetFullMessageResponse getFullMessage(MessageRequestType request) throws ConnectorException
EhealthBoxServiceV3
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.
getFullMessage
in interface EhealthBoxServiceV3
request
- The message id.ConnectorException
EhealthBoxServiceV3.getFullMessage(be.fgov.ehealth.ehbox.consultation.protocol.v3.MessageRequestType)
public GetFullMessageResponse getFullMessage(GetFullMessageRequest request) throws ConnectorException
EhealthBoxServiceV3
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.
getFullMessage
in interface EhealthBoxServiceV3
request
- The message id.ConnectorException
EhealthBoxServiceV3.getFullMessage(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetFullMessageRequest)
public final MoveMessageResponse moveMessage(MoveMessageRequest request) throws ConnectorException
EhealthBoxServiceV3
Moves a message back to the inbox. The unique message identifier must be provided as input parameter.
moveMessage
in interface EhealthBoxServiceV3
request
- The message id.ConnectorException
EhealthBoxServiceV3.moveMessage(be.fgov.ehealth.ehbox.consultation.protocol.v3.MoveMessageRequest)
public final GetHistoryResponse getMessageHistory(MessageRequestType request) throws ConnectorException
EhealthBoxServiceV3
With the 'Get History' operation, a messages history can be consulted.
getMessageHistory
in interface EhealthBoxServiceV3
request
- The message id.ConnectorException
EhealthBoxServiceV3.getMessageHistory(be.fgov.ehealth.ehbox.consultation.protocol.v3.MessageRequestType)
public GetHistoryResponse getMessageHistory(GetHistoryRequest request) throws ConnectorException
EhealthBoxServiceV3
With the 'Get History' operation, a messages history can be consulted.
getMessageHistory
in interface EhealthBoxServiceV3
request
- The message id.ConnectorException
EhealthBoxServiceV3.getMessageHistory(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetHistoryRequest)
public final GetMessageAcknowledgmentsStatusResponse getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request) throws ConnectorException
EhealthBoxServiceV3
Gets the acknowlegment status.
getMessageAcknowledgmentsStatusRequest
in interface EhealthBoxServiceV3
request
- the message id.ConnectorException
EhealthBoxServiceV3.getMessageAcknowledgmentsStatusRequest(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetMessageAcknowledgmentsStatusRequest)
public final DeleteMessageResponse deleteMessage(DeleteMessageRequest request) throws ConnectorException
EhealthBoxServiceV3
delete specific message.
deleteMessage
in interface EhealthBoxServiceV3
request
- the message idException
SessionManagementException
ConnectorException
EhealthBoxServiceV3.deleteMessage(be.fgov.ehealth.ehbox.consultation.protocol.v3.DeleteMessageRequest)
public final InsertOoOResponse insertOoO(InsertOoORequest request) throws ConnectorException
EhealthBoxServiceV3
insert Out Of Office period.
insertOoO
in interface EhealthBoxServiceV3
request
- user and period of OoOConnectorException
EhealthBoxServiceV3.insertOoO(be.fgov.ehealth.ehbox.consultation.protocol.v3.InsertOoORequest)
public final GetOoOListResponse getOoOList(GetOoOListRequest request) throws ConnectorException
EhealthBoxServiceV3
get list of periods of OoO for specific user.
getOoOList
in interface EhealthBoxServiceV3
request
- user idConnectorException
EhealthBoxServiceV3.getOoOList(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetOoOListRequest)
public final DeleteOoOResponse deleteOoO(DeleteOoORequest request) throws ConnectorException
EhealthBoxServiceV3
delete specific OoO périod.
deleteOoO
in interface EhealthBoxServiceV3
request
- period OoO idConnectorException
EhealthBoxServiceV3.deleteOoO(be.fgov.ehealth.ehbox.consultation.protocol.v3.DeleteOoORequest)
public final GetAllEhboxesMessagesListResponse getAllEhboxesMessagesList(GetAllEhboxesMessagesListRequest request) throws TechnicalConnectorException, EhboxBusinessConnectorException, ConnectorException
EhealthBoxServiceV3
getAllEhboxesMessagesList
in interface EhealthBoxServiceV3
TechnicalConnectorException
EhboxBusinessConnectorException
ConnectorException
EhealthBoxServiceV3.getAllEhboxesMessagesList(be.fgov.ehealth.ehbox.consultation.protocol.v3.GetAllEhboxesMessagesListRequest)
Connector Packaging PERSPHYSICIAN 4.5.4 API
Copyright © {inceptionYear}-2024 eHealth. All Rights Reserved.