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

public interface I_CmsSitemapServiceAsync

Handles all RPC services related to the sitemap.

Since:

8.0.0

See Also:

CmsVfsSitemapService, I_CmsSitemapService, I_CmsSitemapServiceAsync

Method Summary

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

Method Detail

createSubSitemap

void createSubSitemap(CmsUUID entryId,
                      com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapChange> callback)

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

callback - the async callback

getChildren

void getChildren(java.lang.String entryPointUri,
                 CmsUUID entryId,
                 int levels,
                 com.google.gwt.user.client.rpc.AsyncCallback<CmsClientSitemapEntry> callback)

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

callback - the async callback

mergeSubSitemap

void mergeSubSitemap(java.lang.String entryPoint,
                     CmsUUID subSitemapId,
                     com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapChange> callback)

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

Parameters:

entryPoint - the sitemap entry point

subSitemapId - the structure id of the sub sitemap folder

callback - the async callback

prefetch

void prefetch(java.lang.String sitemapUri,
              com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapData> callback)

Returns the initialization data for the given sitemap.

Parameters:

sitemapUri - the site relative path

callback - the async callback

save

void save(java.lang.String sitemapUri,
          CmsSitemapChange change,
          com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapChange> callback)

Saves the change to the given sitemap.

Parameters:

sitemapUri - the sitemap URI

change - the change to save

callback - the async callback

saveSync

@SynchronizedRpcRequest
void saveSync(java.lang.String sitemapUri,
                                     CmsSitemapChange change,
                                     com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapChange> callback)

Save the change to the given sitemap.

Parameters:

sitemapUri - the sitemap URI

change - the change to save

callback - the async callback