com.unvired.model

Class InfoMessage

java.lang.Object

com.unvired.model.DataStructure

com.unvired.model.InfoMessage

All Implemented Interfaces:

IDataStructure

public class InfoMessage
extends com.unvired.model.DataStructure

Server sends info, success, error and warning messages to the mobile device as InfoMessages. The info message has to be interpreted as follows:

• getCategory() - Provides the category of the message - info, success, warning or failure.
• getMessage() - Provides the message text.
• getBeName() - Provides the name of the business entity associated with the message.
• getBeLid() - Provides the local identifier of the business entity associated with the message.
• getMessageBlob() - Provides detailed message as bytes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.unvired.database.IDataStructure

IDataStructure.OBJECT_STATUS, IDataStructure.SYNC_STATUS

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BE_LID
static java.lang.String	BE_NAME
static java.lang.String	CATEGORY
static java.lang.String	CATEGORY_FAILURE The value used to indicate that the InfoMessage is of category 'Failure'.
static java.lang.String	CATEGORY_FAILURE_N_PROCESS The value used to indicate that the InfoMessage is of category 'Failure' and still process data.
static java.lang.String	CATEGORY_INFO The value used to indicate that the InfoMessage is of category 'Information'.
static java.lang.String	CATEGORY_SUCCESS The value used to indicate that the InfoMessage is of category 'Success'.
static java.lang.String	CATEGORY_WARNING The value used to indicate that the InfoMessage is of category 'Warning'.
static java.lang.String[]	FIELD_NAMES
static java.lang.String[]	FIELD_TYPES
static java.lang.String[]	GID_FIELDS
static java.lang.String	INFO_MESSAGE_BE_HEADER_NAME
static java.lang.String	INFO_MESSAGE_BE_NAME
static java.lang.String	MESSAGE
static java.lang.String	MESSAGE_BLOB
static java.lang.String[]	PRIMARY_KEYS
static java.lang.String	SUB_TYPE
static java.lang.String	TABLE_NAME
static java.lang.String	TYPE

Fields inherited from interface com.unvired.database.IDataStructure

FIELD_FID, FIELD_HAS_CONFLICT, FIELD_LID, FIELD_OBJECT_STATUS, FIELD_SYNC_STATUS, FIELD_TIMESTAMP, FIELD_TYPE_FID, FIELD_TYPE_HAS_CONFLICT, FIELD_TYPE_LID, FIELD_TYPE_OBJECT_STATUS, FIELD_TYPE_SYNC_STATUS, FIELD_TYPE_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
InfoMessage()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBeLid() Gets the be lid.
java.lang.String	getBeName() Gets the be name.
java.lang.String	getCategory() Gets the message category.
java.lang.String	getMessage() Gets the message.
byte[]	getMessageBlob() Gets the message blob.
java.lang.String	getSubType() Gets the message sub type.
java.lang.String	getType() Gets the message type.
void	setBeLid(java.lang.String lid) Sets the be lid.
void	setBeName(java.lang.String beName) Sets the be name.
void	setCategory(java.lang.String category)
void	setMessage(java.lang.String message) Sets the message.
void	setMessageBlob(byte[] messageBlob) Sets the message blob.
void	setSubType(java.lang.String subType)
void	setType(java.lang.String type)

Methods inherited from class com.unvired.model.DataStructure

getBEName, getChildrenTableNames, getFid, getField, getFieldCount, getFieldNames, getFieldType, getGidFieldNames, getGids, getHasConflict, getInfoMessages, getLid, getObjectStatus, getSyncStatus, getTableName, getTimeStamp, isHeader, isModified, setFid, setField, setFieldBasedOnDataType, setHasConflict, setLid, setModifiedFlag, setObjectStatus, setSyncStatus, setTimeStamp

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_NAME

public static final java.lang.String TABLE_NAME

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

SUB_TYPE

public static final java.lang.String SUB_TYPE

See Also:

Constant Field Values

CATEGORY

public static final java.lang.String CATEGORY

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

See Also:

Constant Field Values

BE_NAME

public static final java.lang.String BE_NAME

See Also:

Constant Field Values

BE_LID

public static final java.lang.String BE_LID

See Also:

Constant Field Values

MESSAGE_BLOB

public static final java.lang.String MESSAGE_BLOB

See Also:

Constant Field Values

PRIMARY_KEYS

public static final java.lang.String[] PRIMARY_KEYS

GID_FIELDS

public static final java.lang.String[] GID_FIELDS

FIELD_NAMES

public static final java.lang.String[] FIELD_NAMES

FIELD_TYPES

public static final java.lang.String[] FIELD_TYPES

INFO_MESSAGE_BE_NAME

public static final java.lang.String INFO_MESSAGE_BE_NAME

See Also:

Constant Field Values

INFO_MESSAGE_BE_HEADER_NAME

public static final java.lang.String INFO_MESSAGE_BE_HEADER_NAME

See Also:

Constant Field Values

CATEGORY_INFO

public static final java.lang.String CATEGORY_INFO

The value used to indicate that the InfoMessage is of category 'Information'. Value is given by provided by getType().

See Also:

Constant Field Values

CATEGORY_WARNING

public static final java.lang.String CATEGORY_WARNING

The value used to indicate that the InfoMessage is of category 'Warning'. Value is given by provided by getType().

See Also:

Constant Field Values

CATEGORY_SUCCESS

public static final java.lang.String CATEGORY_SUCCESS

The value used to indicate that the InfoMessage is of category 'Success'. Value is given by provided by getType().

See Also:

Constant Field Values

CATEGORY_FAILURE

public static final java.lang.String CATEGORY_FAILURE

The value used to indicate that the InfoMessage is of category 'Failure'. Value is given by provided by getType().

See Also:

Constant Field Values

CATEGORY_FAILURE_N_PROCESS

public static final java.lang.String CATEGORY_FAILURE_N_PROCESS

The value used to indicate that the InfoMessage is of category 'Failure' and still process data. Value is given by provided by getType().

See Also:

Constant Field Values

Constructor Detail

InfoMessage

public InfoMessage()

Method Detail

getType

public java.lang.String getType()

Gets the message type.

Returns:

Return the message type.

setType

public void setType(java.lang.String type)

getSubType

public java.lang.String getSubType()

Gets the message sub type.

Returns:

Return the message sub type.

setSubType

public void setSubType(java.lang.String subType)

getCategory

public java.lang.String getCategory()

Gets the message category.

Returns:

Returns the message category

setCategory

public void setCategory(java.lang.String category)

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message

setMessage

public void setMessage(java.lang.String message)

Sets the message.

Parameters:

message - the new message

getMessageBlob

public byte[] getMessageBlob()

Gets the message blob.

Returns:

the message blob

setMessageBlob

public void setMessageBlob(byte[] messageBlob)

Sets the message blob.

Parameters:

messageBlob - the new message blob

getBeName

public java.lang.String getBeName()

Gets the be name.

Returns:

the be name

setBeName

public void setBeName(java.lang.String beName)

Sets the be name.

Parameters:

beName - the new be name

getBeLid

public java.lang.String getBeLid()

Gets the be lid.

Returns:

the be lid

setBeLid

public void setBeLid(java.lang.String lid)

Sets the be lid.

Parameters:

lid - the new be lid