|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher 11g Release 1 (11.1.1) E17789-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeliveryRequest
Delivery request internface.
Field Summary | |
---|---|
static java.lang.String |
RCS_ID |
Method Summary | |
---|---|
void |
cancel() Cancels already submitted delivery request. |
void |
close() Closes this request and frees all the resources. |
java.io.OutputStream |
getDocumentOutputStream() Deprecated. Please use setDocument() to set the document. |
java.lang.String[] |
getMandatoryProperties() Returns the list of mandatory properties. |
java.lang.String[] |
getOptionalProperties() Returns the list of optional properties. |
int |
getRequestId() Returns request ID |
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 the document. |
void |
setRequestId(int pRequestId) Sets request ID |
void |
setServer(java.lang.String pServerName) Sets the server name defined in the config file. |
DeliveryResponse |
submit() Submits the request (Synchronus). |
void |
submit(DeliveryResponseListener pListener) Submits the request (Asynchronus). |
Field Detail |
---|
static final java.lang.String RCS_ID
Method Detail |
---|
java.lang.String getType()
int getStatus()
DeliveryConstants
java.lang.String getStatusMessage()
java.io.OutputStream getDocumentOutputStream() throws DeliveryException
Once you write out all the document data to the output stream, you can call submit() method to finish the request.
DeliveryException
void setDocument(java.io.InputStream pDocument) throws DeliveryException
pDocument
- document input streamDeliveryException
void setDocument(java.lang.String pFilename) throws DeliveryException
pFilename
- document file nameDeliveryException
void setDocument(java.lang.String pDocument, java.lang.String pEncoding) throws DeliveryException
You can pass the document content with a String object. For the encoding parameter, you should pass one of the character encodings supported in Java. Please see the list of supported encodings in the Java documentation for more detail. If you pass null, the default value ("UTF-8") will be used.
pDocument
- document data in a StringpEncoding
- Character encoding for the document.DeliveryException
void setRequestId(int pRequestId)
pRequestId
- request IDint getRequestId()
DeliveryResponse submit() throws DeliveryException
DeliveryException
void submit(DeliveryResponseListener pListener) throws DeliveryException
pListener
-DeliveryException
void setServer(java.lang.String pServerName)
pServerName
- server namejava.lang.String getServer()
void close()
java.lang.String[] getMandatoryProperties()
java.lang.String[] getOptionalProperties()
void cancel()
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher 11g Release 1 (11.1.1) E17789-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |