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