org.mobicents.protocols.smpp.gsm.ems
Class ExtendedObject

java.lang.Object
  org.mobicents.protocols.smpp.gsm.AbstractHeaderElement
      org.mobicents.protocols.smpp.gsm.ems.ExtendedObject

All Implemented Interfaces:

HeaderElement

Direct Known Subclasses:

BlackAndWhiteBitmapEO

public class ExtendedObject
extends AbstractHeaderElement

An extended object.

Version:

$Id: ExtendedObject.java 484 2010-02-08 16:08:50Z orank $

Constructor Summary

ExtendedObject(int objectFormat, int referenceNum)

ExtendedObject(int objectFormat, int referenceNum, byte[] data)

Method Summary

byte[]	getData() Get the data of this extended object.
int	getLength() Get the total number of octets this header element encodes as excluding the IEI and the IEI-Data-Length fields.
int	getObjectFormat() Get the object format of this extended object.
int	getObjectPosition() Get the position in the SMS where this object will be displayed.
boolean	isComplete() Determine if this HeaderElement has written all its data.
boolean	isMayForward() Determine if this extended object can be forwarded by SMS.
boolean	isUserPrompt() Determine if this object should be handled as a user prompt.
void	reset() Reset this HeaderElement to its initial state.
void	setData(byte[] data) Set this extended object's data.
void	setMayForward(boolean mayForward) Set if this object may be forwarded by SMS.
void	setObjectPosition(int objectPosition) Set the position in the SMS where this object will be displayed.
void	setUserPrompt(boolean userPrompt) Set if this object should be handled as a user prompt.
boolean	write(int segmentNum, ByteBuffer buffer) Encode this header element to the given ByteBuffer.

Methods inherited from class org.mobicents.protocols.smpp.gsm.AbstractHeaderElement

doWrite, equals, isRecurring, postProcess

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedObject

public ExtendedObject(int objectFormat,
                      int referenceNum)

ExtendedObject

public ExtendedObject(int objectFormat,
                      int referenceNum,
                      byte[] data)

Method Detail

getLength

public int getLength()

Description copied from interface: HeaderElement

Get the total number of octets this header element encodes as excluding the IEI and the IEI-Data-Length fields.

Returns:

The number of octets in this header element's IE-Data, which may exceed 140 octets.

reset

public void reset()

Description copied from interface: HeaderElement

Reset this HeaderElement to its initial state. A HeaderElement must be in its initial state before it can be used to generate SMS segments in a UserData implementation.

Specified by:

reset in interface HeaderElement

Overrides:

reset in class AbstractHeaderElement

isComplete

public boolean isComplete()

Description copied from interface: HeaderElement

Determine if this HeaderElement has written all its data. This is an internal method that is used by UserData implementations.

Specified by:

isComplete in interface HeaderElement

Overrides:

isComplete in class AbstractHeaderElement

Returns:

true if all of this header element's data has been written to SMS segments. Elements which always recur in every SMS segment (such as concatenation) will never return true from this method.

write

public boolean write(int segmentNum,
                     ByteBuffer buffer)

Description copied from interface: HeaderElement

Encode this header element to the given ByteBuffer.

Specified by:

write in interface HeaderElement

Overrides:

write in class AbstractHeaderElement

isMayForward

public boolean isMayForward()

Determine if this extended object can be forwarded by SMS.

Returns:

true if the object may be forwarded, false otherwise.

setMayForward

public void setMayForward(boolean mayForward)

Set if this object may be forwarded by SMS.

Parameters:

mayForward - true if the object may be forwarded, false if not.

isUserPrompt

public boolean isUserPrompt()

Determine if this object should be handled as a user prompt.

Returns:

true if this object should be handled as a user prompt, false if it should be handled normally.

setUserPrompt

public void setUserPrompt(boolean userPrompt)

Set if this object should be handled as a user prompt.

Parameters:

userPrompt - true if this object should be handled as a user prompt, false if it should be handled normally.

getObjectFormat

public int getObjectFormat()

Get the object format of this extended object.

Returns:

An integer representing the object's format.

getObjectPosition

public int getObjectPosition()

Get the position in the SMS where this object will be displayed.

Returns:

The position in the SMS where this object will be displayed.

getData

public byte[] getData()

Get the data of this extended object. This will include the 7-octet extended object header.

Returns:

This object's data.

setData

public void setData(byte[] data)

Set this extended object's data. This should not include the 7-octet header, as this will be generated.

Parameters:

data - This extended object's data.

setObjectPosition

public void setObjectPosition(int objectPosition)

Set the position in the SMS where this object will be displayed.

Parameters:

objectPosition - The position in the SMS where this object will be displayed.