|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
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
oracle.stellent.wcm.core.idc.impl.SiteStudioApi
public class SiteStudioApi
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 |
---|
public SiteStudioApi(oracle.stellent.ridc.IdcClient idcClient)
Method Detail |
---|
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
userContext
- the user contextsiteID
- the site IDsiteLabel
- the site labeloracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_CREATE_SITE
public oracle.stellent.ridc.model.DataBinder createExternalSite(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packCreateExternalSite(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID, java.lang.String siteLabel)
public java.util.List<SiteBean> getSites(oracle.stellent.ridc.IdcContext userContext) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextrequestBinder
-oracle.stellent.ridc.IdcClientException
public java.util.List<SiteBean> getSites(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetSites()
public oracle.stellent.ridc.model.DataBinder getSiteDocInfo(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextsiteID
- the site IDrequestBinder
-oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder getSiteDocInfo(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetSiteDocInfo(java.lang.String siteID)
siteID
-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
userContext
- the user contextsiteIDs
- the site IDswebsiteObjectType
- the type of object to look forrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_GET_SEARCH_RESULTS
public oracle.stellent.ridc.model.DataBinder searchWebsite(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packSearchWebsite(java.util.Set<java.lang.String> siteIDs, java.lang.String websiteObjectType)
siteIDs
-websiteObjectType
-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
userContext
- the user contextquery
- query to executesiteIdSet
- the site against which the search is performed, can be nullsortField
- sort fieldsortAscending
- sort orderstartRow
- number of results requestedresultCount
- index of the first row returnedoracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_GET_SEARCH_RESULTS
public oracle.stellent.ridc.model.DataBinder search(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder inputBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
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)
public oracle.stellent.ridc.model.DataBinder getSiteDefinition(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) throws oracle.stellent.ridc.IdcClientException
LocalData: siteXml: the project XML as a String ssChangeMonitorToken: token that represents the state of the XML
userContext
- the user contextsiteID
- the site IDrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_GET_SITE_DEFINITION
public oracle.stellent.ridc.model.DataBinder getSiteDefinition(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetSiteDefinition(java.lang.String siteID)
siteID
-public oracle.stellent.ridc.model.DataBinder createSiteNavigationJS(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextsiteID
- the site IDrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_CREATE_SITE_NAV_JS
public oracle.stellent.ridc.model.DataBinder createSiteNavigationJS(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packCreateSiteNavigationJS(java.lang.String siteID)
siteID
-public oracle.stellent.ridc.model.DataBinder commitSiteChanges(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextsiteID
- the site IDrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_COMMIT_SITE_CHANGES
public oracle.stellent.ridc.model.DataBinder commitSiteChanges(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packCommitSiteChanges(java.lang.String siteID)
siteID
-public oracle.stellent.ridc.model.DataBinder getSiteChangeMonitorToken(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID) throws oracle.stellent.ridc.IdcClientException
LocalData: ssChangeMonitorToken: token that represents the state of the XML
userContext
- the user contextsiteID
- the site IDrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_GET_SITE_CHANGE_MONITOR_TOKEN
public oracle.stellent.ridc.model.DataBinder getSiteChangeMonitorToken(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetSiteChangeMonitorToken(java.lang.String siteID)
siteID
-public oracle.stellent.ridc.model.DataBinder getDCRules(oracle.stellent.ridc.IdcContext userContext) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_GET_DC_RULES
public oracle.stellent.ridc.model.DataBinder getDCRules(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetDCRules()
public oracle.stellent.ridc.model.DataResultSet getDefaultDocuments(oracle.stellent.ridc.IdcContext userContext) throws oracle.stellent.ridc.IdcClientException
userContext
- the user contextrequestBinder
-oracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_DOC_CONFIG_INFO
public oracle.stellent.ridc.model.DataResultSet getDefaultDocuments(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packGetDefaultDocuments()
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
userContext
- the user contextsiteId
- the site idcustomDefinitions
- property defintionsoracle.stellent.ridc.IdcClientException
WCMMetadata.SERVICE_SS_SET_ALL_CUSTOM_PROP_DEFS
public oracle.stellent.ridc.model.DataBinder setCustomNodePropertyDefintions(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder) throws oracle.stellent.ridc.IdcClientException
oracle.stellent.ridc.IdcClientException
public oracle.stellent.ridc.model.DataBinder packSetCustomNodePropertyDefintions(java.lang.String siteId, java.util.List<oracle.stellent.wcm.core.project.model.CustomPropType> customDefinitions)
siteId
-customDefinitions
-
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |