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

Modifier and Type	Method and Description
void	changeCategory(java.lang.String entryPoint, CmsUUID id, java.lang.String title, java.lang.String name, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Sets the name and title of the given category.
void	createCategory(java.lang.String entryPoint, CmsUUID id, java.lang.String title, java.lang.String name, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Creates a new category.
void	createNewGalleryFolder(java.lang.String parentFolder, java.lang.String title, int folderTypeId, com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryFolderEntry> callback) Creates a new gallery folder.
void	createNewModelPage(java.lang.String entryPointUri, java.lang.String title, java.lang.String description, CmsUUID copyId, boolean isModelGroup, com.google.gwt.user.client.rpc.AsyncCallback<CmsModelPageEntry> resultCallback) Creates a new model page.
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	disableModelPage(java.lang.String baseUri, CmsUUID modelPageId, boolean disabled, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Sets the disabled flag of a model page within the current sitemap configuration.
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	getCategoryData(java.lang.String entryPoint, com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapCategoryData> resultCallback) Gets the category data for the given entry point.
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	getGalleryData(java.lang.String entryPointUri, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<CmsGalleryType,java.util.List<CmsGalleryFolderEntry>>> callback) Returns the gallery data to this sub site.
void	getModelInfos(CmsUUID id, com.google.gwt.user.client.rpc.AsyncCallback<CmsModelInfo> callback) Gets the model pages for the given structure id of the sitemap root folder.
void	getNewElementInfo(java.lang.String entryPointUri, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsNewResourceInfo>> resultCallback) Loads the model page data for the "add" menu.
void	getResourceLink(CmsUUID baseId, java.lang.String sitePath, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback) Fetches the link for a resource selected in the sitemap editor.
void	loadPropertyDataForLocaleCompareView(CmsUUID id, CmsUUID rootId, com.google.gwt.user.client.rpc.AsyncCallback<CmsLocaleComparePropertyData> resultCallback) Loads the data needed by the property editor in the locale comparison view.
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	prepareReloadSitemap(CmsUUID rootId, CmsSitemapData.EditorMode mode, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> resultUrl) Prepares sitemap reloading for the given sitemap root.
void	removeModelPage(java.lang.String baseUri, CmsUUID modelPageId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Removes a model page from the current sitemap configuration.
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	savePropertiesForLocaleCompareMode(CmsUUID id, java.lang.String newUrlName, java.util.List<CmsPropertyModification> propertyChanges, boolean editedName, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves the changed properties in locale comparison mode.
void	setDefaultModel(CmsUUID rootId, CmsUUID modelId, com.google.gwt.user.client.rpc.AsyncCallback<CmsModelInfo> callback) Sets the default model page for the given sub-sitemap, returns the updated model info.
void	setEditorMode(CmsSitemapData.EditorMode editorMode, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Sets the editor mode in the current user session.
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

changeCategory

void changeCategory(java.lang.String entryPoint,
                    CmsUUID id,
                    java.lang.String title,
                    java.lang.String name,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Sets the name and title of the given category.

Parameters:

entryPoint - the current entry point

id - the category id

title - the new title

name - the new name

callback - the callback to call when done

createCategory

void createCategory(java.lang.String entryPoint,
                    CmsUUID id,
                    java.lang.String title,
                    java.lang.String name,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Creates a new category.

Parameters:

entryPoint - the entry point

id - the parent category id

title - the title

name - the category name

callback - the result callback

createNewGalleryFolder

void createNewGalleryFolder(java.lang.String parentFolder,
                            java.lang.String title,
                            int folderTypeId,
                            com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryFolderEntry> callback)

Creates a new gallery folder.

Parameters:

parentFolder - the parent folder path

title - the title property

folderTypeId - the resource type id

callback - the async callback

createNewModelPage

void createNewModelPage(java.lang.String entryPointUri,
                        java.lang.String title,
                        java.lang.String description,
                        CmsUUID copyId,
                        boolean isModelGroup,
                        com.google.gwt.user.client.rpc.AsyncCallback<CmsModelPageEntry> resultCallback)

Creates a new model page.

Parameters:

entryPointUri - the uri of the entry point

title - the title for the model page

description - the description for the model page

copyId - the structure id of the resource to copy to create a new model page; if null, the model page is created as an empty container page

isModelGroup - true to create a new model group page

resultCallback - the callback for the result

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

disableModelPage

void disableModelPage(java.lang.String baseUri,
                      CmsUUID modelPageId,
                      boolean disabled,
                      com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Sets the disabled flag of a model page within the current sitemap configuration.

Parameters:

baseUri - the base uri for the current sitemap

modelPageId - structure id of the model page to remove

disabled - the disabled flag

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

getCategoryData

void getCategoryData(java.lang.String entryPoint,
                     com.google.gwt.user.client.rpc.AsyncCallback<CmsSitemapCategoryData> resultCallback)

Gets the category data for the given entry point.

Parameters:

entryPoint - the entry point

resultCallback - the callback for the result

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

getGalleryData

void getGalleryData(java.lang.String entryPointUri,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<CmsGalleryType,java.util.List<CmsGalleryFolderEntry>>> callback)

Returns the gallery data to this sub site.

Parameters:

entryPointUri - the sub site folder

callback - the async callback

getModelInfos

void getModelInfos(CmsUUID id,
                   com.google.gwt.user.client.rpc.AsyncCallback<CmsModelInfo> callback)

Gets the model pages for the given structure id of the sitemap root folder.

Parameters:

id - structure id of a folder

callback - the callback for the result

getNewElementInfo

void getNewElementInfo(java.lang.String entryPointUri,
                       com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsNewResourceInfo>> resultCallback)

Loads the model page data for the "add" menu.

Parameters:

entryPointUri - the entry point uri

resultCallback - the callback for the result

getResourceLink

void getResourceLink(CmsUUID baseId,
                     java.lang.String sitePath,
                     com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback)

Fetches the link for a resource selected in the sitemap editor.

Parameters:

baseId - the structure id of the current sitemap root entry

sitePath - the site path of a resource

callback - the callback to call with the result

loadPropertyDataForLocaleCompareView

void loadPropertyDataForLocaleCompareView(CmsUUID id,
                                          CmsUUID rootId,
                                          com.google.gwt.user.client.rpc.AsyncCallback<CmsLocaleComparePropertyData> resultCallback)

Loads the data needed by the property editor in the locale comparison view.

Parameters:

id - the id of the resource for which the property editor should be opened

rootId - the structure id of the resource which corresponds to the tree root in locale compare mode

resultCallback - the callback to call with the result

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

prepareReloadSitemap

void prepareReloadSitemap(CmsUUID rootId,
                          CmsSitemapData.EditorMode mode,
                          com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> resultUrl)

Prepares sitemap reloading for the given sitemap root.

This method may change the currently set site root.

Parameters:

rootId - the structure id of the new sitemap root

mode - the new editor mode

resultUrl - the callback for the URL which should be used to reload the sitemap

removeModelPage

void removeModelPage(java.lang.String baseUri,
                     CmsUUID modelPageId,
                     com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Removes a model page from the current sitemap configuration.

Parameters:

baseUri - the base uri for the current sitemap

modelPageId - structure id of the model page to remove

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

savePropertiesForLocaleCompareMode

void savePropertiesForLocaleCompareMode(CmsUUID id,
                                        java.lang.String newUrlName,
                                        java.util.List<CmsPropertyModification> propertyChanges,
                                        boolean editedName,
                                        com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves the changed properties in locale comparison mode.

Parameters:

id - the structure id

newUrlName - the new URL name

propertyChanges - the property changes

editedName - true if the name was edited

callback - the callback to call when done

setDefaultModel

void setDefaultModel(CmsUUID rootId,
                     CmsUUID modelId,
                     com.google.gwt.user.client.rpc.AsyncCallback<CmsModelInfo> callback)

Sets the default model page for the given sub-sitemap, returns the updated model info.

Parameters:

rootId - structure id of the sub-sitemap root folder

modelId - the id of the model page to set as default

callback - the callback for the result

setEditorMode

void setEditorMode(CmsSitemapData.EditorMode editorMode,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Sets the editor mode in the current user session.

Parameters:

editorMode - the editor mode to set

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