Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.model
Interface UserDownloadStatus

All Superinterfaces:
BillingContext

public interface UserDownloadStatus
extends BillingContext

The User download status is an audit interface which is recorded when a particular j2me content is requested for download it encapsulates the user, deliverable content, deliverable application, device information, time stamp and the donwload statuses Caution: All setters be invoked only by the ProvisioningManager or the Download servlet


Field Summary
static java.lang.String DOWNLOAD_CANCELLED
           
static java.lang.String DOWNLOAD_FAILED
           
static java.lang.String DOWNLOAD_PENDING
          Display Status codes
static java.lang.String DOWNLOAD_SUCCESS
           
static java.lang.String DOWNLOAD_SUCCESS_CONFIRMED
           
static java.lang.String STATUS_AUTH_FAILED
          The status when the download is rejected after the pre download authorization
static java.lang.String STATUS_COMPLETE
          The status set by the download server (SUNOTA servlet) after all the contents are written back to the client
static java.lang.String STATUS_CREATED
          The status when the download operation is attempted for the contents (jad and jar)
static java.lang.String STATUS_FAILED
          The status set by the download server (SUNOTA servlet) writing the contents back failed
static java.lang.String STATUS_NOTIFIED_ATTRIBUTE_MISMATCH
          The status set by the download server (SUNOTA servlet) after an "Attribute Mismatch" notification from download client
static java.lang.String STATUS_NOTIFIED_INSUF_MEMORY
          The status set by the download server (SUNOTA servlet) after an "insufficient memory" notification from download client
static java.lang.String STATUS_NOTIFIED_INVALID_DESCRIPTOR
          The status set by the download server (SUNOTA servlet) after an "Invalid Descriptor" notification from download client
static java.lang.String STATUS_NOTIFIED_JAR_SIZE_MISMATCH
          The status set by the download server (SUNOTA servlet) after an "Jar Size Mismatch" notification from download client
static java.lang.String STATUS_NOTIFIED_LOSS_OF_SERVICE
          The status set by the download server (SUNOTA servlet) after an "loss of service" notification from download client
static java.lang.String STATUS_NOTIFIED_SUCCESS
          The status set by the download server (SUNOTA servlet) after a "success" notification from download client
static java.lang.String STATUS_NOTIFIED_USER_CANCELLED
          The status set by the download server (SUNOTA servlet) after an "user cancelled" notification from download client
static java.lang.String STATUS_REDOWNLOAD_REJECTED
          The status when the download is rejected after the pre download authorization
static java.lang.String STATUS_REQUESTED
          The status when the particular content based on mime type is requested by the provisioning driver

 

Fields inherited from interface oracle.wireless.billing.BillingContext
ALERT_COMPONENT, MESSAGING_COMPONENT, PROVISIONING_COMPONENT, RUNTIME_COMPONENT

 

Method Summary
 DeliverableApplication getApplication()
           
 DeliverableContent getContent()
           
 java.lang.String getControlNumber()
          Returns the control number of the download operation.
 UserDevice getDevice()
          Returns the UserDevice of the requestor
 DeviceAddress getDeviceAddress()
          Returns the DeviceAddress of the requestor
 java.lang.String getDisplayStatus(java.lang.String initStatus)
           
 long getDownloadId()
          returns the internal audit sequence number
 DRMPolicy getDRMPolicy()
          Returns the Digital Rights Management Policy associated with this download.
 java.lang.String getExternalId()
          Returns the external id of the downloaded process.
 java.sql.Timestamp getLastDownloadTimestamp()
          Returns the LastDownloadTimestamp
 java.lang.String getMimeType()
          Returns the mimetype of the downloaded content.
 long getNumberOfDownloads()
          returns the current number of downloads by the user for this content
 java.sql.Timestamp getRequestTimestamp()
          Returns the download operation request timestamp
 Service getService()
          Returns the Service/Link which the user chose to make this download
 java.lang.String getStatus()
          returns the current status of the download object.
 User getUser()
           
 java.lang.String getVersion()
          Returns the version of the downloaded content.
 void incrementNumberOfDownloads()
          Increments the download status object Caution: Set must be called only by the ProvisioningManager or the Download servlet
 void save()
          Commits changes to the database
 void setControlNumber(java.lang.String controlNumber)
          Sets the control number of the download operation.
 void setDevice(UserDevice device)
          Sets the UserDevice of the requestor Caution: Set must be called only by the ProvisioningManager or the Download servlet
 void setDeviceAddress(DeviceAddress deviceAddress)
          Sets the DeviceAddress of the requestor Caution: Set must be called only by the ProvisioningManager or the Download servlet
 void setDRMPolicy(DRMPolicy policy)
          Sets the Digital Rights Management Policy associated with this download.
 void setExternalId(java.lang.String externalId)
          Sets the External Id.
 void setLastDownloadTimeStamp(java.sql.Timestamp timestamp)
          Sets the LastDownloadTimestamp Caution: Set must be called only by the ProvisioningManager or the Download servlet
 void setMimeType(java.lang.String mimeType)
          Sets the mime type Caution: Set must be called only by the ProvisioningManager or the Download servlet
 void setService(Service service)
          Service the Service/Link which the user chose to make this download
 void setStatus(java.lang.String status)
          Sets the current status of the download object.
 void setVersion(java.lang.String version)
          Sets the version Caution: Set must be called only by the ProvisioningManager or the Download servlet

 

Field Detail

STATUS_CREATED

public static final java.lang.String STATUS_CREATED
The status when the download operation is attempted for the contents (jad and jar)
See Also:
Constant Field Values

STATUS_REQUESTED

public static final java.lang.String STATUS_REQUESTED
The status when the particular content based on mime type is requested by the provisioning driver
See Also:
Constant Field Values

STATUS_AUTH_FAILED

public static final java.lang.String STATUS_AUTH_FAILED
The status when the download is rejected after the pre download authorization
See Also:
Constant Field Values

STATUS_REDOWNLOAD_REJECTED

public static final java.lang.String STATUS_REDOWNLOAD_REJECTED
The status when the download is rejected after the pre download authorization
See Also:
Constant Field Values

STATUS_COMPLETE

public static final java.lang.String STATUS_COMPLETE
The status set by the download server (SUNOTA servlet) after all the contents are written back to the client
See Also:
Constant Field Values

STATUS_FAILED

public static final java.lang.String STATUS_FAILED
The status set by the download server (SUNOTA servlet) writing the contents back failed
See Also:
Constant Field Values

STATUS_NOTIFIED_SUCCESS

public static final java.lang.String STATUS_NOTIFIED_SUCCESS
The status set by the download server (SUNOTA servlet) after a "success" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_INSUF_MEMORY

public static final java.lang.String STATUS_NOTIFIED_INSUF_MEMORY
The status set by the download server (SUNOTA servlet) after an "insufficient memory" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_USER_CANCELLED

public static final java.lang.String STATUS_NOTIFIED_USER_CANCELLED
The status set by the download server (SUNOTA servlet) after an "user cancelled" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_LOSS_OF_SERVICE

public static final java.lang.String STATUS_NOTIFIED_LOSS_OF_SERVICE
The status set by the download server (SUNOTA servlet) after an "loss of service" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_JAR_SIZE_MISMATCH

public static final java.lang.String STATUS_NOTIFIED_JAR_SIZE_MISMATCH
The status set by the download server (SUNOTA servlet) after an "Jar Size Mismatch" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_ATTRIBUTE_MISMATCH

public static final java.lang.String STATUS_NOTIFIED_ATTRIBUTE_MISMATCH
The status set by the download server (SUNOTA servlet) after an "Attribute Mismatch" notification from download client
See Also:
Constant Field Values

STATUS_NOTIFIED_INVALID_DESCRIPTOR

public static final java.lang.String STATUS_NOTIFIED_INVALID_DESCRIPTOR
The status set by the download server (SUNOTA servlet) after an "Invalid Descriptor" notification from download client
See Also:
Constant Field Values

DOWNLOAD_PENDING

public static final java.lang.String DOWNLOAD_PENDING
Display Status codes
See Also:
Constant Field Values

DOWNLOAD_SUCCESS

public static final java.lang.String DOWNLOAD_SUCCESS
See Also:
Constant Field Values

DOWNLOAD_SUCCESS_CONFIRMED

public static final java.lang.String DOWNLOAD_SUCCESS_CONFIRMED
See Also:
Constant Field Values

DOWNLOAD_FAILED

public static final java.lang.String DOWNLOAD_FAILED
See Also:
Constant Field Values

DOWNLOAD_CANCELLED

public static final java.lang.String DOWNLOAD_CANCELLED
See Also:
Constant Field Values
Method Detail

getDownloadId

public long getDownloadId()
returns the internal audit sequence number
Returns:
long the download id

getUser

public User getUser()

getApplication

public DeliverableApplication getApplication()

getContent

public DeliverableContent getContent()

getStatus

public java.lang.String getStatus()
returns the current status of the download object. Also indicates the status of the content download
Returns:
String the status

setStatus

public void setStatus(java.lang.String status)
Sets the current status of the download object. Also indicates the status of the content download. Caution: The status must be set only by the ProvisioningManager or the Download servlet

getControlNumber

public java.lang.String getControlNumber()
Returns the control number of the download operation. The control number is a unique key mapping to the jar and jad download transaction of a user
Returns:
String the control number

setControlNumber

public void setControlNumber(java.lang.String controlNumber)
Sets the control number of the download operation. The control number is a unique key mapping to the jar and jad download transaction of a user Caution: The status must be set only by the ProvisioningManager or the Download servlet

getRequestTimestamp

public java.sql.Timestamp getRequestTimestamp()
Returns the download operation request timestamp
Returns:
Timestamp the RequestTimestamp

getLastDownloadTimestamp

public java.sql.Timestamp getLastDownloadTimestamp()
Returns the LastDownloadTimestamp
Returns:
Timestamp the LastDownloadTimestamp

setLastDownloadTimeStamp

public void setLastDownloadTimeStamp(java.sql.Timestamp timestamp)
Sets the LastDownloadTimestamp Caution: Set must be called only by the ProvisioningManager or the Download servlet

getMimeType

public java.lang.String getMimeType()
Returns the mimetype of the downloaded content.
Returns:
String the mime type

setMimeType

public void setMimeType(java.lang.String mimeType)
Sets the mime type Caution: Set must be called only by the ProvisioningManager or the Download servlet

getVersion

public java.lang.String getVersion()
Returns the version of the downloaded content.
Returns:
String the version

setVersion

public void setVersion(java.lang.String version)
Sets the version Caution: Set must be called only by the ProvisioningManager or the Download servlet

getDeviceAddress

public DeviceAddress getDeviceAddress()
Returns the DeviceAddress of the requestor
Returns:
DeviceAddress the DeviceAddress

setDeviceAddress

public void setDeviceAddress(DeviceAddress deviceAddress)
Sets the DeviceAddress of the requestor Caution: Set must be called only by the ProvisioningManager or the Download servlet

getDevice

public UserDevice getDevice()
Returns the UserDevice of the requestor
Returns:
UserDevice the UserDevice

setDevice

public void setDevice(UserDevice device)
Sets the UserDevice of the requestor Caution: Set must be called only by the ProvisioningManager or the Download servlet

getNumberOfDownloads

public long getNumberOfDownloads()
returns the current number of downloads by the user for this content
Returns:
long the number of downloads by the user for this content

incrementNumberOfDownloads

public void incrementNumberOfDownloads()
Increments the download status object Caution: Set must be called only by the ProvisioningManager or the Download servlet

getExternalId

public java.lang.String getExternalId()
Returns the external id of the downloaded process. This is used if an external system like a workflow process is involved in the download. The external id serves as a foreign key to that process
Returns:
String the version

setExternalId

public void setExternalId(java.lang.String externalId)
Sets the External Id. This is used if an external system like a workflow process is involved in the download. The external id serves as a foreign key to that process Caution: Set must be called only by the ProvisioningManager or the Download servlet

setDRMPolicy

public void setDRMPolicy(DRMPolicy policy)
Sets the Digital Rights Management Policy associated with this download. Caution: Set must be called only by the ProvisioningManager or the Download servlet

getDRMPolicy

public DRMPolicy getDRMPolicy()
Returns the Digital Rights Management Policy associated with this download.
Returns:
DRMPolicy the DRMPolicy, null if no DRM policy is associated with this download

getService

public Service getService()
Returns the Service/Link which the user chose to make this download
Returns:
Service The service picked by the user

setService

public void setService(Service service)
Service the Service/Link which the user chose to make this download

getDisplayStatus

public java.lang.String getDisplayStatus(java.lang.String initStatus)
Parameters:
initStatus - The status code set in the User Download Status object
Returns:
String containing the display status

save

public void save()
          throws PanamaException
Commits changes to the database
PanamaException

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.