Skip navigation links

oracle.stellent.wcm.core.idc.impl
Class ContentCheckinApi

java.lang.Object
oracle.stellent.wcm.core.idc.AbstractIdcApi
oracle.stellent.wcm.core.idc.impl.ContentCheckinApi

public class ContentCheckinApi

extends AbstractIdcApi

API for handling checking content in and out of the Content Server

Nested Class Summary

Nested classes/interfaces inherited from class oracle.stellent.wcm.core.idc.AbstractIdcApi

AbstractIdcApi.IdcApiCallback

Constructor Summary

ContentCheckinApi(oracle.stellent.ridc.IdcClient idcClient)

Method Summary

oracle.stellent.ridc.model.DataBinder	checkInDocumentByName(oracle.stellent.ridc.IdcContext userContext, java.lang.String dDocName, oracle.stellent.ridc.model.TransferFile transferStream, java.util.Map<java.lang.String,java.lang.String> metadata) Checkin a document.
oracle.stellent.ridc.model.DataBinder	checkoutDocumentByName(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) Checkout a file by name.
oracle.stellent.ridc.model.DataBinder	checkoutDocumentByName(oracle.stellent.ridc.IdcContext userContext, java.lang.String dDocName) Checkout a file by name.
oracle.stellent.ridc.model.DataBinder	createAssetWithDefaultMetadata(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) Creates a asset with default metadata
oracle.stellent.ridc.model.DataBinder	createAssetWithDefaultMetadata(oracle.stellent.ridc.IdcContext userContext, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a asset with default metadata
oracle.stellent.ridc.model.DataBinder	getCheckedOutItems(oracle.stellent.ridc.IdcContext userContext, boolean userOnly) Discover the items currently checked out in the given adapter for the adapter identity.
oracle.stellent.ridc.model.DataBinder	getCheckedOutItems(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) Discover the items currently checked out in the given adapter for the adapter identity.
oracle.stellent.ridc.model.DataBinder	packCheckoutDocumentByName(java.lang.String dDocName)
oracle.stellent.ridc.model.DataBinder	packCreateAssetWithDefaultMetadata(java.util.Map<java.lang.String,java.lang.String> parameters) Generate request binder
oracle.stellent.ridc.model.DataBinder	packGetCheckedOutItems(boolean userOnly) Generate request binder for checkout items
oracle.stellent.ridc.model.DataBinder	packUndoCheckout(java.lang.String dDocName) Generate requets binder
oracle.stellent.ridc.model.DataBinder	undoCheckout(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) Generate request binder
oracle.stellent.ridc.model.DataBinder	undoCheckout(oracle.stellent.ridc.IdcContext userContext, java.lang.String dDocName) Undo the checkout.

Methods inherited from class oracle.stellent.wcm.core.idc.AbstractIdcApi

executeService, executeService, getApiCallback, getIdcClient, getResponseBinder, packService, setApiCallback, validateLocalDataInBinder, validateResultSetInBinder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentCheckinApi

public ContentCheckinApi(oracle.stellent.ridc.IdcClient idcClient)

Method Detail

getCheckedOutItems

public oracle.stellent.ridc.model.DataBinder getCheckedOutItems(oracle.stellent.ridc.IdcContext userContext,
                                                                boolean userOnly)
                                                         throws oracle.stellent.ridc.IdcClientException

Discover the items currently checked out in the given adapter for the adapter identity.

Parameters:

userContext - the user context

userOnly - true to only show current users items

Returns:

the checkout list response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_CHECKIN_LIST

getCheckedOutItems

public oracle.stellent.ridc.model.DataBinder getCheckedOutItems(oracle.stellent.ridc.IdcContext userContext,
                                                                oracle.stellent.ridc.model.DataBinder requestBinder)
                                                         throws oracle.stellent.ridc.IdcClientException

Discover the items currently checked out in the given adapter for the adapter identity.

Parameters:

userContext - the user context

requestBinder - the request binder

Returns:

the checkout list response

Throws:

oracle.stellent.ridc.IdcClientException

packGetCheckedOutItems

public oracle.stellent.ridc.model.DataBinder packGetCheckedOutItems(boolean userOnly)

Generate request binder for checkout items

Parameters:

userOnly - true to only show current users items

Returns:

databinder

checkoutDocumentByName

public oracle.stellent.ridc.model.DataBinder checkoutDocumentByName(oracle.stellent.ridc.IdcContext userContext,
                                                                    java.lang.String dDocName)
                                                             throws oracle.stellent.ridc.IdcClientException

Checkout a file by name.

Parameters:

userContext - the user context

dDocName - the content ID

Returns:

the response from the Content Server

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_CHECKOUT_BY_NAME

checkoutDocumentByName

public oracle.stellent.ridc.model.DataBinder checkoutDocumentByName(oracle.stellent.ridc.IdcContext userContext,
                                                                    oracle.stellent.ridc.model.DataBinder requestBinder)
                                                             throws oracle.stellent.ridc.IdcClientException

Checkout a file by name.

Parameters:

userContext - the user context

requestBinder - the request binder

Returns:

the response from the Content Server

Throws:

oracle.stellent.ridc.IdcClientException

packCheckoutDocumentByName

public oracle.stellent.ridc.model.DataBinder packCheckoutDocumentByName(java.lang.String dDocName)

Parameters:

dDocName -

Returns:

checkInDocumentByName

public oracle.stellent.ridc.model.DataBinder checkInDocumentByName(oracle.stellent.ridc.IdcContext userContext,
                                                                   java.lang.String dDocName,
                                                                   oracle.stellent.ridc.model.TransferFile transferStream,
                                                                   java.util.Map<java.lang.String,java.lang.String> metadata)
                                                            throws oracle.stellent.ridc.IdcClientException

Checkin a document.

Parameters:

userContext - the user context

dDocName - the content ID

transferStream - the stream to the file

metadata - optional metadata to attach to the document

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

getCheckinInfo(oracle.stellent.ridc.IdcContext, String), WCMMetadata.SERVICE_CHECKIN_UNIVERSAL

createAssetWithDefaultMetadata

public oracle.stellent.ridc.model.DataBinder createAssetWithDefaultMetadata(oracle.stellent.ridc.IdcContext userContext,
                                                                            java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                     throws oracle.stellent.ridc.IdcClientException

Creates a asset with default metadata

Parameters:

userContext - the user context

parameters - the metadata that should be added to document

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

createAssetWithDefaultMetadata

public oracle.stellent.ridc.model.DataBinder createAssetWithDefaultMetadata(oracle.stellent.ridc.IdcContext userContext,
                                                                            oracle.stellent.ridc.model.DataBinder requestBinder)
                                                                     throws oracle.stellent.ridc.IdcClientException

Creates a asset with default metadata

Parameters:

userContext - the user context

requestBinder - the request binder

Returns:

server response

Throws:

oracle.stellent.ridc.IdcClientException

packCreateAssetWithDefaultMetadata

public oracle.stellent.ridc.model.DataBinder packCreateAssetWithDefaultMetadata(java.util.Map<java.lang.String,java.lang.String> parameters)

Generate request binder

Parameters:

userContext -

parameters -

Returns:

undoCheckout

public oracle.stellent.ridc.model.DataBinder undoCheckout(oracle.stellent.ridc.IdcContext userContext,
                                                          java.lang.String dDocName)
                                                   throws oracle.stellent.ridc.IdcClientException

Undo the checkout.

Parameters:

userContext - the user context

dDocName - the content ID

Returns:

the response from the Content Server

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_UNDO_CHECKOUT_BY_NAME

undoCheckout

public oracle.stellent.ridc.model.DataBinder undoCheckout(oracle.stellent.ridc.IdcContext userContext,
                                                          oracle.stellent.ridc.model.DataBinder requestBinder)
                                                   throws oracle.stellent.ridc.IdcClientException

Generate request binder

Parameters:

userContext - user context

requestBinder - request binder

Returns:

Throws:

oracle.stellent.ridc.IdcClientException

packUndoCheckout

public oracle.stellent.ridc.model.DataBinder packUndoCheckout(java.lang.String dDocName)

Generate requets binder

Parameters:

dDocName -

Returns:

Skip navigation links