es.ree.eemws.client.querydata

Class QueryData

java.lang.Object

es.ree.eemws.client.common.ParentClient

es.ree.eemws.client.querydata.QueryData

public final class QueryData
extends ParentClient

Query Data Service can be used by clients to request specific data from the server using different query parameters.

Constructor Summary

Constructors

Constructor and Description
QueryData() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	query(java.util.Map<java.lang.String,java.lang.String> msgOptions) Invokes the QueryData operation with the given parameters.
java.lang.String	query(java.lang.String dataType) Invokes the QueryData operation with no parameters (just the query identification).
java.lang.String	query(java.lang.String dataType, java.util.Date startTime) Invokes the QueryData operation with start time parameter.
java.lang.String	query(java.lang.String dataType, java.util.Date startTime, java.util.Date endTime) Invokes the QueryData operation with start and end time parameters.
java.lang.String	query(java.lang.String dataType, java.util.Date startTime, java.util.Date endTime, java.util.Map<java.lang.String,java.lang.String> others) Invokes the QueryData operation with the given parameters.
ch.iec.tc57._2011.schema.message.ResponseMessage	queryWithResponseMessage(java.util.Map<java.lang.String,java.lang.String> msgOptions) Invokes the QueryData operation with the given parameters.
ch.iec.tc57._2011.schema.message.ResponseMessage	queryWithResponseMessage(java.lang.String dataType) Invokes the QueryData operation with no parameters (just the query identification).
ch.iec.tc57._2011.schema.message.ResponseMessage	queryWithResponseMessage(java.lang.String dataType, java.util.Date startTime, java.util.Date endTime, java.util.Map<java.lang.String,java.lang.String> others) Invokes the QueryData operation with the given parameters.

Methods inherited from class es.ree.eemws.client.common.ParentClient

getMessageMetaData, sendMessage, setCertificate, setEndPoint, setEndPoint, setPrivateKey, setSignRequest, setVerifyResponse, validateResponse, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryData

public QueryData()

Constructor.

Method Detail

query

public java.lang.String query(java.lang.String dataType)
                       throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with no parameters (just the query identification).

Parameters:

dataType - Indicates the type of data being requested.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

queryWithResponseMessage(String)

queryWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage queryWithResponseMessage(java.lang.String dataType)
                                                                          throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with no parameters (just the query identification).

Parameters:

dataType - Indicates the type of data being requested.

Returns:

ResponseMessage with the server's response.

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

query(String)

query

public java.lang.String query(java.lang.String dataType,
                     java.util.Date startTime)
                       throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with start time parameter.

Parameters:

dataType - Indicates the type of data being requested.

startTime - Specifies that the returned message should only include data whose Application Date is after the given date.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

query

public java.lang.String query(java.lang.String dataType,
                     java.util.Date startTime,
                     java.util.Date endTime)
                       throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with start and end time parameters.

Parameters:

dataType - Indicates the type of data being requested.

startTime - Specifies that the returned message should only include data whose Application Date is after the given date

endTime - Specifies that the returned message should only include data whose Application Date is before the given date.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

query

public java.lang.String query(java.util.Map<java.lang.String,java.lang.String> msgOptions)
                       throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with the given parameters.

Parameters:

msgOptions - List options as a Map which key must be on the EnumFilterElement list.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

queryWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage queryWithResponseMessage(java.util.Map<java.lang.String,java.lang.String> msgOptions)
                                                                          throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with the given parameters.

Parameters:

msgOptions - List options as a Map which key must be on the EnumFilterElement list.

Returns:

ResponseMessage with the server's response.

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or if the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

query

public java.lang.String query(java.lang.String dataType,
                     java.util.Date startTime,
                     java.util.Date endTime,
                     java.util.Map<java.lang.String,java.lang.String> others)
                       throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with the given parameters.

Parameters:

dataType - Indicates the type of data being requested.

startTime - Specifies that the returned message should only include data whose Application Date is after the given date. (Can be null).

endTime - Specifies that the returned message should only include data whose Application Date is before the given date. (Can be null).

others - Specifies others parameters to the query. The parameters are expressed as a key-value pairs, where the value is optional.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

queryWithResponseMessage(String, Date, Date, Map)

queryWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage queryWithResponseMessage(java.lang.String dataType,
                                                                        java.util.Date startTime,
                                                                        java.util.Date endTime,
                                                                        java.util.Map<java.lang.String,java.lang.String> others)
                                                                          throws es.ree.eemws.core.utils.operations.query.QueryOperationException

Invokes the QueryData operation with the given parameters.

Parameters:

dataType - Indicates the type of data being requested.

startTime - Specifies that the returned message should only include data whose Application Date is after the given date. (Can be null).

endTime - Specifies that the returned message should only include data whose Application Date is before the given date. (Can be null).

others - Specifies others parameters to the query. The parameters are expressed as a key-value pairs, where the value is optional.

Returns:

String with the server's response (only payload content).

Throws:

es.ree.eemws.core.utils.operations.query.QueryOperationException - If the retrieved message has an invalid format or the application cannot handle it. or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

query(String, Date, Date, Map)