mycq.QueueSchema Interface Reference

Makes or represents columns of a QueueSchema. More...

List of all members.

Public Member Functions
void	addBoolean (String columnName) throws MyCQException
	Add a new BOOLEAN type column. See: ColumnType
void	addByte (String columnName) throws MyCQException
	Add a new BYTE type column. See: ColumnType
void	addShort (String columnName) throws MyCQException
	Add a new SHORT type column. See: ColumnType
void	addUShort (String columnName) throws MyCQException
	Add a new USHORT type column. See: ColumnType
void	addInt (String columnName) throws MyCQException
	Add a new INT type column. See: ColumnType
void	addLong (String columnName) throws MyCQException
	Add a new LONG type column. See: ColumnType
void	addFloat (String columnName) throws MyCQException
	Add a new FLOAT type column. See: ColumnType
void	addDouble (String columnName) throws MyCQException
	Add a new DOUBLE type column. See: ColumnType
void	addDate (String columnName) throws MyCQException
	Add a new DATE type column. See: ColumnType
void	addTime (String columnName) throws MyCQException
	Add a new TIME type column. See: ColumnType
void	addDateTime (String columnName) throws MyCQException
	Add a new DATETIME type column. See: ColumnType
void	addString (String columnName, int size) throws MyCQException
	Add a new STRING type column. See: ColumnType
void	addVarString (String columnName) throws MyCQException
	Add a new VAR_STRING type column. See: ColumnType
void	addBinary (String columnName, int size) throws MyCQException
	Add a new BINARY type column. See: ColumnType
void	addVarBinary (String columnName) throws MyCQException
	Add a new VAR_BINARY type column. See: ColumnType
List< Column >	getColumns () throws MyCQException
	Get the column list a queue schema.
void	clear () throws MyCQException
	Clear all the columns in a queue schema.
int	getMessageSize () throws MyCQException
	Get the message size. It is a total size of columns of a queue schema.

---

Detailed Description

Makes or represents columns of a QueueSchema.

---

Member Function Documentation

void mycq.QueueSchema.addBinary	(	String	columnName,
		int	size
	)			throws MyCQException

Add a new BINARY type column. See: ColumnType

Parameters:

	columnName	A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
	size	An integer greater than zero that will be the size of BINARY type column.

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addBoolean

(

String

columnName

)

throws MyCQException

Add a new BOOLEAN type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addByte

(

String

columnName

)

throws MyCQException

Add a new BYTE type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addDate

(

String

columnName

)

throws MyCQException

Add a new DATE type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addDateTime

(

String

columnName

)

throws MyCQException

Add a new DATETIME type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addDouble

(

String

columnName

)

throws MyCQException

Add a new DOUBLE type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addFloat

(

String

columnName

)

throws MyCQException

Add a new FLOAT type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addInt

(

String

columnName

)

throws MyCQException

Add a new INT type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addLong

(

String

columnName

)

throws MyCQException

Add a new LONG type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addShort

(

String

columnName

)

throws MyCQException

Add a new SHORT type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addString	(	String	columnName,
		int	size
	)			throws MyCQException

Add a new STRING type column. See: ColumnType

Parameters:

	columnName	A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
	size	An integer greater than zero that will be the size of STRING type column.

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addTime

(

String

columnName

)

throws MyCQException

Add a new TIME type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addUShort

(

String

columnName

)

throws MyCQException

Add a new USHORT type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addVarBinary

(

String

columnName

)

throws MyCQException

Add a new VAR_BINARY type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.addVarString

(

String

columnName

)

throws MyCQException

Add a new VAR_STRING type column. See: ColumnType

Parameters:

columnName

A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).

Exceptions:

MyCQException

An error occurred. check error code.

void mycq.QueueSchema.clear

(

)

throws MyCQException

Clear all the columns in a queue schema.

List<Column> mycq.QueueSchema.getColumns

(

)

throws MyCQException

Get the column list a queue schema.

Returns:

Column list.

int mycq.QueueSchema.getMessageSize

(

)

throws MyCQException

Get the message size. It is a total size of columns of a queue schema.

Returns:

An integer of a message size. It returns zero if there is no column or variable column(s) in a queue schema.