Skip navigation links

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

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

public class ContentInfoApi

extends AbstractIdcApi

For retrieving content information

Nested Class Summary

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

AbstractIdcApi.IdcApiCallback

Constructor Summary

ContentInfoApi(oracle.stellent.ridc.IdcClient idcClient)

Method Summary

oracle.stellent.ridc.model.DataBinder	getDocConfigInfo(oracle.stellent.ridc.IdcContext userContext) Retrieve the document configuration information.
protected oracle.stellent.ridc.model.DataBinder	getDocConfigInfo(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getDocInfoByName(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getDocInfoByName(oracle.stellent.ridc.IdcContext userContext, java.lang.String dDocName) Retrieve the document information by name.
oracle.stellent.ridc.model.DataBinder	getGetDocProfiles(oracle.stellent.ridc.IdcContext userContext) Retrieve the Profile Information.
oracle.stellent.ridc.model.DataBinder	getGetDocProfiles(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSSGetConfigInfo(oracle.stellent.ridc.IdcContext userContext) Retrieve the SiteStudio version of the document configuration information.
oracle.stellent.ridc.model.DataBinder	getSSGetConfigInfo(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSSXADocInfoByName(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSSXADocInfoByName(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String dDocName) Retrieve the document information by name.
oracle.stellent.ridc.model.DataBinder	getSSXADocInfoByNameAndRev(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSSXADocInfoByNameAndRev(oracle.stellent.ridc.IdcContext idcContext, java.lang.String dDocName, java.lang.String revisionSelectionMethod) Retrieve the document information by name.
oracle.stellent.ridc.model.DataBinder	packDocInfoByName(java.lang.String dDocName)
protected oracle.stellent.ridc.model.DataBinder	packGetDocConfigInfo(oracle.stellent.ridc.IdcContext userContext)
oracle.stellent.ridc.model.DataBinder	packGetGetDocProfiles()
oracle.stellent.ridc.model.DataBinder	packGetSSGetConfigInfo()
oracle.stellent.ridc.model.DataBinder	packGetSSXADocInfoByName(java.lang.String siteId, java.lang.String dDocName)
oracle.stellent.ridc.model.DataBinder	packGetSSXADocInfoByNameAndRev(java.lang.String dDocName, java.lang.String revisionSelectionMethod)
oracle.stellent.ridc.model.DataBinder	packUpdateMetadata(java.util.Map<java.lang.String,java.lang.String> docInfo, java.util.Map<java.lang.String,java.lang.String> metadata)
oracle.stellent.ridc.model.DataBinder	updateMetadata(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	updateMetadata(oracle.stellent.ridc.IdcContext userContext, java.util.Map<java.lang.String,java.lang.String> docInfo, java.util.Map<java.lang.String,java.lang.String> metadata) Update the metadata for a content item.

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

ContentInfoApi

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

Method Detail

getDocInfoByName

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

Retrieve the document information by name.

Parameters:

userContext - the user context

dDocName - the document ID

requestBinder -

Returns:

the content server information response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_DOC_INFO_BY_NAME

getDocInfoByName

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

Throws:

oracle.stellent.ridc.IdcClientException

packDocInfoByName

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

Parameters:

dDocName -

Returns:

getSSXADocInfoByName

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

Retrieve the document information by name.

Parameters:

userContext - the user context

dDocName - the document ID

requestBinder -

Returns:

the content server information response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SSXA_DOC_INFO_BY_NAME

getSSXADocInfoByName

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSSXADocInfoByName

public oracle.stellent.ridc.model.DataBinder packGetSSXADocInfoByName(java.lang.String siteId,
                                                                      java.lang.String dDocName)

Parameters:

siteId -

dDocName -

Returns:

getSSXADocInfoByNameAndRev

public oracle.stellent.ridc.model.DataBinder getSSXADocInfoByNameAndRev(oracle.stellent.ridc.IdcContext idcContext,
                                                                        java.lang.String dDocName,
                                                                        java.lang.String revisionSelectionMethod)
                                                                 throws oracle.stellent.ridc.IdcClientException

Retrieve the document information by name.

Parameters:

userContext - the user context

dDocName - the document ID

revisionSelectionMethod - the RevisionSelectionMethod to send to the service (Latest or LatestReleased)

requestBinder -

Returns:

the content server information response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SSXA_DOC_INFO_BY_NAME

getSSXADocInfoByNameAndRev

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSSXADocInfoByNameAndRev

public oracle.stellent.ridc.model.DataBinder packGetSSXADocInfoByNameAndRev(java.lang.String dDocName,
                                                                            java.lang.String revisionSelectionMethod)

Parameters:

dDocName -

revisionSelectionMethod -

Returns:

getDocConfigInfo

public oracle.stellent.ridc.model.DataBinder getDocConfigInfo(oracle.stellent.ridc.IdcContext userContext)
                                                       throws oracle.stellent.ridc.IdcClientException

Retrieve the document configuration information.

Parameters:

userContext - the user context

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_DOC_CONFIG_INFO

getDocConfigInfo

protected oracle.stellent.ridc.model.DataBinder getDocConfigInfo(oracle.stellent.ridc.IdcContext userContext,
                                                                 oracle.stellent.ridc.model.DataBinder requestBinder)
                                                          throws oracle.stellent.ridc.IdcClientException

Throws:

oracle.stellent.ridc.IdcClientException

packGetDocConfigInfo

protected oracle.stellent.ridc.model.DataBinder packGetDocConfigInfo(oracle.stellent.ridc.IdcContext userContext)

getSSGetConfigInfo

public oracle.stellent.ridc.model.DataBinder getSSGetConfigInfo(oracle.stellent.ridc.IdcContext userContext)
                                                         throws oracle.stellent.ridc.IdcClientException

Retrieve the SiteStudio version of the document configuration information.

Parameters:

userContext - the user context

requestBinder -

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_DOC_CONFIG_INFO

getSSGetConfigInfo

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSSGetConfigInfo

public oracle.stellent.ridc.model.DataBinder packGetSSGetConfigInfo()

Returns:

getGetDocProfiles

public oracle.stellent.ridc.model.DataBinder getGetDocProfiles(oracle.stellent.ridc.IdcContext userContext)
                                                        throws oracle.stellent.ridc.IdcClientException

Retrieve the Profile Information. Includes the dpTriggerField in local data, and the ResultSet DocumentProfiles. \@ResultSet DocumentProfiles 5 dpName dpDescription dpTriggerValue dpDisplayLabel isValid

Parameters:

userContext - the user context

requestBinder -

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_GET_DOCPROFILES

getGetDocProfiles

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetGetDocProfiles

public oracle.stellent.ridc.model.DataBinder packGetGetDocProfiles()

Returns:

updateMetadata

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

Update the metadata for a content item.

Parameters:

userContext - the user context

docInfo - the current document information

metadata - the new information to update

requestBinder -

Returns:

the response from the server

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_UPDATE_DOC_INFO

updateMetadata

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

Throws:

oracle.stellent.ridc.IdcClientException

packUpdateMetadata

public oracle.stellent.ridc.model.DataBinder packUpdateMetadata(java.util.Map<java.lang.String,java.lang.String> docInfo,
                                                                java.util.Map<java.lang.String,java.lang.String> metadata)

Parameters:

docInfo -

metadata -

Returns:

Skip navigation links