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	getAliasImportResult(java.lang.String resultKey, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsAliasImportResult>> asyncCallback) Gets the alias import results from the server.
void	getAliasTable(com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasInitialFetchResult> callback) Gets the initial data for the bulk alias editor.
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 path.
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	saveAliases(CmsAliasSaveValidationRequest saveRequest, com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasEditValidationReply> callback) Saves the aliases for the bulk alias editor.
void	saveSync(java.lang.String sitemapUri, CmsSitemapChange change, com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapChange> callback) Save the change to the given sitemap.
void	updateAliasEditorStatus(boolean editing, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Updates the alias editor status.
void	validateAliases(CmsAliasEditValidationRequest validationRequest, com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasEditValidationReply> callback) Validates the aliases for the bulk alias editor.
void	validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest, com.google.gwt.user.client.rpc.AsyncCallback<CmsRewriteAliasValidationReply> callback) Validates rewrite aliases.

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

getAliasImportResult

void getAliasImportResult(java.lang.String resultKey,
                          com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsAliasImportResult>> asyncCallback)

Gets the alias import results from the server.

Parameters:

resultKey - the key which identifies the alias import results to get

asyncCallback - the asynchronous callback

getAliasTable

void getAliasTable(com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasInitialFetchResult> callback)

Gets the initial data for the bulk alias editor.

Parameters:

callback - the asynchronous 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 path.

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

saveAliases

void saveAliases(CmsAliasSaveValidationRequest saveRequest,
                 com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasEditValidationReply> callback)

Saves the aliases for the bulk alias editor.

Parameters:

saveRequest - the object containing the data to save

callback - the asynchronous 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

updateAliasEditorStatus

void updateAliasEditorStatus(boolean editing,
                             com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Updates the alias editor status.

This is used to keep two users from editing the alias table for a site root concurrently.

Parameters:

editing - true to indicate that the table is still being edited, false to indicate that the table isn't being edited anymore

callback - the asynchronous callback

validateAliases

void validateAliases(CmsAliasEditValidationRequest validationRequest,
                     com.google.gwt.user.client.rpc.AsyncCallback<CmsAliasEditValidationReply> callback)

Validates the aliases for the bulk alias editor.

Parameters:

validationRequest - an object indicating the type of validation to perform

callback - the asynchronous callback

validateRewriteAliases

void validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest,
                            com.google.gwt.user.client.rpc.AsyncCallback<CmsRewriteAliasValidationReply> callback)

Validates rewrite aliases.

Parameters:

validationRequest - the rewrite alias data to validate

callback - the callback for the result