Package de.elo.ix.client

Class Event

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.Event

All Implemented Interfaces:

Serializable

public class Event
extends ValueClass

This class represents an event used by the event bus API functions.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	acl	Access control list.
protected Any	any	Event payload data as Any object.
protected long	busId	Bus-ID
protected byte[]	data	Event payload data as byte array.
protected long	id	Event ID.
protected long	param1	Value depends on event type.
protected String	param2	Value depends on event type.
protected long	senderId	User ID of event sender.
protected long	type	Event type.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
Event()

Method Summary

Modifier and Type	Method	Description
String	getAcl()
Any	getAny()
long	getBusId()
byte[]	getData()
long	getId()
long	getParam1()
String	getParam2()
long	getSenderId()
long	getType()
void	setAcl(String acl)
void	setAny(Any any)
void	setBusId(long busId)
void	setData(byte[] data)
void	setId(long eventId)
void	setParam1(long param1)
void	setParam2(String param2)
void	setSenderId(long senderId)
void	setType(long v)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

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

Field Details

busId

protected long busId

Bus-ID

type

protected long type

Event type. Event filters check this value. This must be one of the predefined event types or an application defined type with a larger value than EventBusC.EVENT_TYPE_MAX_SYSTEM.

See Also:

• EventBusC.EVENT_TYPE_MAX_SYSTEM
• EventFilter.type

param1

protected long param1

Value depends on event type. Event filters check this value.

See Also:

• EventBusC
• EventFilter.param1

param2

protected String param2

Value depends on event type. Event filters check this value.

See Also:

• EventBusC
• EventFilter.param2

id

protected long id

Event ID. If the sender awaits a response to this event, it should set a random number in id. The receiver should use the same number in the response.

senderId

protected long senderId

User ID of event sender. Might be used for other IDs in future too. Read-only.

data

protected byte[] data

Event payload data as byte array.

any

protected Any any

Event payload data as Any object.

acl

protected String acl

Access control list. An empty ACL means here, that the event is dispatched to everyone.

Since:

8.00.010.005

Constructor Details

Event

public Event()

Method Details

getBusId

public long getBusId()

setBusId

public void setBusId(long busId)

getId

public long getId()

setId

public void setId(long eventId)

getData

public byte[] getData()

setData

public void setData(byte[] data)

getType

public long getType()

setType

public void setType(long v)

getAny

public Any getAny()

setAny

public void setAny(Any any)

getParam1

public long getParam1()

setParam1

public void setParam1(long param1)

getParam2

public String getParam2()

setParam2

public void setParam2(String param2)

getSenderId

public long getSenderId()

setSenderId

public void setSenderId(long senderId)

getAcl

public String getAcl()

setAcl

public void setAcl(String acl)

toString

public String toString()

Overrides:

toString in class Object