org.opencms.ade.sitemap.shared.rpc
Interface I_CmsSitemapService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsVfsSitemapService

public interface I_CmsSitemapService
extends com.google.gwt.user.client.rpc.RemoteService

Handles all RPC services related to the sitemap.

Since:

8.0.0

See Also:

CmsVfsSitemapService, I_CmsSitemapService, I_CmsSitemapServiceAsync

Method Summary

CmsSitemapChange	createSubSitemap(CmsUUID entryId) Creates a sub-sitemap of the given sitemap starting from the given entry.
CmsClientSitemapEntry	getChildren(java.lang.String entryPointUri, CmsUUID entryId, int levels) Returns the sitemap children for the given entry.
CmsSitemapChange	mergeSubSitemap(java.lang.String entryPoint, CmsUUID subSitemapId) Merges a sub-sitemap into it's parent sitemap.
CmsSitemapData	prefetch(java.lang.String sitemapUri) Returns the initialization data for the given sitemap.
CmsSitemapChange	save(java.lang.String sitemapUri, CmsSitemapChange change) Saves the change to the given sitemap.
CmsSitemapChange	saveSync(java.lang.String sitemapUri, CmsSitemapChange change) Saves the change to the given sitemap.

Method Detail

createSubSitemap

CmsSitemapChange createSubSitemap(CmsUUID entryId)
                                  throws CmsRpcException

Creates a sub-sitemap of the given sitemap starting from the given entry.

Parameters:

entryId - the structure id of the sitemap entry to create a sub sitemap of

Returns:

the sub-sitemap creation result

Throws:

CmsRpcException - if something goes wrong

getChildren

CmsClientSitemapEntry getChildren(java.lang.String entryPointUri,
                                  CmsUUID entryId,
                                  int levels)
                                  throws CmsRpcException

Returns the sitemap children for the given entry.

Parameters:

entryPointUri - the URI of the sitemap entry point

entryId - the entry id

levels - the count of child levels to read

Returns:

the sitemap children

Throws:

CmsRpcException - if something goes wrong

mergeSubSitemap

CmsSitemapChange mergeSubSitemap(java.lang.String entryPoint,
                                 CmsUUID subSitemapId)
                                 throws CmsRpcException

Merges a sub-sitemap into it's parent sitemap.

Parameters:

entryPoint - the sitemap entry point

subSitemapId - the structure id of the sub sitemap folder

Returns:

the result of the merge operation

Throws:

CmsRpcException - if something goes wrong

prefetch

CmsSitemapData prefetch(java.lang.String sitemapUri)
                        throws CmsRpcException

Returns the initialization data for the given sitemap.

Parameters:

sitemapUri - the site relative path

Returns:

the initialization data

Throws:

CmsRpcException - if something goes wrong

save

CmsSitemapChange save(java.lang.String sitemapUri,
                      CmsSitemapChange change)
                      throws CmsRpcException

Saves the change to the given sitemap.

Parameters:

sitemapUri - the sitemap URI

change - the change to save

Returns:

the updated change

Throws:

CmsRpcException - if something goes wrong

saveSync

@SynchronizedRpcRequest
CmsSitemapChange saveSync(java.lang.String sitemapUri,
                                                 CmsSitemapChange change)
                          throws CmsRpcException

Saves the change to the given sitemap.

Parameters:

sitemapUri - the sitemap URI

change - the change to save

Returns:

the updated change

Throws:

CmsRpcException - if something goes wrong