Construct (Gentics Content.Node - REST API Library 5.45.53 API)

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 and Description

Construct()

Constructors
Constructor and Description
`Construct()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Boolean`	`getAutoEnable()` Flag for automatically enabling new tags, which are created based on this construct
`Optional<Boolean>`	`getAutoEnableOptional()` Flag for automatically enabling new tags, which are created based on this construct
`String`	`getCategory()` Category name of the construct
`Integer`	`getCategoryId()` ID of the category of this construct
`int`	`getCategorySortorder()` Order for the category that was set
`int`	`getCdate()` Creation Date of the construct
`Integer`	`getConstructId()` Deprecated. use getId() instead
`User`	`getCreator()` Creator of the construct
`String`	`getDescription()` Description of this construct
`Map<String,String>`	`getDescriptionI18n()` Map of translated descriptions (keys are the language codes)
`int`	`getEdate()` Last Edit Date of the construct
`Integer`	`getEditdo()` Edit do
`User`	`getEditor()` Last Editor of the construct
`String`	`getExternalEditorUrl()` External editor URL
`String`	`getGlobalId()` Global ID of the construct
`String`	`getHopeditHook()` Javascript "hopedit" hook which, if available should replace the "hopedit" call.
`String`	`getIcon()` Icon of this construct
`Integer`	`getId()` ID of this construct
`String`	`getKeyword()` Keyword for this construct
`String`	`getLiveEditorTagName()` HTML tag name, which is used when tags based on this construct are edited with the live editor
`Boolean`	`getMayBeSubtag()` Whether a tag of this construct may be inserted/nested in other tags
`Optional<Boolean>`	`getMayBeSubtagOptional()` Whether a tag of this construct may be inserted/nested in other tags
`Boolean`	`getMayContainSubtags()` Whether this construct may contain other tags.
`Optional<Boolean>`	`getMayContainSubtagsOptional()` Whether this construct may contain other tags.
`String`	`getName()` Name of this construct
`Map<String,String>`	`getNameI18n()` Map of translated names (keys are the language codes)
`Boolean`	`getNewEditor()` Flag for using the new Tag Editor
`Optional<Boolean>`	`getNewEditorOptional()` Flag for using the new Tag Editor
`List<Part>`	`getParts()` Parts of the construct
`Boolean`	`getVisibleInMenu()` True if the construct shall be visible in the menu, false if not
`Construct`	`setAutoEnable(Boolean autoEnable)` Set autoEnable flag
`Construct`	`setCategory(String category)` Set the category
`Construct`	`setCategoryId(Integer categoryId)` Set the category ID
`Construct`	`setCategorySortorder(int categorySortorder)` Set the order of the category
`Construct`	`setCdate(int cdate)`
`void`	`setConstructId(Integer constructId)` Deprecated. use setId() instead
`Construct`	`setCreator(User creator)`
`Construct`	`setDescription(String description)` Set the description
`Construct`	`setDescription(String description, String language)` Set the description in the given language
`Construct`	`setDescriptionI18n(Map<String,String> i18nDescription)` Set translated descriptions
`Construct`	`setEdate(int edate)`
`Construct`	`setEditdo(Integer editdo)` Set the edit do
`Construct`	`setEditor(User editor)`
`Construct`	`setExternalEditorUrl(String externalEditorUrl)` Set the URL to the external editor
`Construct`	`setGlobalId(String globalId)` Set the global ID
`Construct`	`setHopeditHook(String hopeditHook)` Set the hopedit hook
`Construct`	`setIcon(String icon)` Sets the icon for this construct
`Construct`	`setId(Integer id)` Set the id of this construct
`Construct`	`setKeyword(String keyword)` Sets the keyword for this construct
`Construct`	`setLiveEditorTagName(String liveEditorTagName)` Set the live editor tagname
`Construct`	`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 construct
`Construct`	`setName(String name, String language)` Set the name in the given language
`Construct`	`setNameI18n(Map<String,String> i18nName)` Set translated names
`Construct`	`setNewEditor(Boolean newEditor)` Set the flag for new Tag Editor
`Construct`	`setParts(List<Part> parts)` Set the parts
`Construct`	`setVisibleInMenu(Boolean visibleInMenu)` Set whether the construct shall be visible in the menu
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Construct
```
public Construct()
```
- 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
  - getMayBeSubtagOptional
```
public Optional<Boolean> getMayBeSubtagOptional()
```
    Whether a tag of this construct may be inserted/nested in other tags
    
    Returns:
    
    Optional of flag
  - 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:
  - getMayContainSubtagsOptional
```
public Optional<Boolean> getMayContainSubtagsOptional()
```
    Whether this construct may contain other tags.
    
    Returns:
    
    Optional of mayContainSubtags flag
  - 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() instead
    
    Sets the constructId for this construct
    
    Parameters:
    
    constructId -
  - getConstructId
```
public Integer getConstructId()
```
    Deprecated. use getId() instead
    
    Construct 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 String getCategory()
```
    Category name of the construct
    
    Returns:
    
    category
  - setCategory
```
public Construct setCategory(String category)
```
    Set the category
    
    Parameters:
    
    category - category
    
    Returns:
    
    fluent API
  - getCategorySortorder
```
public int getCategorySortorder()
```
    Order for the category that was set
    
    Returns:
  - setCategorySortorder
```
public Construct setCategorySortorder(int categorySortorder)
```
    Set the order of the category
    
    Parameters:
    
    categorySortorder -
    
    Returns:
    
    fluent API
  - getNewEditor
```
public Boolean getNewEditor()
```
    Flag for using the new Tag Editor
    
    Returns:
    
    newEditor flag
  - getNewEditorOptional
```
public Optional<Boolean> getNewEditorOptional()
```
    Flag for using the new Tag Editor
    
    Returns:
    
    Optional of 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
  - getParts
```
public List<Part> getParts()
```
    Parts of the construct
    
    Returns:
    
    parts
  - setParts
```
public Construct setParts(List<Part> parts)
```
    Set the parts
    
    Parameters:
    
    parts - parts
    
    Returns:
    
    fluent API
  - getVisibleInMenu
```
public Boolean getVisibleInMenu()
```
    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 - name
    
    language - 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 - description
    
    language - language
    
    Returns:
    
    fluent API
  - getAutoEnable
```
public Boolean getAutoEnable()
```
    Flag for automatically enabling new tags, which are created based on this construct
    
    Returns:
    
    flag
  - getAutoEnableOptional
```
public Optional<Boolean> getAutoEnableOptional()
```
    Flag for automatically enabling new tags, which are created based on this construct
    
    Returns:
    
    Optional of 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getCategoryId
```
public Integer getCategoryId()
```
    ID of the category of this construct
    
    Returns:
    
    category ID
  - setCategoryId
```
public Construct setCategoryId(Integer categoryId)
```
    Set the category ID
    
    Parameters:
    
    categoryId - ID
    
    Returns:
    
    fluent API

Class Construct

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Construct

Method Detail

getKeyword

setKeyword

setIcon

setName

getMayBeSubtag

getMayBeSubtagOptional

setMayBeSubtag

getMayContainSubtags

getMayContainSubtagsOptional

setMayContainSubtags

setDescription

setConstructId

getConstructId

getId

setId

getGlobalId

setGlobalId

getName

getDescription

getIcon

getCreator

getCdate

getEditor

getEdate

setCreator

setCdate

setEditor

setEdate

getEditdo

setEditdo

getCategory

setCategory

getCategorySortorder

setCategorySortorder

getNewEditor

getNewEditorOptional

setNewEditor

getExternalEditorUrl

setExternalEditorUrl

getParts

setParts

getVisibleInMenu

setVisibleInMenu

getNameI18n

setNameI18n

setName

getDescriptionI18n

setDescriptionI18n

setDescription

getAutoEnable

getAutoEnableOptional

setAutoEnable

getLiveEditorTagName

setLiveEditorTagName

getHopeditHook

setHopeditHook

toString

getCategoryId

setCategoryId