Skip navigation links

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

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

public class SiteStructureApi

extends AbstractIdcApi

API using RIDC for talking with the Site APIs, specifically for creating and moving nodes and node properties

Nested Class Summary

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

AbstractIdcApi.IdcApiCallback

Constructor Summary

SiteStructureApi(oracle.stellent.ridc.IdcClient idcClient)

Method Summary

oracle.stellent.ridc.model.DataBinder	addNode(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	addNode(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String nodeId, java.lang.String newNodeName, java.lang.String urlDirName) Add a new node/section to the structure.
oracle.stellent.ridc.model.DataBinder	deleteNode(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	deleteNode(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String nodeId) Delete a node from the current structure.
oracle.stellent.ridc.model.DataBinder	getSiteProperty(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	getSiteProperty(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String propertyName) Get a site property.
oracle.stellent.ridc.model.DataBinder	moveNode(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	moveNode(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String nodeId, java.lang.String newParentId, java.lang.String insertAfterId) Move a section to a new parent section.
oracle.stellent.ridc.model.DataBinder	packAddNode(java.lang.String siteId, java.lang.String nodeId, java.lang.String newNodeName, java.lang.String urlDirName)
oracle.stellent.ridc.model.DataBinder	packDeleteNode(java.lang.String siteId, java.lang.String nodeId)
oracle.stellent.ridc.model.DataBinder	packGetSiteProperty(java.lang.String siteId, java.lang.String propertyName)
oracle.stellent.ridc.model.DataBinder	packMoveNode(java.lang.String siteId, java.lang.String nodeId, java.lang.String newParentId, java.lang.String insertAfterId)
oracle.stellent.ridc.model.DataBinder	packSetNodeProperty(java.lang.String siteID, java.lang.String nodeID, java.lang.String property, java.lang.String value)
oracle.stellent.ridc.model.DataBinder	packSetSiteProperty(java.lang.String siteId, java.lang.String propertyName, java.lang.String propertyValue)
oracle.stellent.ridc.model.DataBinder	setNodeProperty(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	setNodeProperty(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteID, java.lang.String nodeID, java.lang.String property, java.lang.String value) Set a property on the given node in a SiteStudio/OpenWCM project.
oracle.stellent.ridc.model.DataBinder	setSiteProperty(oracle.stellent.ridc.IdcContext userContext, oracle.stellent.ridc.model.DataBinder requestBinder)
oracle.stellent.ridc.model.DataBinder	setSiteProperty(oracle.stellent.ridc.IdcContext userContext, java.lang.String siteId, java.lang.String propertyName, java.lang.String propertyValue) Set a site property.

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

SiteStructureApi

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

Method Detail

setNodeProperty

public oracle.stellent.ridc.model.DataBinder setNodeProperty(oracle.stellent.ridc.IdcContext userContext,
                                                             java.lang.String siteID,
                                                             java.lang.String nodeID,
                                                             java.lang.String property,
                                                             java.lang.String value)
                                                      throws oracle.stellent.ridc.IdcClientException

Set a property on the given node in a SiteStudio/OpenWCM project.

Parameters:

userContext - the user context

siteID - the site ID

nodeID - the node ID

property - the property name

value - the property value

requestBinder -

Returns:

The server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_SET_NODE_PROPERTY

setNodeProperty

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

Throws:

oracle.stellent.ridc.IdcClientException

packSetNodeProperty

public oracle.stellent.ridc.model.DataBinder packSetNodeProperty(java.lang.String siteID,
                                                                 java.lang.String nodeID,
                                                                 java.lang.String property,
                                                                 java.lang.String value)

Parameters:

siteID -

nodeID -

property -

value -

Returns:

addNode

public oracle.stellent.ridc.model.DataBinder addNode(oracle.stellent.ridc.IdcContext userContext,
                                                     java.lang.String siteId,
                                                     java.lang.String nodeId,
                                                     java.lang.String newNodeName,
                                                     java.lang.String urlDirName)
                                              throws oracle.stellent.ridc.IdcClientException

Add a new node/section to the structure.

Parameters:

userContext - the user context

siteId - the id of the site

nodeId - the id of the node to which new node is added

newNodeName - the name of the new node

urlDirName - the node url directory

requestBinder -

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_ADD_NODE

addNode

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

Throws:

oracle.stellent.ridc.IdcClientException

packAddNode

public oracle.stellent.ridc.model.DataBinder packAddNode(java.lang.String siteId,
                                                         java.lang.String nodeId,
                                                         java.lang.String newNodeName,
                                                         java.lang.String urlDirName)

Parameters:

siteId -

nodeId -

newNodeName -

urlDirName -

Returns:

deleteNode

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

Delete a node from the current structure.

Parameters:

userContext - the user context

siteId - the id of the site

nodeId - the id of the node to be deleted

requestBinder -

Returns:

the server response

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_DELETE_NODE

deleteNode

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

Throws:

oracle.stellent.ridc.IdcClientException

packDeleteNode

public oracle.stellent.ridc.model.DataBinder packDeleteNode(java.lang.String siteId,
                                                            java.lang.String nodeId)

Parameters:

siteId -

nodeId -

Returns:

getSiteProperty

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

Get a site property. The response object is returned, the caller should retrieve the value using ISCSServerResponse.getProperty("value") method. If the service call is unsuccessful, the error can also be retrieved from the response object.

Parameters:

userContext - the user context

siteId - the id of the site

propertyName - the name of the property that is to be returned

requestBinder -

Returns:

the response object

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_GET_SITE_PROPERTY

getSiteProperty

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

Throws:

oracle.stellent.ridc.IdcClientException

packGetSiteProperty

public oracle.stellent.ridc.model.DataBinder packGetSiteProperty(java.lang.String siteId,
                                                                 java.lang.String propertyName)

Parameters:

siteId -

propertyName -

Returns:

setSiteProperty

public oracle.stellent.ridc.model.DataBinder setSiteProperty(oracle.stellent.ridc.IdcContext userContext,
                                                             java.lang.String siteId,
                                                             java.lang.String propertyName,
                                                             java.lang.String propertyValue)
                                                      throws oracle.stellent.ridc.IdcClientException

Set a site property. If the property values is null, then the property is removed.

Parameters:

userContext - the user context

siteId - the id of the site

propertyName - the name of the property

propertyValue - the value of the property

requestBinder -

Returns:

the response object

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_SET_SITE_PROPERTY

setSiteProperty

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

Throws:

oracle.stellent.ridc.IdcClientException

packSetSiteProperty

public oracle.stellent.ridc.model.DataBinder packSetSiteProperty(java.lang.String siteId,
                                                                 java.lang.String propertyName,
                                                                 java.lang.String propertyValue)

Parameters:

siteId -

propertyName -

propertyValue -

Returns:

moveNode

public oracle.stellent.ridc.model.DataBinder moveNode(oracle.stellent.ridc.IdcContext userContext,
                                                      java.lang.String siteId,
                                                      java.lang.String nodeId,
                                                      java.lang.String newParentId,
                                                      java.lang.String insertAfterId)
                                               throws oracle.stellent.ridc.IdcClientException

Move a section to a new parent section.

Parameters:

userContext - the user context

siteId - the id of the site

nodeId - the id of the node to be moved

newParentId - the id of the new parent

insertAfterId - the id of a sibling after which this node is to be inserted (optional)

requestBinder -

Returns:

the response object

Throws:

oracle.stellent.ridc.IdcClientException

See Also:

WCMMetadata.SERVICE_SS_MOVE_NODE

moveNode

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

Throws:

oracle.stellent.ridc.IdcClientException

packMoveNode

public oracle.stellent.ridc.model.DataBinder packMoveNode(java.lang.String siteId,
                                                          java.lang.String nodeId,
                                                          java.lang.String newParentId,
                                                          java.lang.String insertAfterId)

Parameters:

siteId -

nodeId -

newParentId -

insertAfterId -

Returns:

Skip navigation links