Class Construct
- java.lang.Object
-
- com.gentics.contentnode.rest.model.Construct
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ConstructInPackage
public class Construct extends Object implements Serializable
Construct- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Construct()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConstructCategory
getCategory()
Category of the constructInteger
getCategoryId()
ID of the category of this constructint
getCdate()
Creation Date of the constructInteger
getConstructId()
Deprecated.use getId() insteadUser
getCreator()
Creator of the constructString
getDescription()
Description of this constructMap<String,String>
getDescriptionI18n()
Map of translated descriptions (keys are the language codes)int
getEdate()
Last Edit Date of the constructInteger
getEditdo()
Edit doUser
getEditor()
Last Editor of the constructString
getExternalEditorUrl()
External editor URLString
getGlobalId()
Global ID of the constructString
getHopeditHook()
Javascript "hopedit" hook which, if available should replace the "hopedit" call.String
getIcon()
Icon of this constructInteger
getId()
ID of this constructString
getKeyword()
Keyword for this constructString
getLiveEditorTagName()
HTML tag name, which is used when tags based on this construct are edited with the live editorboolean
getMayBeSubtag()
Whether a tag of this construct may be inserted/nested in other tagsboolean
getMayContainSubtags()
Whether this construct may contain other tags.String
getName()
Name of this constructMap<String,String>
getNameI18n()
Map of translated names (keys are the language codes)List<Part>
getParts()
Parts of the constructboolean
isAutoEnable()
Flag for automatically enabling new tags, which are created based on this constructboolean
isNewEditor()
Flag for using the new Tag Editorboolean
isVisibleInMenu()
True if the construct shall be visible in the menu, false if notConstruct
setAutoEnable(boolean autoEnable)
Set autoEnable flagConstruct
setCategory(ConstructCategory category)
Set the categoryConstruct
setCategoryId(Integer categoryId)
Set the category IDConstruct
setCdate(int cdate)
void
setConstructId(Integer constructId)
Deprecated.use setId() insteadConstruct
setCreator(User creator)
Construct
setDescription(String description)
Set the descriptionConstruct
setDescription(String description, String language)
Set the description in the given languageConstruct
setDescriptionI18n(Map<String,String> i18nDescription)
Set translated descriptionsConstruct
setEdate(int edate)
Construct
setEditdo(Integer editdo)
Set the edit doConstruct
setEditor(User editor)
Construct
setExternalEditorUrl(String externalEditorUrl)
Set the URL to the external editorConstruct
setGlobalId(String globalId)
Set the global IDConstruct
setHopeditHook(String hopeditHook)
Set the hopedit hookConstruct
setIcon(String icon)
Sets the icon for this constructConstruct
setId(Integer id)
Set the id of this constructConstruct
setKeyword(String keyword)
Sets the keyword for this constructConstruct
setLiveEditorTagName(String liveEditorTagName)
Set the live editor tagnameConstruct
setMayBeSubtag(boolean value)
Sets whether a tag of this construct may be a nested in another tag.Construct
setMayContainSubtags(boolean value)
Sets whether this construct may contain other tags.Construct
setName(String name)
Sets the name for this constructConstruct
setName(String name, String language)
Set the name in the given languageConstruct
setNameI18n(Map<String,String> i18nName)
Set translated namesConstruct
setNewEditor(boolean newEditor)
Set the flag for new Tag EditorConstruct
setParts(List<Part> parts)
Set the partsConstruct
setVisibleInMenu(boolean visibleInMenu)
Set whether the construct shall be visible in the menuString
toString()
-
-
-
Method Detail
-
getKeyword
public String getKeyword()
Keyword for this construct- Returns:
- keyword
-
setKeyword
public Construct setKeyword(String keyword)
Sets the keyword for this construct- Returns:
- fluent API
-
setIcon
public Construct setIcon(String icon)
Sets the icon for this construct- Parameters:
icon
-- Returns:
- fluent API
-
setName
public Construct setName(String name)
Sets the name for this construct- Parameters:
name
-- Returns:
- fluent API
-
getMayBeSubtag
public boolean getMayBeSubtag()
Whether a tag of this construct may be inserted/nested in other tags- Returns:
- True or false
-
setMayBeSubtag
public Construct setMayBeSubtag(boolean value)
Sets whether a tag of this construct may be a nested in another tag.- Parameters:
value
-- Returns:
- fluent API
-
getMayContainSubtags
public boolean getMayContainSubtags()
Whether this construct may contain other tags.- Returns:
-
setMayContainSubtags
public Construct setMayContainSubtags(boolean value)
Sets whether this construct may contain other tags. This means tags can be inserted into a tag from this construct- Parameters:
value
-- Returns:
- fluent API
-
setDescription
public Construct setDescription(String description)
Set the description- Parameters:
description
-- Returns:
- fluent API
-
setConstructId
public void setConstructId(Integer constructId)
Deprecated.use setId() insteadSets the constructId for this construct- Parameters:
constructId
-
-
getConstructId
public Integer getConstructId()
Deprecated.use getId() insteadConstruct id of this construct- Returns:
-
getId
public Integer getId()
ID of this construct- Returns:
- id
-
setId
public Construct setId(Integer id)
Set the id of this construct- Parameters:
id
- id- Returns:
- fluent API
-
getGlobalId
public String getGlobalId()
Global ID of the construct- Returns:
- global ID
-
setGlobalId
public Construct setGlobalId(String globalId)
Set the global ID- Parameters:
globalId
- global ID- Returns:
- fluent API
-
getName
public String getName()
Name of this construct- Returns:
-
getDescription
public String getDescription()
Description of this construct- Returns:
- description
-
getIcon
public String getIcon()
Icon of this construct- Returns:
-
getCreator
public User getCreator()
Creator of the construct- Returns:
- the creator
-
getCdate
public int getCdate()
Creation Date of the construct- Returns:
- the cdate
-
getEditor
public User getEditor()
Last Editor of the construct- Returns:
- the editor
-
getEdate
public int getEdate()
Last Edit Date of the construct- Returns:
- the edate
-
setCreator
public Construct setCreator(User creator)
- Parameters:
creator
- the creator to set- Returns:
- fluent API
-
setCdate
public Construct setCdate(int cdate)
- Parameters:
cdate
- the cdate to set- Returns:
- fluent API
-
setEditor
public Construct setEditor(User editor)
- Parameters:
editor
- the editor to set- Returns:
- fluent API
-
setEdate
public Construct setEdate(int edate)
- Parameters:
edate
- the edate to set- Returns:
- fluent API
-
getEditdo
public Integer getEditdo()
Edit do- Returns:
- edit do
-
setEditdo
public Construct setEditdo(Integer editdo)
Set the edit do- Parameters:
editdo
- edit do- Returns:
- fluent API
-
getCategory
public ConstructCategory getCategory()
Category of the construct- Returns:
- category
-
setCategory
public Construct setCategory(ConstructCategory category)
Set the category- Parameters:
category
- category- Returns:
- fluent API
-
isNewEditor
public boolean isNewEditor()
Flag for using the new Tag Editor- Returns:
- newEditor flag
-
setNewEditor
public Construct setNewEditor(boolean newEditor)
Set the flag for new Tag Editor- Parameters:
newEditor
- flag- Returns:
- fluent API
-
getExternalEditorUrl
public String getExternalEditorUrl()
External editor URL- Returns:
- URL
-
setExternalEditorUrl
public Construct setExternalEditorUrl(String externalEditorUrl)
Set the URL to the external editor- Parameters:
externalEditorUrl
- URL- Returns:
- fluent API
-
setParts
public Construct setParts(List<Part> parts)
Set the parts- Parameters:
parts
- parts- Returns:
- fluent API
-
isVisibleInMenu
public boolean isVisibleInMenu()
True if the construct shall be visible in the menu, false if not- Returns:
- true for visible constructs, false for hidden
-
setVisibleInMenu
public Construct setVisibleInMenu(boolean visibleInMenu)
Set whether the construct shall be visible in the menu- Parameters:
visibleInMenu
- true for visible, false for hidden- Returns:
- fluent API
-
getNameI18n
public Map<String,String> getNameI18n()
Map of translated names (keys are the language codes)- Returns:
- name map
-
setNameI18n
public Construct setNameI18n(Map<String,String> i18nName)
Set translated names- Parameters:
i18nName
- map of translations- Returns:
- fluent API
-
setName
public Construct setName(String name, String language)
Set the name in the given language- Parameters:
name
- namelanguage
- language- Returns:
- fluent API
-
getDescriptionI18n
public Map<String,String> getDescriptionI18n()
Map of translated descriptions (keys are the language codes)- Returns:
- description map
-
setDescriptionI18n
public Construct setDescriptionI18n(Map<String,String> i18nDescription)
Set translated descriptions- Parameters:
i18nDescription
- map of translations- Returns:
- fluent API
-
setDescription
public Construct setDescription(String description, String language)
Set the description in the given language- Parameters:
description
- descriptionlanguage
- language- Returns:
- fluent API
-
isAutoEnable
public boolean isAutoEnable()
Flag for automatically enabling new tags, which are created based on this construct- Returns:
- flag
-
setAutoEnable
public Construct setAutoEnable(boolean autoEnable)
Set autoEnable flag- Parameters:
autoEnable
- flag- Returns:
- fluent API
-
getLiveEditorTagName
public String getLiveEditorTagName()
HTML tag name, which is used when tags based on this construct are edited with the live editor- Returns:
- tag name
-
setLiveEditorTagName
public Construct setLiveEditorTagName(String liveEditorTagName)
Set the live editor tagname- Parameters:
liveEditorTagName
- tag name- Returns:
- fluent API
-
getHopeditHook
public String getHopeditHook()
Javascript "hopedit" hook which, if available should replace the "hopedit" call.- Returns:
- hopedit hook
-
setHopeditHook
public Construct setHopeditHook(String hopeditHook)
Set the hopedit hook- Parameters:
hopeditHook
- hook- Returns:
- fluent API
-
getCategoryId
public Integer getCategoryId()
ID of the category of this construct- Returns:
- category ID
-
-