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.
java.util.List<CmsAliasImportResult>	getAliasImportResult(java.lang.String resultKey) Gets the alias import results from the server.
CmsAliasInitialFetchResult	getAliasTable() Gets the initial data for the bulk alias editor.
CmsClientSitemapEntry	getChildren(java.lang.String entryPointUri, CmsUUID entryId, int levels) Returns the sitemap children for the given path.
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.
CmsAliasEditValidationReply	saveAliases(CmsAliasSaveValidationRequest saveRequest) Saves the aliases for the bulk alias editor.
CmsSitemapChange	saveSync(java.lang.String sitemapUri, CmsSitemapChange change) Saves the change to the given sitemap.
void	updateAliasEditorStatus(boolean editing) Updates the alias editor status.
CmsAliasEditValidationReply	validateAliases(CmsAliasEditValidationRequest validationRequest) Validates the aliases for the bulk alias editor.
CmsRewriteAliasValidationReply	validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest) Validates rewrite aliases.

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

getAliasImportResult

java.util.List<CmsAliasImportResult> getAliasImportResult(java.lang.String resultKey)
                                                          throws CmsRpcException

Gets the alias import results from the server.

Parameters:

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

Returns:

the list of alias import results

Throws:

CmsRpcException - if something goes wrong

getAliasTable

CmsAliasInitialFetchResult getAliasTable()
                                         throws CmsRpcException

Gets the initial data for the bulk alias editor.

Returns:

the initial data for the alias editor

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 path.

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

saveAliases

CmsAliasEditValidationReply saveAliases(CmsAliasSaveValidationRequest saveRequest)
                                        throws CmsRpcException

Saves the aliases for the bulk alias editor.

Parameters:

saveRequest - the object containing the data to save

Returns:

the result of saving the aliases

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

updateAliasEditorStatus

void updateAliasEditorStatus(boolean editing)
                             throws CmsRpcException

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

Throws:

CmsRpcException - if something goes wrong

validateAliases

CmsAliasEditValidationReply validateAliases(CmsAliasEditValidationRequest validationRequest)
                                            throws CmsRpcException

Validates the aliases for the bulk alias editor.

Parameters:

validationRequest - an object indicating the type of validation to perform

Returns:

the validation result

Throws:

CmsRpcException - if something goes wrong

validateRewriteAliases

CmsRewriteAliasValidationReply validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)
                                                      throws CmsRpcException

Validates rewrite aliases.

Parameters:

validationRequest - the rewrite alias data to validate

Returns:

the validation result

Throws:

CmsRpcException - if something goes wrong