|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher 11g Release 1 (11.1.1) E17789-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.xdo.delivery.DeliveryComponent
oracle.xdo.delivery.AbstractDeliveryRequest
public abstract class AbstractDeliveryRequest
Abstract implementation of the DeliveryRequest. It implements all methods that are common to all types of delivery requests.
Field Summary |
---|
Fields inherited from class oracle.xdo.delivery.DeliveryComponent |
---|
RCS_ID |
Fields inherited from interface oracle.xdo.delivery.DeliveryRequest |
---|
RCS_ID |
Constructor Summary | |
---|---|
AbstractDeliveryRequest() Default constructor |
Method Summary | |
---|---|
void |
cancel() Cancels already submitted delivery request if handler supports cancellation. |
void |
close() Closes this request and frees all the resources. |
java.io.File |
getDocumentFile() Deprecated. It always returns null. |
java.io.InputStream |
getDocumentInputStream() Deprecated. It always returns null. |
java.io.OutputStream |
getDocumentOutputStream() Deprecated. It returns null. |
DeliveryRequestHandler |
getRequestHandler() Returns the delivery request handler. |
int |
getRequestId() Returns request ID <p/> |
DeliveryResponse |
getResponse() |
java.lang.String |
getServer() Returns the server name set by setServer(). |
int |
getStatus() Returns the request status. |
java.lang.String |
getStatusMessage() Returns the request status message. |
java.lang.String |
getType() Returns the request type. |
void |
setDocument(java.io.InputStream pDocument) Sets document to the request. |
void |
setDocument(java.lang.String pFilename) Sets the document. |
void |
setDocument(java.lang.String pDocument, java.lang.String pEncoding) Sets document to the request. |
void |
setRequestId(int pRequestId) Sets request ID <p/> |
void |
setServer(java.lang.String pServerName) Sets the server name defined in the config file. |
void |
setStatus(int pStatus) Sets the request status |
void |
setStatusMessage(java.lang.String pStatusMessage) Sets the request status message. |
DeliveryResponse |
submit() Submits the request (Synchronus). |
void |
submit(DeliveryResponseListener pListener) <p/> |
void |
updateStatus() |
void |
validateProperties() Validates properties. |
Methods inherited from class oracle.xdo.delivery.DeliveryComponent |
---|
addProperties, addProperties, addProperty, getBooleanProperty, getBooleanProperty, getIntegerProperty, getIntegerProperty, getProperties, getProperty, getStringProperty, removeProperty |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.xdo.delivery.DeliveryRequest |
---|
getMandatoryProperties, getOptionalProperties |
Constructor Detail |
---|
public AbstractDeliveryRequest()
Method Detail |
---|
public int getStatus()
getStatus
in interface DeliveryRequest
DeliveryConstants
, DeliveryRequest.getStatus()
public void setStatus(int pStatus)
pStatus
- request status IDDeliveryConstants
public java.lang.String getStatusMessage()
getStatusMessage
in interface DeliveryRequest
DeliveryRequest.getStatusMessage()
public void setStatusMessage(java.lang.String pStatusMessage)
pStatusMessage
- request status messagepublic java.lang.String getType()
getType
in interface DeliveryRequest
DeliveryRequest.getType()
public int getRequestId()
getRequestId
in interface DeliveryRequest
DeliveryRequest.getRequestId()
public void setRequestId(int pRequestId)
setRequestId
in interface DeliveryRequest
pRequestId
- request IDDeliveryRequest.setRequestId(int)
public DeliveryResponse getResponse()
public void setDocument(java.lang.String pDocument, java.lang.String pEncoding) throws DeliveryException
setDocument
in interface DeliveryRequest
pDocument
- document datapEncoding
- Character encoding for the document.DeliveryException
DeliveryRequest.setDocument(java.io.InputStream)
public void setDocument(java.io.InputStream pDocument) throws DeliveryException
setDocument
in interface DeliveryRequest
pDocument
- document input streamDeliveryException
DeliveryRequest.setDocument(java.io.InputStream)
public java.io.InputStream getDocumentInputStream()
public void setDocument(java.lang.String pFilename) throws DeliveryException
setDocument
in interface DeliveryRequest
pFilename
- document file nameDeliveryException
DeliveryRequest.setDocument(java.lang.String)
public java.io.File getDocumentFile()
public DeliveryRequestHandler getRequestHandler()
public java.io.OutputStream getDocumentOutputStream() throws DeliveryException
getDocumentOutputStream
in interface DeliveryRequest
DeliveryException
DeliveryRequest.getDocumentOutputStream()
public void submit(DeliveryResponseListener pListener) throws DeliveryException
submit
in interface DeliveryRequest
pListener
-DeliveryException
DeliveryRequest.submit(oracle.xdo.delivery.DeliveryResponseListener)
public DeliveryResponse submit() throws DeliveryException
DeliveryRequest
submit
in interface DeliveryRequest
DeliveryException
public void validateProperties() throws MissingRequiredPropertyException, InvalidPropertyValueException, UndefinedPropertyException
validateProperties
in class DeliveryComponent
MissingRequiredPropertyException
InvalidPropertyValueException
UndefinedPropertyException
oracle.xdo.delivery.PropertyHandler#validateProperties()
public void setServer(java.lang.String pServerName)
setServer
in interface DeliveryRequest
pServerName
- server namepublic java.lang.String getServer()
getServer
in interface DeliveryRequest
public void cancel()
cancel
in interface DeliveryRequest
public void close()
close
in interface DeliveryRequest
public void updateStatus()
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher 11g Release 1 (11.1.1) E17789-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |