com.objectxp.msg.ota
Class ServiceIndication

java.lang.Object
  com.objectxp.msg.Message
      com.objectxp.msg.SmsMessage
          com.objectxp.msg.ota.OTAMessage
              com.objectxp.msg.ota.ServiceIndication

All Implemented Interfaces:

MultiPartMessage, java.io.Serializable, java.lang.Cloneable

public class ServiceIndication
extends OTAMessage

The ServiceIndication class represents a OTA Service Indication (SI).

The SI provides a way to inform a user that an event has occurred and indicate a URL that can be loaded in order to react to that event. This is done by sending a SMS to the client that informs the recipient about the event, and a URL from where the appropriate service can be loaded. For example, the message could state that "A new mail has arrived", including the URL of the Web-Email interface.

Since:

jSMS 2.0.2

See Also:

Serialized Form

Field Summary

static java.lang.String	ACTION_DELETE
static java.lang.String	ACTION_SIGNAL_HIGH
static java.lang.String	ACTION_SIGNAL_LOW
static java.lang.String	ACTION_SIGNAL_MEDIUM
static java.lang.String	ACTION_SIGNAL_NONE

Fields inherited from class com.objectxp.msg.SmsMessage

CLASS_0, CLASS_1, CLASS_2, CLASS_3, DC_8BIT, DC_DEFAULT, DC_GROUP_DATA, DC_GROUP_GENERAL, DC_GROUP_MSG_WAITING_DISCARD, DC_GROUP_MSG_WAITING_STORE, DC_UCS2, INDICATION_ACTIVE, INDICATION_INACTIVE, INDICATION_TYPE_EMAIL, INDICATION_TYPE_FAX, INDICATION_TYPE_OTHER, INDICATION_TYPE_VOICEMAIL, NO_CLASS

Fields inherited from class com.objectxp.msg.Message

ACK_TIME, MT_BINARY, MT_STATUS, MT_TEXT, SENDER_TYPE_ALPHA, SENDER_TYPE_GUESS, SENDER_TYPE_NUMBER

Constructor Summary

ServiceIndication(java.lang.String content)
Construct a new Service Indication(SI).

ServiceIndication(java.lang.String url, java.lang.String content)
Construct a new Service Indication (SI).

ServiceIndication(java.lang.String ID, java.lang.String url, java.lang.String content)
Construct a new Service-Indication (SI).

Method Summary

void	setAction(java.lang.String action) Set the action for this SI.
void	setContent(java.lang.String content) Set the content (message text) for this SI.
void	setCreated(java.util.Date date) Set the creation date for this SI.
void	setExpires(java.util.Date date) Set the expiration date for this SI.
void	setID(java.lang.String id) Set the ID for this SI.
void	setURL(java.lang.String url) Set the URL for this SI.

Methods inherited from class com.objectxp.msg.ota.OTAMessage

buildParts, buildParts, getParts, toString

Methods inherited from class com.objectxp.msg.SmsMessage

containsUserDataHeader, copyFields, getAlphabet, getBytes, getCodingGroup, getDeferredDeliveryAsDate, getDeferredDeliveryInMinutes, getID, getIndicationState, getIndicationType, getMessage, getMessageClass, getParent, getPID, getRecipient, getRecipientAddress, getSender, getSenderAddress, getType, getUserData, getUserDataHeader, getValidityPeriodAsDate, getValidityPeriodInMinutes, hasDeferredDelivery, hasMessageClass, hasValidityPeriod, isCompressed, isMMS, isRejectDuplicates, isRelativeDeferredDelivery, isRelativeValidityPeriod, isReplyPath, requestStatusReport, requestStatusReport, setAlphabet, setCodingGroup, setCompression, setDeferredDelivery, setDeferredDelivery, setIndicationState, setIndicationType, setMessage, setMessage, setMessageClass, setMMS, setParent, setPID, setRecipient, setRecipientAddress, setRejectDuplicates, setReplyPath, setSender, setSenderAddress, setType, setUserData, setUserDataHeader, setUserDataHeader, setValidityPeriod, setValidityPeriod

Methods inherited from class com.objectxp.msg.Message

clone, getProperty, getSenderType, getTimestamp, setProperty, setSenderType

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_SIGNAL_NONE

public static final java.lang.String ACTION_SIGNAL_NONE

See Also:

Constant Field Values

ACTION_SIGNAL_LOW

public static final java.lang.String ACTION_SIGNAL_LOW

See Also:

Constant Field Values

ACTION_SIGNAL_MEDIUM

public static final java.lang.String ACTION_SIGNAL_MEDIUM

See Also:

Constant Field Values

ACTION_SIGNAL_HIGH

public static final java.lang.String ACTION_SIGNAL_HIGH

See Also:

Constant Field Values

ACTION_DELETE

public static final java.lang.String ACTION_DELETE

See Also:

Constant Field Values

Constructor Detail

ServiceIndication

public ServiceIndication(java.lang.String ID,
                         java.lang.String url,
                         java.lang.String content)

Construct a new Service-Indication (SI).

Parameters:

ID - the ID of the SI.

url - the URL to indicate

content - the message text

ServiceIndication

public ServiceIndication(java.lang.String url,
                         java.lang.String content)

Construct a new Service Indication (SI).

Parameters:

url - the URL to indicate

content - the message text

ServiceIndication

public ServiceIndication(java.lang.String content)

Construct a new Service Indication(SI).

Parameters:

content - The message text.

Method Detail

setID

public void setID(java.lang.String id)

Set the ID for this SI. If no ID specified, its value is considered to be the same as the URL of the SI.

Overrides:

setID in class Message

Parameters:

id - the ID or null.

setURL

public void setURL(java.lang.String url)

Set the URL for this SI. If no URL is present, the SI corresponds to a notification (no service can be initiated).

Parameters:

url - the URL

setContent

public void setContent(java.lang.String content)

Set the content (message text) for this SI.

Parameters:

content - the message text

setAction

public void setAction(java.lang.String action)

Set the action for this SI. If no action is specified, it defaults to ACTION_SIGNAL_MEDIUM.

Parameters:

action - one of: ACTION_SIGNAL_NONE, ACTION_SIGNAL_LOW, ACTION_SIGNAL_MEDIUM, ACTION_SIGNAL_HIGH, ACTION_DELETE

setCreated

public void setCreated(java.util.Date date)

Set the creation date for this SI. This may be used to specify the date and time of the creation or last modification of the content indicated by the SI URL. The creation date may differ from the date and time when the SI was created.

Parameters:

date - the creation date or null

setExpires

public void setExpires(java.util.Date date)

Set the expiration date for this SI. This may be used to specify the date and time when the SI expires and therefore be automatically deleted or marked as expired. If no expiration date is specified, the SI never expires and is thus not subject to automatic deletion.

Parameters:

date - the expiration date or null