oracle.panama.model
Interface PhysicalDevice

All Superinterfaces:

AttributeQueriable, oracle.panama.core.device.DeviceV2Peer, ModelObject, XMLObject

public interface PhysicalDevice

extends ModelObject, oracle.panama.core.device.DeviceV2Peer

A PhysicalDevice represents a physical device stored in the wireless device repository.

Field Summary

Fields inherited from interface oracle.panama.model.ModelObject

TYPEID

Method Summary

DeliveryContextAttribute	addDeliveryContextAttribute(java.lang.String name, boolean value) Add the delivery context attribute with the given name.
DeliveryContextAttribute	addDeliveryContextAttribute(java.lang.String name, java.lang.String value) Add the delivery context attribute with the given name.
DeliveryContextAttribute	addDeliveryContextAttribute(java.lang.String name, java.lang.String[] vals) Add the delivery context attribute with the given name.
void	addDynamicAttribute(java.lang.String name, java.lang.String value) Add a new DynamicAttribute
void	addMeta(java.lang.String name, java.lang.String value) Add a new meta
void	addProperty(java.lang.String name, java.lang.String value) Add a new property
void	addTransformer(Transformer transformer) Add a transformer
java.util.HashMap	getAllDynamicAttributes() Returns all DynamicAttribute of this object as a name value pair.
DeliveryContextAttribute[]	getAttributes() Get all the delivery context attribute for the physical device.
int	getBitsPerPixel() Gets the number of bits per pixel for this device
DeliveryContextAttribute	getDeliveryContextAttribute(java.lang.String name) Get the delivery context attribute with the given name.
java.lang.String	getDescription() Returns the description for the device.
java.lang.String	getDynamicAttribute(java.lang.String name) Returns the value of a named DynamicAttribute or null if the DynamicAttribute does not exist
long	getHeapSize() Get the heap size in kilobytes.
java.lang.String	getManufacturer() Get the manufacturer of the physical device.
long	getMaxDownloadSize() Get the maximum download size.
java.lang.String	getMeta(java.lang.String name) Returns the value of a named meta or null if the meta does not exist
java.util.HashMap	getMetas() Returns all Metas of this object as a name value pair.
java.lang.String	getMimeType() Returns the mime type that specifies the markup language the device supports.
java.lang.String	getModel() Get the model of the physical device.
java.lang.String	getName() Gets the name of the physical device
java.lang.String	getProfile() Get the profile string.
java.lang.String	getProlog() Return the prolog for the device.
java.util.HashMap	getProperties() Returns all Properties of this object as a name value pair.
java.lang.String	getProperty(java.lang.String name) Returns the value of a named property or null if the property does not exist
java.lang.String	getProvisionProtocol() Get the provisioning protocol.
int	getScreenCols() Gets the number of characters per row for this Device.
int	getScreenHeight() Gets the screen height in pixels for this Device.
int	getScreenRows() Gets the number of character rows for this Device.
int	getScreenWidth() Gets the screen width in points for this Device.
int	getSoftKeys() Gets the number of "soft" keys for this Device.
Transformer[]	getTransformers() Get the transformers
VideoMode	getVideoMode() Gets the video mode property value
java.lang.String	getVM() Retrieves the VM information.
boolean	isColorCapable() Is the device color capable?
boolean	isImageCapable() Is the device image capable?
boolean	isJavaCapable() Returns whether the physical device is java-capable.
boolean	isVideoCapable() Is the device Video Capable?
boolean	isVoiceCapable() Is the device voice capable?
void	removeDeliveryContextAttribute(java.lang.String name) Remove an attribute from a physical device.
void	removeDynamicAttribute(java.lang.String name) Remove a DynamicAttribute
void	removeMeta(java.lang.String name) Remove a meta
void	removeProperty(java.lang.String name) Remove a property
void	removeTransformer(Transformer transformer) Remove a transformer
void	setBitsPerPixel(int bitsPerPixel) Sets the number of bits per pixel for this device
void	setColorCapable(boolean colorCapable) Sets the colorCapable property value
void	setDescription(java.lang.String description) Set the description for the device.
void	setHeapSize(long size) Set the heap size in kilobytes.
void	setImageCapable(boolean imageCapable) Sets the imageCapable propery value
void	setJavaCapable(boolean javaCapable) Set whether the physical device is java-capable.
void	setManufacturer(java.lang.String manufacturer) Set the manufacturer for the physical device.
void	setMaxDownloadSize(long maxDownloadSize) Set the maximum download size.
void	setMediaType(java.lang.String mediaType) Sets the media type property value
void	setMimeType(java.lang.String mimeType) Set the mime type that specifies the markup language the device supports.
void	setModel(java.lang.String model) Set the model for the physical device.
void	setName(java.lang.String name) Sets the name of the physical device.
void	setProfile(java.lang.String profile) Sets the profile string.
void	setProlog(java.lang.String prolog) Set the prolog for the device.
void	setProvisionProtocol(java.lang.String protocol) Set the provisioning protocol.
void	setScreenCols(int cols) Sets the number of characters per row for this Device.
void	setScreenHeight(int height) Sets the screen height in pixels for this Device.
void	setScreenRows(int rows) Sets the number of character rows for this Device.
void	setScreenWidth(int width) Sets the screen width in points for this Device.
void	setSoftKeys(int softKeys) Sets the number of "soft" keys for this Device.
void	setUserAgents(java.lang.String[] userAgents) Sets User Agent Strings which will be used to detect the device
void	setVideoCapable(boolean videoCapable) Sets the videoCapable property value
void	setVideoMode(VideoMode videoMode) Sets the video mode property value
void	setVM(java.lang.String vm) Sets the VM Information.
void	setVoiceCapable(boolean voiceCapable) Sets the voiceCapable property value
void	setXMLErrorPage(org.w3c.dom.Element errorPage) Sets the errorPage property value.
void	setXMLLoginPage(org.w3c.dom.Element loginPage) Sets the loginPage property value.

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getTypeId, getTypeName, isSystem, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Methods inherited from interface oracle.panama.core.device.DeviceV2Peer

addASREngine, addDeviceGroup, addTTSEngine, delete, findTransformer, getASREngines, getDefaultTransformer, getDeviceGroups, getDeviceV2, getErrorPage, getId, getLoginPage, getMediaType, getSupportedLanguageVersions, getTransformer, getTTSEngines, getUserAgents, getXMLErrorPage, getXMLLoginPage, removeASREngine, removeDeviceGroup, removeTTSEngine

Method Detail

addDeliveryContextAttribute

public DeliveryContextAttribute addDeliveryContextAttribute(java.lang.String name,
                                                            boolean value)

Add the delivery context attribute with the given name. The name given must be valid in the sense that it corresponds to the name of a attribute specified in our documentation.

Parameters:

name - The name for the attribute.

value - The value for the attribute.

addDeliveryContextAttribute

public DeliveryContextAttribute addDeliveryContextAttribute(java.lang.String name,
                                                            java.lang.String value)

Add the delivery context attribute with the given name. The name given must be valid in the sense that it corresponds to the name of a attribute specified in our documentation.

Parameters:

name - The name for the attribute.

value - The value for the attribute.

addDeliveryContextAttribute

public DeliveryContextAttribute addDeliveryContextAttribute(java.lang.String name,
                                                            java.lang.String[] vals)

Add the delivery context attribute with the given name. The name given must be valid in the sense that it corresponds to the name of a attribute specified in our documentation.

Specified by:

addDeliveryContextAttribute in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - The name for the attribute.

vals - The LOV for the attribute.

Returns:

The newly added delivery context attribute.

addDynamicAttribute

public void addDynamicAttribute(java.lang.String name,
                                java.lang.String value)
                         throws java.lang.IllegalArgumentException

Add a new DynamicAttribute

Specified by:

addDynamicAttribute in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the DynamicAttribute

value - the value of the DynamicAttribute

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

addMeta

public void addMeta(java.lang.String name,
                    java.lang.String value)
             throws java.lang.IllegalArgumentException

Add a new meta

Specified by:

addMeta in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the meta

value - the value of the meta

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)
                 throws java.lang.IllegalArgumentException

Add a new property

Specified by:

addProperty in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the property

value - the value of the property

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

addTransformer

public void addTransformer(Transformer transformer)

Add a transformer

Parameters:

transformer - the transformer to add

getAllDynamicAttributes

public java.util.HashMap getAllDynamicAttributes()

Returns all DynamicAttribute of this object as a name value pair. The name is the key and the value is the value in the HashMap

Specified by:

getAllDynamicAttributes in interface oracle.panama.core.device.DeviceV2Peer

Returns:

HashMap

getAttributes

public DeliveryContextAttribute[] getAttributes()

Get all the delivery context attribute for the physical device.

Returns:

the list of the delivery context attribute for the PhysicalDevice.

getBitsPerPixel

public int getBitsPerPixel()

Gets the number of bits per pixel for this device

Returns:

int bits per pixel

See Also:

setBitsPerPixel(int)

getDeliveryContextAttribute

public DeliveryContextAttribute getDeliveryContextAttribute(java.lang.String name)

Get the delivery context attribute with the given name.

Specified by:

getDeliveryContextAttribute in interface AttributeQueriable

Parameters:

name - The name of the attribute, You should only use the constants defined inside DeliveryContextAttributeNames interface.

Returns:

the DeliveryContextAttribute that matches the given name. Null if not found.

getDescription

public java.lang.String getDescription()

Returns the description for the device.

Specified by:

getDescription in interface oracle.panama.core.device.DeviceV2Peer

Returns:

the description for the device.

getDynamicAttribute

public java.lang.String getDynamicAttribute(java.lang.String name)
                                     throws java.lang.IllegalArgumentException

Returns the value of a named DynamicAttribute or null if the DynamicAttribute does not exist

Specified by:

getDynamicAttribute in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the DynamicAttribute

Returns:

String the value of a named DynamicAttribute or null if the DynamicAttribute does not exist

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

getHeapSize

public long getHeapSize()

Get the heap size in kilobytes.

Returns:

heap size in kilobytes.

getManufacturer

public java.lang.String getManufacturer()

Get the manufacturer of the physical device.

Returns:

manufacturer of the physical device.

getMaxDownloadSize

public long getMaxDownloadSize()

Get the maximum download size.

Returns:

maximum download size in kilobytes.

getMeta

public java.lang.String getMeta(java.lang.String name)
                         throws java.lang.IllegalArgumentException

Returns the value of a named meta or null if the meta does not exist

Specified by:

getMeta in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the meta

Returns:

String the value of a named meta or null if the meta does not exist

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

getMetas

public java.util.HashMap getMetas()

Returns all Metas of this object as a name value pair. The name is the key and the value is the value in the HashMap

Specified by:

getMetas in interface oracle.panama.core.device.DeviceV2Peer

Returns:

HashMap

getMimeType

public java.lang.String getMimeType()

Returns the mime type that specifies the markup language the device supports.

getModel

public java.lang.String getModel()

Get the model of the physical device.

Returns:

model of the physical device.

getName

public java.lang.String getName()

Gets the name of the physical device

Specified by:

getName in interface ModelObject

Returns:

the name of the physical device

getProfile

public java.lang.String getProfile()

Get the profile string.

Returns:

profile

getProlog

public java.lang.String getProlog()

Return the prolog for the device.

Returns:

The prolog for the device.

getProperties

public java.util.HashMap getProperties()

Returns all Properties of this object as a name value pair. The name is the key and the value is the value in the HashMap

Specified by:

getProperties in interface oracle.panama.core.device.DeviceV2Peer

Returns:

HashMap

getProperty

public java.lang.String getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Returns the value of a named property or null if the property does not exist

Specified by:

getProperty in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the property

Returns:

String the value of a named property or null if the property does not exist

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

getProvisionProtocol

public java.lang.String getProvisionProtocol()

Get the provisioning protocol.

Returns:

provision protocol.

getScreenCols

public int getScreenCols()

Gets the number of characters per row for this Device.

Returns:

int the number of characters per row

See Also:

setScreenCols(int)

getScreenHeight

public int getScreenHeight()

Gets the screen height in pixels for this Device.

Returns:

int the screen height.

See Also:

setScreenHeight(int)

getScreenRows

public int getScreenRows()

Gets the number of character rows for this Device.

Returns:

int the number of rows

See Also:

setScreenRows(int)

getScreenWidth

public int getScreenWidth()

Gets the screen width in points for this Device.

Returns:

int the screen width.

See Also:

setScreenWidth(int)

getSoftKeys

public int getSoftKeys()

Gets the number of "soft" keys for this Device.

Returns:

int the number of "soft" keys

See Also:

setScreenCols(int)

getTransformers

public Transformer[] getTransformers()

Get the transformers

Returns:

a set of transformers as an array.

getVideoMode

public VideoMode getVideoMode()

Gets the video mode property value

Returns:

VideoMode the video mode supported by the device

getVM

public java.lang.String getVM()

Retrieves the VM information.

Returns:

vm, e.g., CLDC

isColorCapable

public boolean isColorCapable()

Is the device color capable?

Returns:

true if the device is color capable

See Also:

setColorCapable(boolean)

isImageCapable

public boolean isImageCapable()

Is the device image capable?

Returns:

true of device is image capable

See Also:

setImageCapable(boolean)

isJavaCapable

public boolean isJavaCapable()

Returns whether the physical device is java-capable.

Returns:

true if java-capable, false otherwise.

isVideoCapable

public boolean isVideoCapable()

Is the device Video Capable?

Returns:

true if the device is video capable

See Also:

setVideoCapable(boolean)

isVoiceCapable

public boolean isVoiceCapable()

Is the device voice capable?

Returns:

true if the device is voice capable

See Also:

setVoiceCapable(boolean)

removeDeliveryContextAttribute

public void removeDeliveryContextAttribute(java.lang.String name)

Remove an attribute from a physical device.

Parameters:

name - the name of the attribute to be removed. It's an no-op if the attribute can not be found.

removeDynamicAttribute

public void removeDynamicAttribute(java.lang.String name)
                            throws java.lang.IllegalArgumentException

Remove a DynamicAttribute

Specified by:

removeDynamicAttribute in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the DynamicAttribute

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

removeMeta

public void removeMeta(java.lang.String name)
                throws java.lang.IllegalArgumentException

Remove a meta

Specified by:

removeMeta in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the meta

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

removeProperty

public void removeProperty(java.lang.String name)
                    throws java.lang.IllegalArgumentException

Remove a property

Specified by:

removeProperty in interface oracle.panama.core.device.DeviceV2Peer

Parameters:

name - the name of the property

Throws:

java.lang.IllegalArgumentException - if either the name of the value are null

removeTransformer

public void removeTransformer(Transformer transformer)

Remove a transformer

Parameters:

transformer - the transformer to remove

setBitsPerPixel

public void setBitsPerPixel(int bitsPerPixel)

Sets the number of bits per pixel for this device

Parameters:

bitsPerPixel - the new bits per pixel for this device

See Also:

getBitsPerPixel()

setColorCapable

public void setColorCapable(boolean colorCapable)

Sets the colorCapable property value

Parameters:

colorCapable - the new property value

See Also:

isColorCapable()

setDescription

public void setDescription(java.lang.String description)

Set the description for the device.

Parameters:

description - The description for the device.

setHeapSize

public void setHeapSize(long size)

Set the heap size in kilobytes.

Parameters:

size - heap size in kilobytes

setImageCapable

public void setImageCapable(boolean imageCapable)

Sets the imageCapable propery value

Parameters:

imageCapable - the new value for the property

See Also:

isImageCapable()

setJavaCapable

public void setJavaCapable(boolean javaCapable)

Set whether the physical device is java-capable.

Parameters:

javaCapable - if device capable of running java application

setManufacturer

public void setManufacturer(java.lang.String manufacturer)

Set the manufacturer for the physical device.

Parameters:

manufacturer - manufacturer of the physical device

setMaxDownloadSize

public void setMaxDownloadSize(long maxDownloadSize)

Set the maximum download size.

Parameters:

maxDownloadSize - maximum download size in kilobytes.

setMediaType

public void setMediaType(java.lang.String mediaType)

Sets the media type property value

Parameters:

mediaType - the new property value

See Also:

DeviceV2Peer.getMediaType()

setMimeType

public void setMimeType(java.lang.String mimeType)

Set the mime type that specifies the markup language the device supports.

setModel

public void setModel(java.lang.String model)

Set the model for the physical device.

Parameters:

model - of the physical device.

setName

public void setName(java.lang.String name)

Sets the name of the physical device.

Specified by:

setName in interface ModelObject

Parameters:

name - The name of the physical device

setProfile

public void setProfile(java.lang.String profile)

Sets the profile string.

Parameters:

profile - profile

setProlog

public void setProlog(java.lang.String prolog)

Set the prolog for the device.

Parameters:

prolog - The prolog for the device.

setProvisionProtocol

public void setProvisionProtocol(java.lang.String protocol)

Set the provisioning protocol.

Parameters:

protocol - provision protocol.

setScreenCols

public void setScreenCols(int cols)

Sets the number of characters per row for this Device.

Parameters:

cols - The new number of characters per row for this Device

See Also:

getScreenCols()

setScreenHeight

public void setScreenHeight(int height)

Sets the screen height in pixels for this Device.

Parameters:

height - The new screen height for this Device

See Also:

getScreenHeight()

setScreenRows

public void setScreenRows(int rows)

Sets the number of character rows for this Device.

Parameters:

rows - The new number of rows for this Device

See Also:

getScreenRows()

setScreenWidth

public void setScreenWidth(int width)

Sets the screen width in points for this Device.

Parameters:

width - The new screen width for this Device

See Also:

getScreenWidth()

setSoftKeys

public void setSoftKeys(int softKeys)

Sets the number of "soft" keys for this Device.

Parameters:

softKeys - The new number of "soft" keys for this Device

See Also:

setSoftKeys(int)

setUserAgents

public void setUserAgents(java.lang.String[] userAgents)

Sets User Agent Strings which will be used to detect the device

Parameters:

userAgents - array of user agent strings

setVideoCapable

public void setVideoCapable(boolean videoCapable)

Sets the videoCapable property value

Parameters:

videoCapable - the new property value

See Also:

isVideoCapable()

setVideoMode

public void setVideoMode(VideoMode videoMode)

Sets the video mode property value

Parameters:

videoMode - the new property value

setVM

public void setVM(java.lang.String vm)

Sets the VM Information.

Parameters:

vm - vm information string, such as CLDC

setVoiceCapable

public void setVoiceCapable(boolean voiceCapable)

Sets the voiceCapable property value

Parameters:

voiceCapable - the new property value

See Also:

isVoiceCapable()

setXMLErrorPage

public void setXMLErrorPage(org.w3c.dom.Element errorPage)

Sets the errorPage property value.

Parameters:

errorPage - The new value for the property.

See Also:

DeviceV2Peer.getXMLErrorPage()

setXMLLoginPage

public void setXMLLoginPage(org.w3c.dom.Element loginPage)

Sets the loginPage property value.

Parameters:

loginPage - The new value for the property.

See Also:

DeviceV2Peer.getXMLLoginPage()