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

java.lang.Object
- com.gentics.contentnode.rest.model.Part

All Implemented Interfaces:

Serializable
```
public class Part
extends Object
implements Serializable
```
Rest Model for parts

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Part()
Empty constructor

Constructors
Constructor and Description
`Part()` Empty constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`getDefaultProperty()` Default property
`String`	`getExternalEditorUrl()` External editor URL
`String`	`getGlobalId()` Global ID of the part
`String`	`getHtmlClass()` HTML Class, if the part is of type `Property.Type.LIST`, `Property.Type.ORDEREDLIST` or `Property.Type.UNORDEREDLIST`
`Integer`	`getId()` Local ID of the part
`String`	`getKeyword()` Part keyword
`Integer`	`getMarkupLanguageId()` Optional markup language ID for restricting the part to a specific template markup
`String`	`getName()` Part name
`Map<String,String>`	`getNameI18n()` Map of translated names (keys are the language codes)
`List<SelectOption>`	`getOptions()` Possible options
`OverviewSetting`	`getOverviewSettings()` Overview settings (if type is OVERVIEW)
`Integer`	`getPartOrder()` Part order
`String`	`getPolicy()` Validation policy
`RegexModel`	`getRegex()` Regular expression definition for validation of text parttypes
`SelectSetting`	`getSelectSettings()` Selection settings (if type is SELECT or MULTISELECT)
`Property.Type`	`getType()` Part type
`int`	`getTypeId()` Part type ID
`boolean`	`isEditable()` True if the part is editable
`boolean`	`isHidden()` True if the part is hidden
`boolean`	`isHideInEditor()` Flag for hiding the part in the Tag Editor
`boolean`	`isLiveEditable()` True if the part is live (inline) editable
`boolean`	`isMandatory()` True if the part is mandatory
`Part`	`setDefaultProperty(Property defaultProperty)` Set the default property
`Part`	`setEditable(boolean editable)`
`Part`	`setExternalEditorUrl(String externalEditorUrl)` Set the URL to the external editor
`Part`	`setGlobalId(String globalId)` Set the global ID
`Part`	`setHidden(boolean hidden)`
`Part`	`setHideInEditor(boolean hideInEditor)` Set hideInEditor flag
`Part`	`setHtmlClass(String htmlClass)` Set the html class
`Part`	`setId(Integer id)` Set the local ID
`Part`	`setKeyword(String keyword)`
`Part`	`setLiveEditable(boolean liveEditable)`
`Part`	`setMandatory(boolean mandatory)` Set the mandatory flag
`Part`	`setMarkupLanguageId(Integer markupLanguageId)` Set the markup language ID
`Part`	`setName(String name)`
`Part`	`setName(String name, String language)` Set the name in the given language
`Part`	`setNameI18n(Map<String,String> nameI18n)` Set translated names
`Part`	`setOptions(List<SelectOption> options)`
`Part`	`setOverviewSettings(OverviewSetting overviewSettings)` Set overview settings
`Part`	`setPartOrder(Integer partOrder)` Set the part order
`Part`	`setPolicy(String policy)` Set the validation policy
`Part`	`setRegex(RegexModel regex)` Set regular expression
`Part`	`setSelectSettings(SelectSetting selectSettings)` Set selection settings
`Part`	`setType(Property.Type type)` Set the type
`Part`	`setTypeId(int typeId)` Set the part type ID

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

- Constructor Detail
  - Part
```
public Part()
```
    Empty constructor
- Method Detail
  - getName
```
public String getName()
```
    Part name
    
    Returns:
    
    the name
  - setName
```
public Part setName(String name)
```
    Parameters:
    
    name - the name to set
    
    Returns:
  - getKeyword
```
public String getKeyword()
```
    Part keyword
    
    Returns:
    
    the keyword
  - setKeyword
```
public Part setKeyword(String keyword)
```
    Parameters:
    
    keyword - the keyword to set
    
    Returns:
  - isHidden
```
public boolean isHidden()
```
    True if the part is hidden
    
    Returns:
    
    the hidden
  - setHidden
```
public Part setHidden(boolean hidden)
```
    Parameters:
    
    hidden - the hidden to set
    
    Returns:
  - isEditable
```
public boolean isEditable()
```
    True if the part is editable
    
    Returns:
    
    the editable
  - setEditable
```
public Part setEditable(boolean editable)
```
    Parameters:
    
    editable - the editable to set
    
    Returns:
  - isLiveEditable
```
public boolean isLiveEditable()
```
    True if the part is live (inline) editable
    
    Returns:
    
    the liveEditable
  - setLiveEditable
```
public Part setLiveEditable(boolean liveEditable)
```
    Parameters:
    
    liveEditable - the liveEditable to set
    
    Returns:
  - isMandatory
```
public boolean isMandatory()
```
    True if the part is mandatory
    
    Returns:
    
    mandatory flag
  - setMandatory
```
public Part setMandatory(boolean mandatory)
```
    Set the mandatory flag
    
    Parameters:
    
    mandatory - flag
    
    Returns:
  - getType
```
public Property.Type getType()
```
    Part type
    
    Returns:
    
    type
  - setType
```
public Part setType(Property.Type type)
```
    Set the type
    
    Parameters:
    
    type - type
    
    Returns:
  - getTypeId
```
public int getTypeId()
```
    Part type ID
    
    Returns:
    
    type ID
  - setTypeId
```
public Part setTypeId(int typeId)
```
    Set the part type ID
    
    Parameters:
    
    typeId - type ID
    
    Returns:
  - getId
```
public Integer getId()
```
    Local ID of the part
    
    Returns:
    
    local id
  - setId
```
public Part setId(Integer id)
```
    Set the local ID
    
    Parameters:
    
    id - local id
    
    Returns:
  - getGlobalId
```
public String getGlobalId()
```
    Global ID of the part
    
    Returns:
    
    global ID
  - setGlobalId
```
public Part setGlobalId(String globalId)
```
    Set the global ID
    
    Parameters:
    
    globalId - global ID
    
    Returns:
  - getDefaultProperty
```
public Property getDefaultProperty()
```
    Default property
    
    Returns:
    
    default property
  - setDefaultProperty
```
public Part setDefaultProperty(Property defaultProperty)
```
    Set the default property
    
    Parameters:
    
    defaultProperty - default property
    
    Returns:
  - getRegex
```
public RegexModel getRegex()
```
    Regular expression definition for validation of text parttypes
    
    Returns:
    
    regular expression
  - setRegex
```
public Part setRegex(RegexModel regex)
```
    Set regular expression
    
    Parameters:
    
    regex - regular expression
    
    Returns:
  - isHideInEditor
```
public boolean isHideInEditor()
```
    Flag for hiding the part in the Tag Editor
    
    Returns:
    
    flag
  - setHideInEditor
```
public Part setHideInEditor(boolean hideInEditor)
```
    Set hideInEditor flag
    
    Parameters:
    
    hideInEditor - flag
    
    Returns:
  - getExternalEditorUrl
```
public String getExternalEditorUrl()
```
    External editor URL
    
    Returns:
    
    URL
  - setExternalEditorUrl
```
public Part setExternalEditorUrl(String externalEditorUrl)
```
    Set the URL to the external editor
    
    Parameters:
    
    externalEditorUrl - URL
    
    Returns:
  - getOptions
```
public List<SelectOption> getOptions()
```
    Possible options
    
    Returns:
    
    the options
  - setOptions
```
public Part setOptions(List<SelectOption> options)
```
    Parameters:
    
    options - the options to set
    
    Returns:
  - getOverviewSettings
```
public OverviewSetting getOverviewSettings()
```
    Overview settings (if type is OVERVIEW)
    
    Returns:
    
    overview settings
  - setOverviewSettings
```
public Part setOverviewSettings(OverviewSetting overviewSettings)
```
    Set overview settings
    
    Parameters:
    
    overviewSettings - overview settings
    
    Returns:
  - getSelectSettings
```
public SelectSetting getSelectSettings()
```
    Selection settings (if type is SELECT or MULTISELECT)
    
    Returns:
    
    selection settings
  - setSelectSettings
```
public Part setSelectSettings(SelectSetting selectSettings)
```
    Set selection settings
    
    Parameters:
    
    selectSettings - selection settings
    
    Returns:
  - getMarkupLanguageId
```
public Integer getMarkupLanguageId()
```
    Optional markup language ID for restricting the part to a specific template markup
    
    Returns:
    
    markup language ID
  - setMarkupLanguageId
```
public Part setMarkupLanguageId(Integer markupLanguageId)
```
    Set the markup language ID
    
    Parameters:
    
    markupLanguageId - ID
    
    Returns:
    
    fluent API
  - getHtmlClass
```
public String getHtmlClass()
```
    HTML Class, if the part is of type Property.Type.LIST, Property.Type.ORDEREDLIST or Property.Type.UNORDEREDLIST
    
    Returns:
    
    html class
  - setHtmlClass
```
public Part setHtmlClass(String htmlClass)
```
    Set the html class
    
    Parameters:
    
    htmlClass - html class
    
    Returns:
    
    fluent API
  - getPartOrder
```
public Integer getPartOrder()
```
    Part order
    
    Returns:
    
    order
  - setPartOrder
```
public Part setPartOrder(Integer partOrder)
```
    Set the part order
    
    Parameters:
    
    partOrder - order
    
    Returns:
    
    fluent API
  - getPolicy
```
public String getPolicy()
```
    Validation policy
    
    Returns:
    
    validation policy
  - setPolicy
```
public Part setPolicy(String policy)
```
    Set the validation policy
    
    Parameters:
    
    policy - policy
    
    Returns:
    
    fluent API
  - getNameI18n
```
public Map<String,String> getNameI18n()
```
    Map of translated names (keys are the language codes)
    
    Returns:
    
    translated names
  - setNameI18n
```
public Part setNameI18n(Map<String,String> nameI18n)
```
    Set translated names
    
    Parameters:
    
    nameI18n - translation map
    
    Returns:
    
    fluent API
  - setName
```
public Part setName(String name,
                    String language)
```
    Set the name in the given language
    
    Parameters:
    
    name - name
    
    language - language
    
    Returns:
    
    fluent API

Class Part

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Part

Method Detail

getName

setName

getKeyword

setKeyword

isHidden

setHidden

isEditable

setEditable

isLiveEditable

setLiveEditable

isMandatory

setMandatory

getType

setType

getTypeId

setTypeId

getId

setId

getGlobalId

setGlobalId

getDefaultProperty

setDefaultProperty

getRegex

setRegex

isHideInEditor

setHideInEditor

getExternalEditorUrl

setExternalEditorUrl

getOptions

setOptions

getOverviewSettings

setOverviewSettings

getSelectSettings

setSelectSettings

getMarkupLanguageId

setMarkupLanguageId

getHtmlClass

setHtmlClass

getPartOrder

setPartOrder

getPolicy

setPolicy

getNameI18n

setNameI18n

setName