oracle.panama.model
Interface Device

All Superinterfaces:

ModelObject, XMLObject

public interface Device

extends ModelObject

A Device is the definition of the target logical device protocol. It can for example be WML11 for WML specific devices, but also WML_Nokia7110 for more Nokia specific WML. Other examples are SMS, EMAIL etc.

Observe that the same physical device can support multiple logical Devices, a phone for example can support both the SMS and the WAP protocols.

Field Summary

Type	Field
static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier

Method Summary

Type	Method
void	addUserAgent(java.lang.String userAgent) Add userAgent to the list of user agent strings used to detect the device
Transformer	findTransformer(java.lang.String mobileXmlVersion) Returns the transformer which can be used for transforming mobile XML Documents
int	getBitsPerPixel() Gets the number of bits per pixel for this device
java.lang.String	getContentType() Gets the content type for this device
java.lang.String	getDescription()
DeviceCategory	getDeviceCategory() Gets the display size type property value
java.lang.String	getEncoding() Gets the encoding value.
java.lang.String[]	getImageFileExtensions()
java.lang.String[]	getImageFormatPreferences() Gets the image format preferences for this device
java.lang.String	getManufacturer() Gets the manufacturer property value
int	getMaxDocSize() Gets the maximum size (in bytes) of the mobile XML document that can be sent to this device
java.lang.String	getMimeType() Gets the mimeType property (String) value.
java.lang.String	getModel() Gets the model property value
java.lang.String	getParsedErrorPage(org.w3c.dom.Element error) Gets a parsed errorPage for this LogicalDevice
java.lang.String	getParsedLoginPage(Arguments arg) Gets a parsed loginPage for this LogicalDevice
java.lang.String	getProlog() Deprecated. As of IAS 1.2 Gets the prolog property (String) value.
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.
java.lang.String[]	getSupportedMobileXmlVersions() Returns an array of mobile xml versions supported by the device
java.lang.String	getTextErrorPage() Gets the errorPage property value.
java.lang.String	getTextLoginPage() Gets the loginPage property value.
Transformer	getTransformer() Deprecated. As of IASW 1.2, replaced by getTransformer(String)
Transformer	getTransformer(java.lang.String mobileXmlVersion) Returns transformer for a mobile xml version
java.lang.String[]	getUserAgents() Gets the list of User Agent Strings which will be used to detect the device
java.lang.String[]	getVideoFileExtensions()
java.lang.String[]	getVideoFormatPreferences() Gets the video format preferences for this device
VideoMode	getVideoMode() Gets the video mode property value
org.w3c.dom.Element	getXMLErrorPage() Gets the errorPage property value.
org.w3c.dom.Element	getXMLLoginPage() Gets the loginPage property value.
boolean	isColorCapable() Is the device color capable?
boolean	isImageCapable() Is the device image capable?
boolean	isNeedsURLCaching() Does this device need URL caching?
boolean	isSupportsAmpersandEntity() Does this device support ampersand entity (&)
boolean	isSupportsCookie() Does the device supports cookie's?
boolean	isSupportsRelativeURL() Does this device supports relative URL's?
boolean	isVideoCapable() Is the device Video Capable?
boolean	isVoiceCapable() Is the device voice capable?
void	modifyUserAgent(java.lang.String oldUserAgent, java.lang.String newUserAgent) Modifies the User Agent
void	removeTransformer(java.lang.String mobileXmlVersion) Removes the transformer for a mobile xml version
void	removeUserAgent(java.lang.String userAgent) Removes userAgent from the list of user agent strings used to detect the device
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)
void	setDeviceCategory(DeviceCategory deviceCategory) Sets the display size type property value
void	setEncoding(java.lang.String encoding) Sets the encoding value for this Device.
void	setImageCapable(boolean imageCapable) Sets the imageCapable propery value
void	setImageFormatPreferences(java.lang.String[] imagePrefs) Sets the image format preferences for this device
void	setManufacturer(java.lang.String manufacturer) Sets the manufacturer property value
void	setMaxDocSize(int maxDocSize) Sets the maximum size (in bytes) of the mobile XML document that can be sent to this device
void	setMimeType(java.lang.String mimeType) Sets the mimeType property (String) value.
void	setModel(java.lang.String model) Sets the model property value
void	setNeedsURLCaching(boolean needsURLCaching) Sets the needsURLCaching property (boolean) value.
void	setProlog(java.lang.String prolog) Deprecated. As of IAS 1.2 Sets the prolog property (String) value.
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	setSupportsAmpersandEntity(boolean supportsAmpersandEntity) Sets the supportsAmpersandEntity propery value
void	setSupportsCookie(boolean supportsCookie) Sets the supportsCookie property value
void	setSupportsRelativeURL(boolean supportsRelativeURL) Sets the supportsRelativeURL property value
void	setTextErrorPage(java.lang.String errorPage) Sets the errorPage property value.
void	setTextLoginPage(java.lang.String loginPage) Sets the loginPage property value.
void	setTransformer(Transformer transformer) Sets the transformer for a mobile xml version
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	setVideoFormatPreferences(java.lang.String[] videoPrefs) Sets the video format preferences for this device
void	setVideoMode(VideoMode videoMode) Sets the video mode property value
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, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

TYPEID

public static final int TYPEID

The type id of this class.

Method Detail

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description text.

getDescription

public java.lang.String getDescription()

Returns:

the description or null if not set.

getTextLoginPage

public java.lang.String getTextLoginPage()

Gets the loginPage property value.

Returns:

The loginPage property value.

See Also:

#setLoginPage

setTextLoginPage

public void setTextLoginPage(java.lang.String loginPage)

Sets the loginPage property value.

Parameters:

loginPage - The new value for the property.

See Also:

#getLoginPage

getXMLLoginPage

public org.w3c.dom.Element getXMLLoginPage()

Gets the loginPage property value.

Returns:

The loginPage property value.

See Also:

setXMLLoginPage(org.w3c.dom.Element)

setXMLLoginPage

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

Sets the loginPage property value.

Parameters:

loginPage - The new value for the property.

See Also:

getXMLLoginPage()

getTextErrorPage

public java.lang.String getTextErrorPage()

Gets the errorPage property value.

Returns:

The errorPage property value.

See Also:

#setErrorPage

setTextErrorPage

public void setTextErrorPage(java.lang.String errorPage)

Sets the errorPage property value.

Parameters:

errorPage - The new value for the property.

See Also:

#getErrorPage

getXMLErrorPage

public org.w3c.dom.Element getXMLErrorPage()

Gets the errorPage property value.

Returns:

The errorPage property value.

See Also:

setXMLErrorPage(org.w3c.dom.Element)

setXMLErrorPage

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

Sets the errorPage property value.

Parameters:

errorPage - The new value for the property.

See Also:

getXMLErrorPage()

getTransformer

public Transformer getTransformer()

Deprecated. As of IASW 1.2, replaced by getTransformer(String)

Returns:

the default transformer

getProlog

public java.lang.String getProlog()

Deprecated. As of IAS 1.2 Gets the prolog property (String) value.

Returns:

The prolog property value.

setProlog

public void setProlog(java.lang.String prolog)

Deprecated. As of IAS 1.2 Sets the prolog property (String) value.

Parameters:

prolog - The new value for the property.

See Also:

getProlog()

isNeedsURLCaching

public boolean isNeedsURLCaching()

Does this device need URL caching?

Returns:

true if the device needs URL caching

See Also:

setNeedsURLCaching(boolean)

setNeedsURLCaching

public void setNeedsURLCaching(boolean needsURLCaching)

Sets the needsURLCaching property (boolean) value.

Parameters:

needsURLCaching - The new value for the property.

See Also:

isNeedsURLCaching()

getEncoding

public java.lang.String getEncoding()

Gets the encoding value.

Returns:

a String with encoding value.

See Also:

setEncoding(java.lang.String)

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding value for this Device.

Parameters:

encoding - The new encoding for this Device

See Also:

getEncoding()

getMimeType

public java.lang.String getMimeType()

Gets the mimeType property (String) value.

Returns:

The mimeType property value.

See Also:

setMimeType(java.lang.String)

setMimeType

public void setMimeType(java.lang.String mimeType)

Sets the mimeType property (String) value.

Parameters:

mimeType - The new value for the property.

See Also:

getMimeType()

getContentType

public java.lang.String getContentType()

Gets the content type for this device

Returns:

the content type

getScreenHeight

public int getScreenHeight()

Gets the screen height in pixels for this Device.

Returns:

int the screen height.

See Also:

setScreenHeight(int)

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()

getScreenWidth

public int getScreenWidth()

Gets the screen width in points for this Device.

Returns:

int the screen width.

See Also:

setScreenWidth(int)

setScreenWidth

public void setScreenWidth(int width)

Sets the screen width in points for this Device.

Parameters:

height - The new screen width for this Device

See Also:

getScreenWidth()

getScreenRows

public int getScreenRows()

Gets the number of character rows for this Device.

Returns:

int the number of rows

See Also:

setScreenRows(int)

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()

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)

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()

getSoftKeys

public int getSoftKeys()

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

Returns:

int the number of "soft" keys

See Also:

setScreenCols(int)

setSoftKeys

public void setSoftKeys(int softKeys)

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

Parameters:

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

See Also:

setSoftKeys(int)

getManufacturer

public java.lang.String getManufacturer()

Gets the manufacturer property value

Returns:

String the device manufacturer

See Also:

setManufacturer(java.lang.String)

setManufacturer

public void setManufacturer(java.lang.String manufacturer)

Sets the manufacturer property value

Parameters:

manufacturer - the device manufacturer

See Also:

getManufacturer()

getModel

public java.lang.String getModel()

Gets the model property value

Returns:

String the device model

See Also:

setModel(java.lang.String)

setModel

public void setModel(java.lang.String model)

Sets the model property value

Parameters:

model - the device model

See Also:

getModel()

getDeviceCategory

public DeviceCategory getDeviceCategory()

Gets the display size type property value

Returns:

DeviceCategory the display size type #see #setDeviceCategory

setDeviceCategory

public void setDeviceCategory(DeviceCategory deviceCategory)

Sets the display size type property value

Parameters:

displaySizeCategory - the new property value

See Also:

getDeviceCategory()

isImageCapable

public boolean isImageCapable()

Is the device image capable?

Returns:

true of device is image capable

See Also:

setImageCapable(boolean)

setImageCapable

public void setImageCapable(boolean imageCapable)

Sets the imageCapable propery value

Parameters:

imageCapable - the new value for the property

See Also:

isImageCapable()

isVideoCapable

public boolean isVideoCapable()

Is the device Video Capable?

Returns:

true if the device is video capable

See Also:

setVideoCapable(boolean)

setVideoCapable

public void setVideoCapable(boolean videoCapable)

Sets the videoCapable property value

Parameters:

videoCapable - the new property value

See Also:

isVideoCapable()

getVideoMode

public VideoMode getVideoMode()

Gets the video mode property value

Returns:

VideoMode the video mode supported by the device

setVideoMode

public void setVideoMode(VideoMode videoMode)

Sets the video mode property value

Parameters:

videoMode - the new property value

isColorCapable

public boolean isColorCapable()

Is the device color capable?

Returns:

true if the device is color capable

See Also:

setColorCapable(boolean)

setColorCapable

public void setColorCapable(boolean colorCapable)

Sets the colorCapable property value

Parameters:

colorCapable - the new property value

See Also:

isColorCapable()

isVoiceCapable

public boolean isVoiceCapable()

Is the device voice capable?

Returns:

true if the device is voice capable

See Also:

setVoiceCapable(boolean)

setVoiceCapable

public void setVoiceCapable(boolean voiceCapable)

Sets the voiceCapable property value

Parameters:

voiceCapable - the new property value

See Also:

isVoiceCapable()

getBitsPerPixel

public int getBitsPerPixel()

Gets the number of bits per pixel for this device

Returns:

int bits per pixel

See Also:

setBitsPerPixel(int)

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()

getMaxDocSize

public int getMaxDocSize()

Gets the maximum size (in bytes) of the mobile XML document that can be sent to this device

Returns:

int maximum size of Mobile XML document

See Also:

setMaxDocSize(int)

setMaxDocSize

public void setMaxDocSize(int maxDocSize)

Sets the maximum size (in bytes) of the mobile XML document that can be sent to this device

Parameters:

maxDocSize - maximum size of the Mobile XML document

See Also:

getMaxDocSize()

isSupportsAmpersandEntity

public boolean isSupportsAmpersandEntity()

Does this device support ampersand entity (&)

Returns:

true if the device supports ampersand entity

See Also:

setSupportsAmpersandEntity(boolean)

setSupportsAmpersandEntity

public void setSupportsAmpersandEntity(boolean supportsAmpersandEntity)

Sets the supportsAmpersandEntity propery value

Parameters:

supportsAmpersandEntity - the new propeerty value

See Also:

isSupportsAmpersandEntity()

isSupportsRelativeURL

public boolean isSupportsRelativeURL()

Does this device supports relative URL's?

Returns:

true if the device supports relative URL's

See Also:

setSupportsRelativeURL(boolean)

setSupportsRelativeURL

public void setSupportsRelativeURL(boolean supportsRelativeURL)

Sets the supportsRelativeURL property value

Parameters:

supportsRelativeURL - the new property value

See Also:

isSupportsRelativeURL()

isSupportsCookie

public boolean isSupportsCookie()

Does the device supports cookie's?

Returns:

true if the device supports cookie #see #setSupportsCookie

setSupportsCookie

public void setSupportsCookie(boolean supportsCookie)

Sets the supportsCookie property value

Parameters:

supportsCookie - the new property value #see #isSupportsCookie

getParsedErrorPage

public java.lang.String getParsedErrorPage(org.w3c.dom.Element error)
                                    throws java.lang.Exception

Gets a parsed errorPage for this LogicalDevice

Parameters:

error - an xml error element of the format
"Error text here"

Returns:

the parsed errorPage

getParsedLoginPage

public java.lang.String getParsedLoginPage(Arguments arg)
                                    throws java.lang.Exception

Gets a parsed loginPage for this LogicalDevice

Parameters:

arg - arguments

Returns:

the parsed loginPage

getImageFormatPreferences

public java.lang.String[] getImageFormatPreferences()

Gets the image format preferences for this device

Returns:

String[] array of image mime types

See Also:

setImageFormatPreferences(java.lang.String[])

getImageFileExtensions

public java.lang.String[] getImageFileExtensions()

Returns:

the image file extensions supported by the device

setImageFormatPreferences

public void setImageFormatPreferences(java.lang.String[] imagePrefs)

Sets the image format preferences for this device

Parameters:

imagePrefs - array of image mime types

See Also:

getImageFormatPreferences()

getVideoFormatPreferences

public java.lang.String[] getVideoFormatPreferences()

Gets the video format preferences for this device

Returns:

String[] array of video mime types

See Also:

setVideoFormatPreferences(java.lang.String[])

getVideoFileExtensions

public java.lang.String[] getVideoFileExtensions()

Returns:

the video file extensions supported by the device

setVideoFormatPreferences

public void setVideoFormatPreferences(java.lang.String[] videoPrefs)

Sets the video format preferences for this device

Parameters:

videoPrefs - array of video mime types

See Also:

getVideoFormatPreferences()

getUserAgents

public java.lang.String[] getUserAgents()

Gets the list of User Agent Strings which will be used to detect the device

Returns:

an array of user agent strings

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

addUserAgent

public void addUserAgent(java.lang.String userAgent)

Add userAgent to the list of user agent strings used to detect the device

Parameters:

userAgent - the user agent string

removeUserAgent

public void removeUserAgent(java.lang.String userAgent)

Removes userAgent from the list of user agent strings used to detect the device

Parameters:

userAgent - teh user agent string

modifyUserAgent

public void modifyUserAgent(java.lang.String oldUserAgent,
                            java.lang.String newUserAgent)

Modifies the User Agent

Parameters:

oldUserAgent - the previous user agent string

newUserAgent - the new user agent string

getTransformer

public Transformer getTransformer(java.lang.String mobileXmlVersion)

Returns transformer for a mobile xml version

Parameters:

mobileXmlVersion - the version of Mobile xml

Returns:

transformer for Mobile XML version version

setTransformer

public void setTransformer(Transformer transformer)

Sets the transformer for a mobile xml version

Parameters:

transformer - the transformer

removeTransformer

public void removeTransformer(java.lang.String mobileXmlVersion)

Removes the transformer for a mobile xml version

Parameters:

mobileXmlVersion - the mobile xml version

getSupportedMobileXmlVersions

public java.lang.String[] getSupportedMobileXmlVersions()

Returns an array of mobile xml versions supported by the device

Returns:

String[] mobile xml versions versions supported by the device

findTransformer

public Transformer findTransformer(java.lang.String mobileXmlVersion)

Returns the transformer which can be used for transforming mobile XML Documents

Parameters:

mobileXmlVersion - the mobile xml version

Returns:

Transformer the transformer