org.kuali.mobility.push.entity

Class PushDeviceTuple

java.lang.Object

org.kuali.mobility.push.entity.PushDeviceTuple

All Implemented Interfaces:

Serializable

@Entity
public class PushDeviceTuple
extends Object
implements Serializable

A class which will serve as a tuple for messages that has to be sent. This class will be read by a Service querying that will send the unsent messages and keep track of retries

Since:

2.1.0

Author:

Kuali Mobility Team (mobility.dev@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_FAILED Status indicating the a maximum number of retries has failed, therefore the message is seen as failed, and no further retries will be attempted
static int	STATUS_PENDING Status indicating that the message is pending to be sent, i.e a message just added
static int	STATUS_SENT Status indicatiing that the message has been sent
static int	STATUS_WAITING_RETRY Status indicating that sending the message has failed once, but waiting for a retry attempt

Constructor Summary

Constructors

Constructor and Description
PushDeviceTuple() Creates a new instance of a PushDeviceTuple

Method Summary

Methods

Modifier and Type	Method and Description
Long	getDeviceId() Gets the ID of the device this PushDeviceTuple is linked to.
Long	getId() Returns the id of this PushDeviceTuple
Timestamp	getPostedTimestamp() Gets the timestamp of the last update of this PushDeviceTuple
Long	getPushId() Gets the ID of the Push this PushDeviceTuple is linked to.
int	getStatus() Returns this status of this PushDeviceTuple
Long	getVersionNumber() Gets the version number for this PushDeviceTuple
boolean	isSent() Returns true if the status of this PushDeviceTuple is PushDeviceTuple.STATUS_SENT
boolean	isWaitingRetry() Returns true if the status of this PushDeviceTuple is PushDeviceTuple.STATUS_WAITING_RETRY
void	setDeviceId(Long deviceId) Gets the ID of the device this PushDeviceTuple is linked to.
void	setId(Long tupleId) Sets the id of this
void	setPostedTimestamp(Timestamp postedTimestamp) Gets the timestamp of the last update of this PushDeviceTuple
void	setPushId(Long pushId) Sets the ID of the Push this PushDeviceTuple is linked to.
void	setSent() Sets the status of this PushDeviceTuple to PushDeviceTuple.STATUS_SENT
void	setStatus(int status) Sets the status of this PushDeviceTuple
void	setVersionNumber(Long versionNumber) Sets the version number for this PushDeviceTuple
void	setWaitingRetry() Sets the status of this PushDeviceTuple to PushDeviceTuple.STATUS_WAITING_RETRY
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_PENDING

public static final int STATUS_PENDING

Status indicating that the message is pending to be sent, i.e a message just added

See Also:

Constant Field Values

STATUS_SENT

public static final int STATUS_SENT

Status indicatiing that the message has been sent

See Also:

Constant Field Values

STATUS_WAITING_RETRY

public static final int STATUS_WAITING_RETRY

Status indicating that sending the message has failed once, but waiting for a retry attempt

See Also:

Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

Status indicating the a maximum number of retries has failed, therefore the message is seen as failed, and no further retries will be attempted

See Also:

Constant Field Values

Constructor Detail

PushDeviceTuple

public PushDeviceTuple()

Creates a new instance of a PushDeviceTuple

Method Detail

getId

public Long getId()

Returns the id of this PushDeviceTuple

Returns:

setId

public void setId(Long tupleId)

Sets the id of this

Parameters:

tupleId -

getPushId

public Long getPushId()

Gets the ID of the Push this PushDeviceTuple is linked to.

Returns:

setPushId

public void setPushId(Long pushId)

Sets the ID of the Push this PushDeviceTuple is linked to.

getDeviceId

public Long getDeviceId()

Gets the ID of the device this PushDeviceTuple is linked to.

Returns:

ID of the device this PushDeviceTuple is linked to.

setDeviceId

public void setDeviceId(Long deviceId)

Gets the ID of the device this PushDeviceTuple is linked to.

getPostedTimestamp

public Timestamp getPostedTimestamp()

Gets the timestamp of the last update of this PushDeviceTuple

Returns:

setPostedTimestamp

public void setPostedTimestamp(Timestamp postedTimestamp)

Gets the timestamp of the last update of this PushDeviceTuple

setStatus

public void setStatus(int status)

Sets the status of this PushDeviceTuple

Parameters:

status - New status for this PushDeviceTuple

getStatus

public int getStatus()

Returns this status of this PushDeviceTuple

Returns:

Status of this PushDeviceTuple

setSent

public void setSent()

Sets the status of this PushDeviceTuple to PushDeviceTuple.STATUS_SENT

isSent

public boolean isSent()

Returns true if the status of this PushDeviceTuple is PushDeviceTuple.STATUS_SENT

Returns:

isWaitingRetry

public boolean isWaitingRetry()

Returns true if the status of this PushDeviceTuple is PushDeviceTuple.STATUS_WAITING_RETRY

Returns:

setWaitingRetry

public void setWaitingRetry()

Sets the status of this PushDeviceTuple to PushDeviceTuple.STATUS_WAITING_RETRY

getVersionNumber

public Long getVersionNumber()

Gets the version number for this PushDeviceTuple

Returns:

Version number for this PushDeviceTuple

setVersionNumber

public void setVersionNumber(Long versionNumber)

Sets the version number for this PushDeviceTuple

Parameters:

Version - number for this PushDeviceTuple

toString

public String toString()

Overrides:

toString in class Object