|
Oracle® WebCenter Content Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.core.idc.AbstractIdcApi
public abstract class AbstractIdcApi
Base class for all RIDC APIs. RIDC API subclasses usually contain specific methods for their business case.
Nested Class Summary | |
---|---|
static interface |
AbstractIdcApi.IdcApiCallback Allow a hook into the processing of the Idc Api calls |
Constructor Summary | |
---|---|
protected |
AbstractIdcApi(oracle.stellent.ridc.IdcClient idcClient) |
Method Summary | |
---|---|
protected oracle.stellent.ridc.protocol.ServiceResponse |
executeService(oracle.stellent.ridc.IdcContext context, oracle.stellent.ridc.model.DataBinder dataBinder) Execute the service using the databinder. |
protected oracle.stellent.ridc.protocol.ServiceResponse |
executeService(oracle.stellent.ridc.IdcContext context, java.util.Map<java.lang.String,java.lang.String> parameters) Execute the service using the provided map of parameters. |
AbstractIdcApi.IdcApiCallback |
getApiCallback() |
oracle.stellent.ridc.IdcClient |
getIdcClient() |
protected oracle.stellent.ridc.model.DataBinder |
getResponseBinder(oracle.stellent.ridc.protocol.ServiceResponse response) Retrieve the data binder from the response and handle all errors |
protected oracle.stellent.ridc.model.DataBinder |
packService(java.util.Map<java.lang.String,java.lang.String> parameters) |
void |
setApiCallback(AbstractIdcApi.IdcApiCallback apiCallback) Set the API callback |
boolean |
validateLocalDataInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... localDataNames) Validate binder and make sure that local values exist in the binder |
boolean |
validateResultSetInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... resultSetNames) Validate the binder and make sure that a set of resultsets exist in the binder |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractIdcApi(oracle.stellent.ridc.IdcClient idcClient)
Method Detail |
---|
public oracle.stellent.ridc.IdcClient getIdcClient()
public AbstractIdcApi.IdcApiCallback getApiCallback()
public void setApiCallback(AbstractIdcApi.IdcApiCallback apiCallback)
apiCallback
- the api callbackprotected oracle.stellent.ridc.model.DataBinder packService(java.util.Map<java.lang.String,java.lang.String> parameters)
protected oracle.stellent.ridc.protocol.ServiceResponse executeService(oracle.stellent.ridc.IdcContext context, java.util.Map<java.lang.String,java.lang.String> parameters) throws oracle.stellent.ridc.IdcClientException
context
- the user contextparameters
- the parametersoracle.stellent.ridc.IdcClientException
protected oracle.stellent.ridc.protocol.ServiceResponse executeService(oracle.stellent.ridc.IdcContext context, oracle.stellent.ridc.model.DataBinder dataBinder) throws oracle.stellent.ridc.IdcClientException
context
- the user contextdataBinder
- the populated databinderoracle.stellent.ridc.IdcClientException
public boolean validateResultSetInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... resultSetNames) throws oracle.stellent.ridc.IdcClientException
binder
- the response from the serverresultSetNames
- the result set names to verifyoracle.stellent.ridc.IdcClientException
public boolean validateLocalDataInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... localDataNames) throws oracle.stellent.ridc.IdcClientException
binder
- the response from the serverlocalDataNames
- the local data namesoracle.stellent.ridc.IdcClientException
protected oracle.stellent.ridc.model.DataBinder getResponseBinder(oracle.stellent.ridc.protocol.ServiceResponse response) throws oracle.stellent.ridc.IdcClientException
response
- the responseoracle.stellent.ridc.IdcClientException
- if an error occurs
|
Oracle® WebCenter Content Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |