Skip navigation links

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

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

public class SiteStudioApi

extends AbstractIdcApi

API for handling SiteStudio specific calls

Nested Class Summary

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

AbstractIdcApi.IdcApiCallback

Constructor Summary

SiteStudioApi(oracle.stellent.ridc.IdcClient idcClient)

Method Summary

oracle.stellent.ridc.model.DataBinder	commitSiteChanges(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	commitSiteChanges(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) Commit the project file for the site
oracle.stellent.ridc.model.DataBinder	createExternalSite(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	createExternalSite(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID, java.lang.String siteLabel) Create a new external SiteStudio site.
oracle.stellent.ridc.model.DataBinder	createSiteNavigationJS(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	createSiteNavigationJS(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) Create navigation JS for a site.
oracle.stellent.ridc.model.DataBinder	getDCRules(oracle.stellent.ridc.IdcContext userContext) Gets the dynamic conversion rules
oracle.stellent.ridc.model.DataBinder	getDCRules(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataResultSet	getDefaultDocuments(oracle.stellent.ridc.IdcContext userContext) Get the default documents
oracle.stellent.ridc.model.DataResultSet	getDefaultDocuments(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSiteChangeMonitorToken(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSiteChangeMonitorToken(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) Retrieve the SiteStudio site change monitor token.
oracle.stellent.ridc.model.DataBinder	getSiteDefinition(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSiteDefinition(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) Retrieve the SiteStudio site definition.
oracle.stellent.ridc.model.DataBinder	getSiteDocInfo(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSiteDocInfo(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) Retrieve the document information for a given site project by site ID
java.util.List<SiteBean>	getSites(oracle.stellent.ridc.IdcContext userContext) Retrieve the available sites.
java.util.List<SiteBean>	getSites(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	packCommitSiteChanges(java.lang.String siteID)
oracle.stellent.ridc.model.DataBinder	packCreateExternalSite(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID, java.lang.String siteLabel)
oracle.stellent.ridc.model.DataBinder	packCreateSiteNavigationJS(java.lang.String siteID)
oracle.stellent.ridc.model.DataBinder	packGetDCRules()
oracle.stellent.ridc.model.DataBinder	packGetDefaultDocuments()
oracle.stellent.ridc.model.DataBinder	packGetSiteChangeMonitorToken(java.lang.String siteID)
oracle.stellent.ridc.model.DataBinder	packGetSiteDefinition(java.lang.String siteID)
oracle.stellent.ridc.model.DataBinder	packGetSiteDocInfo(java.lang.String siteID)
oracle.stellent.ridc.model.DataBinder	packGetSites()
oracle.stellent.ridc.model.DataBinder	packSearch(java.lang.String query, int startRow, int resultCount, java.lang.String sortField, boolean sortAscending, java.util.Set<java.lang.String> siteIdSet)
oracle.stellent.ridc.model.DataBinder	packSearchWebsite(java.util.Set<java.lang.String> siteIDs, java.lang.String websiteObjectType)
oracle.stellent.ridc.model.DataBinder	packSetCustomNodePropertyDefintions(java.lang.String siteId, java.util.List<oracle.stellent.wcm.core.project.model.CustomPropType> customDefinitions)
oracle.stellent.ridc.model.DataBinder	search(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder inputBinder)
oracle.stellent.ridc.model.DataBinder	search(oracle.stellent.ridc.IdcContext userContext, java.lang.String query, int startRow, int resultCount, java.lang.String sortField, boolean sortAscending, java.util.Set<java.lang.String> siteIdSet) Search the Content Server.
oracle.stellent.ridc.model.DataBinder	searchWebsite(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	searchWebsite(oracle.stellent.ridc.IdcContext userContext, java.util.Set<java.lang.String> siteIDs, java.lang.String websiteObjectType) Search the website for objects matching the given type.
oracle.stellent.ridc.model.DataBinder	setCustomNodePropertyDefintions(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	setCustomNodePropertyDefintions(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.util.List<oracle.stellent.wcm.core.project.model.CustomPropType> customDefinitions) Sets the custom section property definitions

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

SiteStudioApi

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

Method Detail

createExternalSite

public oracle.stellent.ridc.model.DataBinder createExternalSite(oracle.stellent.ridc.IdcContext userContext,
                                                                java.lang.String siteID,
                                                                java.lang.String siteLabel)
                                                         throws oracle.stellent.ridc.IdcClientException

Create a new external SiteStudio site.

Parameters:

userContext - the user context

siteID - the site ID

siteLabel - the site label

Returns:

the content server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_CREATE_SITE

createExternalSite

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

Throws:

oracle.stellent.ridc.IdcClientException

packCreateExternalSite

public oracle.stellent.ridc.model.DataBinder packCreateExternalSite(oracle.stellent.ridc.IdcContext userContext,
                                                                    java.lang.String siteID,
                                                                    java.lang.String siteLabel)

getSites

public java.util.List<SiteBean> getSites(oracle.stellent.ridc.IdcContext userContext)
                                  throws oracle.stellent.ridc.IdcClientException

Retrieve the available sites.

Parameters:

userContext - the user context

requestBinder -

Returns:

response containing sites in result set named "SiteIds" oracle.stellent.wcm.core.WCMMetadata#SERVICE_SS_GET_ALL_SITES

Throws:

oracle.stellent.ridc.IdcClientException

getSites

public java.util.List<SiteBean> getSites(oracle.stellent.ridc.IdcContext userContext,
                                         oracle.stellent.ridc.model.DataBinder requestBinder)
                                  throws oracle.stellent.ridc.IdcClientException

Throws:

oracle.stellent.ridc.IdcClientException

packGetSites

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

Returns:

getSiteDocInfo

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

Retrieve the document information for a given site project by site ID

Parameters:

userContext - the user context

siteID - the site ID

requestBinder -

Returns:

a data binder containing the document information for the site project file

Throws:

oracle.stellent.ridc.IdcClientException

getSiteDocInfo

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSiteDocInfo

public oracle.stellent.ridc.model.DataBinder packGetSiteDocInfo(java.lang.String siteID)

Parameters:

siteID -

Returns:

searchWebsite

public oracle.stellent.ridc.model.DataBinder searchWebsite(oracle.stellent.ridc.IdcContext userContext,
                                                           java.util.Set<java.lang.String> siteIDs,
                                                           java.lang.String websiteObjectType)
                                                    throws oracle.stellent.ridc.IdcClientException

Search the website for objects matching the given type.

Parameters:

userContext - the user context

siteIDs - the site IDs

websiteObjectType - the type of object to look for

requestBinder -

Returns:

the search results

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_GET_SEARCH_RESULTS

searchWebsite

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

Throws:

oracle.stellent.ridc.IdcClientException

packSearchWebsite

public oracle.stellent.ridc.model.DataBinder packSearchWebsite(java.util.Set<java.lang.String> siteIDs,
                                                               java.lang.String websiteObjectType)

Parameters:

siteIDs -

websiteObjectType -

Returns:

search

public oracle.stellent.ridc.model.DataBinder search(oracle.stellent.ridc.IdcContext userContext,
                                                    java.lang.String query,
                                                    int startRow,
                                                    int resultCount,
                                                    java.lang.String sortField,
                                                    boolean sortAscending,
                                                    java.util.Set<java.lang.String> siteIdSet)
                                             throws oracle.stellent.ridc.IdcClientException

Search the Content Server.

Parameters:

userContext - the user context

query - query to execute

siteIdSet - the site against which the search is performed, can be null

sortField - sort field

sortAscending - sort order

startRow - number of results requested

resultCount - index of the first row returned

Returns:

the response from the server

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_GET_SEARCH_RESULTS

search

public oracle.stellent.ridc.model.DataBinder search(oracle.stellent.ridc.IdcContext userContext,
                                                    oracle.stellent.ridc.model.DataBinder inputBinder)
                                             throws oracle.stellent.ridc.IdcClientException

Throws:

oracle.stellent.ridc.IdcClientException

packSearch

public oracle.stellent.ridc.model.DataBinder packSearch(java.lang.String query,
                                                        int startRow,
                                                        int resultCount,
                                                        java.lang.String sortField,
                                                        boolean sortAscending,
                                                        java.util.Set<java.lang.String> siteIdSet)

getSiteDefinition

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

Retrieve the SiteStudio site definition. Includes:

   LocalData:
      siteXml:  the project XML as a String
      ssChangeMonitorToken:  token that represents the state of the XML
 

Parameters:

userContext - the user context

siteID - the site ID

requestBinder -

Returns:

the Content Server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_GET_SITE_DEFINITION

getSiteDefinition

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSiteDefinition

public oracle.stellent.ridc.model.DataBinder packGetSiteDefinition(java.lang.String siteID)

Parameters:

siteID -

Returns:

createSiteNavigationJS

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

Create navigation JS for a site.

Parameters:

userContext - the user context

siteID - the site ID

requestBinder -

Returns:

the Content Server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_CREATE_SITE_NAV_JS

createSiteNavigationJS

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

Throws:

oracle.stellent.ridc.IdcClientException

packCreateSiteNavigationJS

public oracle.stellent.ridc.model.DataBinder packCreateSiteNavigationJS(java.lang.String siteID)

Parameters:

siteID -

Returns:

commitSiteChanges

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

Commit the project file for the site

Parameters:

userContext - the user context

siteID - the site ID

requestBinder -

Returns:

the Content Server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_COMMIT_SITE_CHANGES

commitSiteChanges

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

Throws:

oracle.stellent.ridc.IdcClientException

packCommitSiteChanges

public oracle.stellent.ridc.model.DataBinder packCommitSiteChanges(java.lang.String siteID)

Parameters:

siteID -

Returns:

getSiteChangeMonitorToken

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

Retrieve the SiteStudio site change monitor token. Includes:

   LocalData:
      ssChangeMonitorToken:  token that represents the state of the XML
 

Parameters:

userContext - the user context

siteID - the site ID

requestBinder -

Returns:

the Content Server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_GET_SITE_CHANGE_MONITOR_TOKEN

getSiteChangeMonitorToken

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSiteChangeMonitorToken

public oracle.stellent.ridc.model.DataBinder packGetSiteChangeMonitorToken(java.lang.String siteID)

Parameters:

siteID -

Returns:

getDCRules

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

Gets the dynamic conversion rules

Parameters:

userContext - the user context

requestBinder -

Returns:

content server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_GET_DC_RULES

getDCRules

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetDCRules

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

Returns:

getDefaultDocuments

public oracle.stellent.ridc.model.DataResultSet getDefaultDocuments(oracle.stellent.ridc.IdcContext userContext)
                                                             throws oracle.stellent.ridc.IdcClientException

Get the default documents

Parameters:

userContext - the user context

requestBinder -

Returns:

the documents result set

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_DOC_CONFIG_INFO

getDefaultDocuments

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetDefaultDocuments

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

Returns:

setCustomNodePropertyDefintions

public oracle.stellent.ridc.model.DataBinder setCustomNodePropertyDefintions(oracle.stellent.ridc.IdcContext userContext,
                                                                             java.lang.String siteId,
                                                                             java.util.List<oracle.stellent.wcm.core.project.model.CustomPropType> customDefinitions)
                                                                      throws oracle.stellent.ridc.IdcClientException

Sets the custom section property definitions

Parameters:

userContext - the user context

siteId - the site id

customDefinitions - property defintions

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_SET_ALL_CUSTOM_PROP_DEFS

setCustomNodePropertyDefintions

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

Throws:

oracle.stellent.ridc.IdcClientException

packSetCustomNodePropertyDefintions

public oracle.stellent.ridc.model.DataBinder packSetCustomNodePropertyDefintions(java.lang.String siteId,
                                                                                 java.util.List<oracle.stellent.wcm.core.project.model.CustomPropType> customDefinitions)

Parameters:

siteId -

customDefinitions -

Returns:

Skip navigation links