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
Constructor Summary |
SiteStudioApi(oracle.stellent.ridc.IdcClient idcClient)
|
Method Summary |
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)
Retrieve the SiteStudio site definition. |
oracle.stellent.ridc.model.DataBinder |
getSiteDefinition(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID, boolean isRuntimeMode)
Retrieve the SiteStudio site definition. |
oracle.stellent.ridc.model.DataBinder |
packGetSiteChangeMonitorToken(java.lang.String siteID)
|
oracle.stellent.ridc.model.DataBinder |
packGetSiteDefinition(java.lang.String siteID, boolean isRuntimeMode)
|
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 |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SiteStudioApi
public SiteStudioApi(oracle.stellent.ridc.IdcClient idcClient)
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)
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:
getSiteDefinition
public oracle.stellent.ridc.model.DataBinder getSiteDefinition(oracle.stellent.ridc.IdcContext userContext,
java.lang.String siteID,
boolean isRuntimeMode)
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
isRuntimeMode
- true if it is runtime, false if design time
- 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
- 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
requestBinder
- the request binder
- Returns:
- the Content Server response
- Throws:
oracle.stellent.ridc.IdcClientException
- See Also:
WCMMetadata.SERVICE_SS_GET_SITE_DEFINITION
packGetSiteDefinition
public oracle.stellent.ridc.model.DataBinder packGetSiteDefinition(java.lang.String siteID,
boolean isRuntimeMode)
-
- Parameters:
siteID
-
- Returns:
Skip navigation links
Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.