Class Part
java.lang.Object
com.gentics.contentnode.rest.model.Part
- All Implemented Interfaces:
Serializable
Rest Model for parts
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDefault propertyExternal editor URLGlobal ID of the partHTML Class, if the part is of typeProperty.Type.LIST
,Property.Type.ORDEREDLIST
orProperty.Type.UNORDEREDLIST
getId()
Local ID of the partPart keywordOptional markup language ID for restricting the part to a specific template markupgetName()
Part nameMap of translated names (keys are the language codes)Possible optionsOverview settings (if type is OVERVIEW)Part orderValidation policygetRegex()
Regular expression definition for validation of text parttypesSelection settings (if type is SELECT or MULTISELECT)getType()
Part typeint
Part type IDboolean
True if the part is editableboolean
isHidden()
True if the part is hiddenboolean
Flag for hiding the part in the Tag Editorboolean
True if the part is live (inline) editableboolean
True if the part is mandatorysetDefaultProperty
(Property defaultProperty) Set the default propertysetEditable
(boolean editable) setExternalEditorUrl
(String externalEditorUrl) Set the URL to the external editorsetGlobalId
(String globalId) Set the global IDsetHidden
(boolean hidden) setHideInEditor
(boolean hideInEditor) Set hideInEditor flagsetHtmlClass
(String htmlClass) Set the html classSet the local IDsetKeyword
(String keyword) setLiveEditable
(boolean liveEditable) setMandatory
(boolean mandatory) Set the mandatory flagsetMarkupLanguageId
(Integer markupLanguageId) Set the markup language IDSet the name in the given languagesetNameI18n
(Map<String, String> nameI18n) Set translated namessetOptions
(List<SelectOption> options) setOverviewSettings
(OverviewSetting overviewSettings) Set overview settingssetPartOrder
(Integer partOrder) Set the part orderSet the validation policysetRegex
(RegexModel regex) Set regular expressionsetSelectSettings
(SelectSetting selectSettings) Set selection settingssetType
(Property.Type type) Set the typesetTypeId
(int typeId) Set the part type ID
-
Constructor Details
-
Part
public Part()Empty constructor
-
-
Method Details
-
getName
Part name- Returns:
- the name
-
setName
- Parameters:
name
- the name to set- Returns:
-
getKeyword
Part keyword- Returns:
- the keyword
-
setKeyword
- Parameters:
keyword
- the keyword to set- Returns:
-
isHidden
public boolean isHidden()True if the part is hidden- Returns:
- the hidden
-
setHidden
- Parameters:
hidden
- the hidden to set- Returns:
-
isEditable
public boolean isEditable()True if the part is editable- Returns:
- the editable
-
setEditable
- Parameters:
editable
- the editable to set- Returns:
-
isLiveEditable
public boolean isLiveEditable()True if the part is live (inline) editable- Returns:
- the liveEditable
-
setLiveEditable
- Parameters:
liveEditable
- the liveEditable to set- Returns:
-
isMandatory
public boolean isMandatory()True if the part is mandatory- Returns:
- mandatory flag
-
setMandatory
Set the mandatory flag- Parameters:
mandatory
- flag- Returns:
-
getType
Part type- Returns:
- type
-
setType
Set the type- Parameters:
type
- type- Returns:
-
getTypeId
public int getTypeId()Part type ID- Returns:
- type ID
-
setTypeId
Set the part type ID- Parameters:
typeId
- type ID- Returns:
-
getId
Local ID of the part- Returns:
- local id
-
setId
Set the local ID- Parameters:
id
- local id- Returns:
-
getGlobalId
Global ID of the part- Returns:
- global ID
-
setGlobalId
Set the global ID- Parameters:
globalId
- global ID- Returns:
-
getDefaultProperty
Default property- Returns:
- default property
-
setDefaultProperty
Set the default property- Parameters:
defaultProperty
- default property- Returns:
-
getRegex
Regular expression definition for validation of text parttypes- Returns:
- regular expression
-
setRegex
Set regular expression- Parameters:
regex
- regular expression- Returns:
-
isHideInEditor
public boolean isHideInEditor()Flag for hiding the part in the Tag Editor- Returns:
- flag
-
setHideInEditor
Set hideInEditor flag- Parameters:
hideInEditor
- flag- Returns:
-
getExternalEditorUrl
External editor URL- Returns:
- URL
-
setExternalEditorUrl
Set the URL to the external editor- Parameters:
externalEditorUrl
- URL- Returns:
-
getOptions
Possible options- Returns:
- the options
-
setOptions
- Parameters:
options
- the options to set- Returns:
-
getOverviewSettings
Overview settings (if type is OVERVIEW)- Returns:
- overview settings
-
setOverviewSettings
Set overview settings- Parameters:
overviewSettings
- overview settings- Returns:
-
getSelectSettings
Selection settings (if type is SELECT or MULTISELECT)- Returns:
- selection settings
-
setSelectSettings
Set selection settings- Parameters:
selectSettings
- selection settings- Returns:
-
getMarkupLanguageId
Optional markup language ID for restricting the part to a specific template markup- Returns:
- markup language ID
-
setMarkupLanguageId
Set the markup language ID- Parameters:
markupLanguageId
- ID- Returns:
- fluent API
-
getHtmlClass
HTML Class, if the part is of typeProperty.Type.LIST
,Property.Type.ORDEREDLIST
orProperty.Type.UNORDEREDLIST
- Returns:
- html class
-
setHtmlClass
Set the html class- Parameters:
htmlClass
- html class- Returns:
- fluent API
-
getPartOrder
Part order- Returns:
- order
-
setPartOrder
Set the part order- Parameters:
partOrder
- order- Returns:
- fluent API
-
getPolicy
Validation policy- Returns:
- validation policy
-
setPolicy
Set the validation policy- Parameters:
policy
- policy- Returns:
- fluent API
-
getNameI18n
Map of translated names (keys are the language codes)- Returns:
- translated names
-
setNameI18n
Set translated names- Parameters:
nameI18n
- translation map- Returns:
- fluent API
-
setName
Set the name in the given language- Parameters:
name
- namelanguage
- language- Returns:
- fluent API
-