com.micex.client

Class Meta.Message

java.lang.Object

com.micex.client.Meta.Message

Enclosing class:

Meta

public static class Meta.Message
extends Object

ASTS request (table or transaction) description.

Field Summary

Fields

Modifier and Type	Field and Description
com.moex.util.Caption	caption Название (заголовок).
com.moex.util.Caption	description Описание.
int	index Индекс - порядковый номер в списке владельца.
String	name Имя.

Method Summary

Modifier and Type	Method and Description
com.moex.util.Caption	caption()
com.moex.util.Caption	description()
int	flags()
int	index()
Meta.Fields	input() Deprecated. Since 1.1.3 replaced by params()
boolean	isClearOnUpdate() Indicates complete data renewal on update.
boolean	isOrderbook() Indicates an order-book request (table).
boolean	isScaleNeeded() Indicates if this request needs scale information.
boolean	isTable() Checks is this request is a table.
boolean	isUpdateable() Indicates an updateable ASTS request (tables only).
protected void	load(InputStream stream, int version, String language, Meta.Factory factory)
String	name()
Meta.Fields	output() Gets ASTS request response field list.
Meta.Fields	params() Gets ASTS request parameter list.
Meta.TableType	type() Gets ASTS table type, guessed by name.

Methods inherited from class java.lang.Object

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

Field Detail

caption

public com.moex.util.Caption caption

Название (заголовок).

description

public com.moex.util.Caption description

Описание.

name

public String name

Имя.

index

public int index

Индекс - порядковый номер в списке владельца.

Method Detail

load

protected void load(InputStream stream,
                    int version,
                    String language,
                    Meta.Factory factory)
             throws IOException

Throws:

IOException

isTable

public final boolean isTable()

Checks is this request is a table.

Returns:

true for the table request, false for the transaction.

Since:

1.1.3

flags

public final int flags()

input

@Deprecated
public final Meta.Fields input()

Deprecated. Since 1.1.3 replaced by params()

Gets ASTS request parameter list.

Returns:

list of ASTS request parameters.

params

public final Meta.Fields params()

Gets ASTS request parameter list.

Returns:

list of ASTS request parameters.

output

public final Meta.Fields output()

Gets ASTS request response field list.

Returns:

list of ASTS response fields.

type

public final Meta.TableType type()

Gets ASTS table type, guessed by name.

Returns:

ASTS table type.

isClearOnUpdate

public final boolean isClearOnUpdate()

Indicates complete data renewal on update.

Returns:

true if previously received data has to be cleared when new updates arrive.

isScaleNeeded

public final boolean isScaleNeeded()

Indicates if this request needs scale information. Request depends on scale information when it contains price fields that need to have security scale for encoding request or decoding response.

Returns:

true if encoding or decoding this request depends on scale information.

isOrderbook

public final boolean isOrderbook()

Indicates an order-book request (table).

Order-book table should have special handing while parsing response.

Also order-book table updates always override previous data, that is similar to isClearOnUpdate().

Returns:

true for an order-book table.

isUpdateable

public final boolean isUpdateable()

Indicates an updateable ASTS request (tables only).

Updateable tables have their data change in time and therefore should be periodically refreshed. In contrast, non-updateable tables have static data (never change during session) and thus can be loaded only once.

Returns:

true if this request (table) is an updateable one.

caption

public final com.moex.util.Caption caption()

description

public final com.moex.util.Caption description()

name

public final String name()

index

public final int index()