Package org.opencms.ade.sitemap.shared
Class CmsSitemapChange
java.lang.Object
org.opencms.ade.sitemap.shared.CmsSitemapChange
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,Comparable<CmsSitemapChange>
public class CmsSitemapChange
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable, Comparable<CmsSitemapChange>
Bean containing sitemap entry change information.
- Since:
- 8.0.0
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionConstructor needed for serialization.CmsSitemapChange
(CmsUUID entryId, String sitePath, CmsSitemapChange.ChangeType changeType) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the given change data to this change object.void
addChangeTitle
(String title) Adds a property change for a changed title.int
compareTo
(CmsSitemapChange arg0) Will compare the parent site path and the position of the entry to change.boolean
Two sitemap change objects are considered equal, if the entry id's are equal.Returns the change type.Returns the clip-board data.Returns an additional parameter for creating new resources.Gets the folder type to use if a subsitemap should be created, else null.Gets the default file id.Returns the change'S properties for the default file.Returns the detail page info's.Returns the entry id.getName()
Returns the entry name.Returns the new entry copy resource structure id.int
Returns the new entry resource type id.Returns the properties for the entry itself.Returns the change's properties for the entry itself.Returns the entry parent id.int
Returns the entry position.Gets the list of property changes.Returns the site-path.Returns the updated entry.boolean
Returns if the entry name has changed.boolean
Returns if the position has changed.boolean
Returns if there are changed properties.boolean
Returns if detail page info's have changed.int
hashCode()
boolean
Returns if this change sets a new parent.boolean
isDelete()
Returns if this is a deleting change.boolean
Returns if the entry to change is a leaf type entry.boolean
isNew()
Returns if this is a creating new change.boolean
isRemove()
Returns if this is a remove from navigation change.void
setClipBoardData
(CmsSitemapClipboardData clipBoardData) Sets the clip-board data.void
setCreateParameter
(String parameter) Sets additional info needed for creating new resources.void
setCreateSitemapFolderType
(String folderType) Sets the folder type name to use for creating a subsitemap.void
Sets the default file id.void
Sets the properties for the default file.void
setDetailPageInfos
(List<CmsDetailPageInfo> detailPageInfos) Sets the detail page info's.void
setEntryId
(CmsUUID entryId) Sets the entry id.void
setLeafType
(boolean isLeafEntry) Sets if the entry to change is a leaf type entry.void
Sets the entry name.void
setNewCopyResourceId
(CmsUUID newCopyResourceId) Sets the new entry copy resource structure id.void
setNewResourceTypeId
(int newResourceTypeId) Sets the new entry resource type id.void
Sets the changed properties of the entry itself.void
setParentId
(CmsUUID parentId) Sets the entry parent id.void
setPosition
(int position) Sets the entry position.void
setPropertyChanges
(List<CmsPropertyModification> propertyChanges) Sets the list of property changes.void
setSitePath
(String sitePath) Sets the site path.void
Sets the title.void
setUpdatedEntry
(CmsClientSitemapEntry updatedEntry) Sets the updated entry.
-
Constructor Details
-
CmsSitemapChange
public CmsSitemapChange()Constructor needed for serialization.
-
-
Method Details
-
addChangeTitle
Adds a property change for a changed title.- Parameters:
title
- the changed title
-
equals
Two sitemap change objects are considered equal, if the entry id's are equal. -
getChangeType
Returns the change type.- Returns:
- the change type
-
getClipBoardData
Returns the clip-board data.- Returns:
- the clip-board data
-
getCreateParameter
Returns an additional parameter for creating new resources.- Returns:
- an additional parameter which may contain information needed to create new resources
-
getCreateSitemapFolderType
Gets the folder type to use if a subsitemap should be created, else null.- Returns:
- a resource type name
-
getDefaultFileId
Gets the default file id.- Returns:
- the default file id
-
getDefaultFileProperties
Returns the change'S properties for the default file.- Returns:
- the properties for the default file
-
getDetailPageInfos
Returns the detail page info's.- Returns:
- the detail page info's
-
getEntryId
Returns the entry id.- Returns:
- the entry id
-
getName
Returns the entry name.- Returns:
- the entry name
-
getNewCopyResourceId
Returns the new entry copy resource structure id.- Returns:
- the new entry copy resource structure id
-
getNewResourceTypeId
Returns the new entry resource type id.- Returns:
- the new entry resource type id
-
getOwnInternalProperties
Returns the properties for the entry itself.- Returns:
- the properties for the entry itself
-
getOwnProperties
Returns the change's properties for the entry itself.- Returns:
- the change's properties for the entry itself
-
getParentId
Returns the entry parent id.- Returns:
- the entry parent id
-
getPosition
Returns the entry position.- Returns:
- the entry position
-
getPropertyChanges
Gets the list of property changes.- Returns:
- the list of property changes
-
getSitePath
Returns the site-path.- Returns:
- the site-path
-
getUpdatedEntry
Returns the updated entry.- Returns:
- the updated entry
-
hasChangedName
Returns if the entry name has changed.- Returns:
true
if the entry name has changed
-
hasChangedPosition
Returns if the position has changed.- Returns:
true
if the position has changed
-
hasChangedProperties
Returns if there are changed properties.- Returns:
true
if there are changed properties
-
hasDetailPageInfos
Returns if detail page info's have changed.- Returns:
true
if detail page info's have changed
-
hashCode
-
hasNewParent
Returns if this change sets a new parent.- Returns:
true
if the entry gets a new parent
-
isDelete
Returns if this is a deleting change.- Returns:
- the is delete flag
-
isLeafType
Returns if the entry to change is a leaf type entry.- Returns:
true
if the entry to change is a leaf type entry
-
isNew
Returns if this is a creating new change.- Returns:
- the is new flag
-
isRemove
Returns if this is a remove from navigation change.- Returns:
- the is new flag
-
setCreateParameter
Sets additional info needed for creating new resources.- Parameters:
parameter
- the additional resource creation information
-
setCreateSitemapFolderType
Sets the folder type name to use for creating a subsitemap.- Parameters:
folderType
- a resource type name
-
setDefaultFileId
Sets the default file id.- Parameters:
id
- the default file id
-
setDefaultFileInternalProperties
Sets the properties for the default file.- Parameters:
props
- the properties for the default file
-
setDetailPageInfos
Sets the detail page info's.- Parameters:
detailPageInfos
- the detail page info's to set
-
setEntryId
Sets the entry id.- Parameters:
entryId
- the entry id to set
-
setLeafType
Sets if the entry to change is a leaf type entry.- Parameters:
isLeafEntry
-true
if the entry to change is a leaf type entry
-
setName
Sets the entry name.- Parameters:
name
- the entry name to set
-
setNewCopyResourceId
Sets the new entry copy resource structure id.- Parameters:
newCopyResourceId
- the new entry copy resource structure id to set
-
setNewResourceTypeId
Sets the new entry resource type id.- Parameters:
newResourceTypeId
- the new entry resource type id to set
-
setOwnInternalProperties
Sets the changed properties of the entry itself.- Parameters:
props
- the entry's changed properties
-
setParentId
Sets the entry parent id.- Parameters:
parentId
- the entry parent id to set
-
setPosition
Sets the entry position.- Parameters:
position
- the entry position to set
-
setPropertyChanges
Sets the list of property changes.- Parameters:
propertyChanges
- the property changes
-
setSitePath
Sets the site path.- Parameters:
sitePath
- the site path to set
-
setTitle
Sets the title.- Parameters:
title
- the title