es.ree.eemws.core.utils.iec61968100

Enum EnumParameterLimit

java.lang.Object

java.lang.Enum<EnumParameterLimit>

es.ree.eemws.core.utils.iec61968100.EnumParameterLimit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumParameterLimit>

public enum EnumParameterLimit
extends java.lang.Enum<EnumParameterLimit>

Parameters limits for the query data operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GET_XML_AS_BINARY_THRESHOLD_IN_KB Xml messages will be transmited as binary if their size is bigger than the one configured.
MAX_APPLICATION_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST Maximum number of days that a request for Application time interval type can span.
MAX_DIFF_SERVER_TIMESTAMP_IN_SECONDS If set, the server will reject messages that do not meet the following criteria: CT - ST + MD >= 0 Being CT the current server time, ST the msg:serverTimestamp indicated in the request message and MD this parameter value.
MAX_GET_REQUEST_PER_MINUTE Number of Get operations per minute that a user can execute.
MAX_GET_REQUESTS_PER_MESSAGE Number of times that a client can "GET" certain message.
MAX_LIST_REQUEST_PER_MINUTE Number of List operations per minute that a user can execute.
MAX_MESSAGE_AGE_IN_DAYS Max number of days that a message will be accessible by this specification operations.
MAX_NUM_MESSAGES_IN_LIST_RESPONSE Maximum number of messages that will be returned in a list operation response.
MAX_PAYLOAD_SIZE_IN_MB_IN_GET_RESPONSE (Client limit) Max payload size (in Mb) that the get response can retrieve.
MAX_PAYLOAD_SIZE_IN_MB_IN_PUT_REQUEST Maximum size, in Megabytes, that message payload content can have.
MAX_PUT_REQUEST_PER_MINUTE Number of Put operations per minute that a user can execute.
MAX_QUERY_REQUEST_PER_MINUTE Number of Query Data operations per minute that a user can execute.
MAX_SERVER_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST Maximum number of days that a request for Server time interval type can span.
NUMBER_OF_DAYS_FOR_LOW_CODE_IN_LIST_RESPONSE Number of days that are guarantee to be included in the response list when the request has used a small code value (typically 0).

Method Summary

Methods

Modifier and Type	Method and Description
static EnumParameterLimit	fromString(java.lang.String text) Returns a EnumParameterLimit from the given text.
java.lang.String	toString() Returns the text code for the current parameter.
static EnumParameterLimit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumParameterLimit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAX_NUM_MESSAGES_IN_LIST_RESPONSE

public static final EnumParameterLimit MAX_NUM_MESSAGES_IN_LIST_RESPONSE

Maximum number of messages that will be returned in a list operation response.

NUMBER_OF_DAYS_FOR_LOW_CODE_IN_LIST_RESPONSE

public static final EnumParameterLimit NUMBER_OF_DAYS_FOR_LOW_CODE_IN_LIST_RESPONSE

Number of days that are guarantee to be included in the response list when the request has used a small code value (typically 0). According to this specification, the default value for this parameter limit is 1 (all messages available from 00:00 of D-1).

MAX_APPLICATION_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST

public static final EnumParameterLimit MAX_APPLICATION_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST

Maximum number of days that a request for Application time interval type can span.

MAX_SERVER_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST

public static final EnumParameterLimit MAX_SERVER_TIME_INTERVAL_IN_DAYS_IN_LIST_REQUEST

Maximum number of days that a request for Server time interval type can span.

MAX_PAYLOAD_SIZE_IN_MB_IN_PUT_REQUEST

public static final EnumParameterLimit MAX_PAYLOAD_SIZE_IN_MB_IN_PUT_REQUEST

Maximum size, in Megabytes, that message payload content can have. Messages with bigger size will be rejected.

MAX_GET_REQUEST_PER_MINUTE

public static final EnumParameterLimit MAX_GET_REQUEST_PER_MINUTE

Number of Get operations per minute that a user can execute.

MAX_PUT_REQUEST_PER_MINUTE

public static final EnumParameterLimit MAX_PUT_REQUEST_PER_MINUTE

Number of Put operations per minute that a user can execute.

MAX_LIST_REQUEST_PER_MINUTE

public static final EnumParameterLimit MAX_LIST_REQUEST_PER_MINUTE

Number of List operations per minute that a user can execute.

MAX_QUERY_REQUEST_PER_MINUTE

public static final EnumParameterLimit MAX_QUERY_REQUEST_PER_MINUTE

Number of Query Data operations per minute that a user can execute.

MAX_MESSAGE_AGE_IN_DAYS

public static final EnumParameterLimit MAX_MESSAGE_AGE_IN_DAYS

Max number of days that a message will be accessible by this specification operations.

MAX_DIFF_SERVER_TIMESTAMP_IN_SECONDS

public static final EnumParameterLimit MAX_DIFF_SERVER_TIMESTAMP_IN_SECONDS

If set, the server will reject messages that do not meet the following criteria: CT - ST + MD >= 0 Being CT the current server time, ST the msg:serverTimestamp indicated in the request message and MD this parameter value.

GET_XML_AS_BINARY_THRESHOLD_IN_KB

public static final EnumParameterLimit GET_XML_AS_BINARY_THRESHOLD_IN_KB

Xml messages will be transmited as binary if their size is bigger than the one configured.

MAX_GET_REQUESTS_PER_MESSAGE

public static final EnumParameterLimit MAX_GET_REQUESTS_PER_MESSAGE

Number of times that a client can "GET" certain message.

MAX_PAYLOAD_SIZE_IN_MB_IN_GET_RESPONSE

public static final EnumParameterLimit MAX_PAYLOAD_SIZE_IN_MB_IN_GET_RESPONSE

(Client limit) Max payload size (in Mb) that the get response can retrieve.

Method Detail

values

public static EnumParameterLimit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EnumParameterLimit c : EnumParameterLimit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnumParameterLimit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static EnumParameterLimit fromString(java.lang.String text)

Returns a EnumParameterLimit from the given text. null if the given text doesn't describes any of the elements.

Parameters:

text - Text to retrieve the EnumType

Returns:

EnumParameterLimit from the given text. null if the given text doesn't describes any of the elements.

toString

public java.lang.String toString()

Returns the text code for the current parameter.

Overrides:

toString in class java.lang.Enum<EnumParameterLimit>

Returns:

Text code for the current parameter.