com.gentics.contentnode.rest.model

Class ObjectProperty

java.lang.Object

com.gentics.contentnode.rest.model.ObjectProperty

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ObjectPropertyInPackage

public class ObjectProperty
extends Object
implements Serializable

REST Model of an object property definition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectProperty() Create empty instance

Method Summary

Modifier and Type	Method and Description
ObjectPropertyCategory	getCategory() Category used by the object property (may be null, if not embedded in the response)
Integer	getCategoryId() Get the category ID (may be null)
Construct	getConstruct() Construct used by the object property (may be null, if not embedded in the response)
Integer	getConstructId() Internal construct ID
String	getDescription() Description in the current language
Map<String,String>	getDescriptionI18n()
String	getGlobalId() Global ID
Integer	getId() Internal ID of the object property definition
Boolean	getInheritable() True if the object property is inheritable, false if not
String	getKeyword() Keyword
String	getName() Name in the current language
Map<String,String>	getNameI18n()
Boolean	getRequired() True if the object property is required, false if not
Boolean	getSyncChannelset() True if the object property is synchronized for all channel variants
Boolean	getSyncContentset() True if the object property is synchronized for all languages (only for pages)
Boolean	getSyncVariants() True if the object property is synchronized for all page variants
Integer	getType() Type of objects, this object property definition is for
ObjectProperty	setCategory(ObjectPropertyCategory category) Set the category
ObjectProperty	setCategoryId(Integer categoryId) Set the category ID (may be null)
ObjectProperty	setConstruct(Construct construct) Set the construct if embedded or null
ObjectProperty	setConstructId(Integer constructId) Set the construct ID
ObjectProperty	setDescription(String description) Set the description
ObjectProperty	setDescription(String name, String language)
ObjectProperty	setDescriptionI18n(Map<String,String> i18nDescription)
ObjectProperty	setGlobalId(String globalId) Set the global ID
ObjectProperty	setId(Integer id) Set the ID
ObjectProperty	setInheritable(Boolean inheritable) Set true for inheritable
ObjectProperty	setKeyword(String keyword) Set the keyword
ObjectProperty	setName(String name) Set the name
ObjectProperty	setName(String name, String language)
ObjectProperty	setNameI18n(Map<String,String> i18nName)
ObjectProperty	setRequired(Boolean required) Set whether required
ObjectProperty	setSyncChannelset(Boolean syncChannelset) Set true for synchronization for all channel variants
ObjectProperty	setSyncContentset(Boolean syncContentset) Set true for synchronization for all languages
ObjectProperty	setSyncVariants(Boolean syncVariants) Set true for synchronization for all page variants
ObjectProperty	setType(Integer type) Object type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectProperty

public ObjectProperty()

Create empty instance

Method Detail

getId

public Integer getId()

Internal ID of the object property definition

Returns:

ID

setId

public ObjectProperty setId(Integer id)

Set the ID

Parameters:

id - ID

Returns:

fluent API

getGlobalId

public String getGlobalId()

Global ID

Returns:

global ID

setGlobalId

public ObjectProperty setGlobalId(String globalId)

Set the global ID

Parameters:

globalId - global ID

Returns:

fluent API

getName

public String getName()

Name in the current language

Returns:

name

setName

public ObjectProperty setName(String name)

Set the name

Parameters:

name - name

Returns:

fluent API

getDescription

public String getDescription()

Description in the current language

Returns:

description

setDescription

public ObjectProperty setDescription(String description)

Set the description

Parameters:

description - description

Returns:

fluent API

getKeyword

public String getKeyword()

Keyword

Returns:

keyword

setKeyword

public ObjectProperty setKeyword(String keyword)

Set the keyword

Parameters:

keyword - keyword

Returns:

fluent API

getType

public Integer getType()

Type of objects, this object property definition is for

Returns:

type

setType

public ObjectProperty setType(Integer type)

Object type

Parameters:

type - type

Returns:

fluent API

getConstructId

public Integer getConstructId()

Internal construct ID

Returns:

construct ID

setConstructId

public ObjectProperty setConstructId(Integer constructId)

Set the construct ID

Parameters:

constructId - construct ID

Returns:

fluent API

getConstruct

public Construct getConstruct()

Construct used by the object property (may be null, if not embedded in the response)

Returns:

construct

setConstruct

public ObjectProperty setConstruct(Construct construct)

Set the construct if embedded or null

Parameters:

construct - construct or null

Returns:

fluent API

getRequired

public Boolean getRequired()

True if the object property is required, false if not

Returns:

true for required

setRequired

public ObjectProperty setRequired(Boolean required)

Set whether required

Parameters:

required - true for required

Returns:

fluent API

getInheritable

public Boolean getInheritable()

True if the object property is inheritable, false if not

Returns:

true for inheritable

setInheritable

public ObjectProperty setInheritable(Boolean inheritable)

Set true for inheritable

Parameters:

inheritable - true for inheritable

Returns:

fluent API

getSyncContentset

public Boolean getSyncContentset()

True if the object property is synchronized for all languages (only for pages)

Returns:

true for synchronized

setSyncContentset

public ObjectProperty setSyncContentset(Boolean syncContentset)

Set true for synchronization for all languages

Parameters:

syncContentset - flag

Returns:

fluent API

getSyncChannelset

public Boolean getSyncChannelset()

True if the object property is synchronized for all channel variants

Returns:

true for synchronized

setSyncChannelset

public ObjectProperty setSyncChannelset(Boolean syncChannelset)

Set true for synchronization for all channel variants

Parameters:

syncChannelset - flag

Returns:

fluent API

getSyncVariants

public Boolean getSyncVariants()

True if the object property is synchronized for all page variants

Returns:

true for synchronized

setSyncVariants

public ObjectProperty setSyncVariants(Boolean syncVariants)

Set true for synchronization for all page variants

Parameters:

syncVariants -

Returns:

fluent API

getCategoryId

public Integer getCategoryId()

Get the category ID (may be null)

Returns:

category ID

setCategoryId

public ObjectProperty setCategoryId(Integer categoryId)

Set the category ID (may be null)

Parameters:

categoryId - category ID

Returns:

fluent API

getCategory

public ObjectPropertyCategory getCategory()

Category used by the object property (may be null, if not embedded in the response)

Returns:

construct

setCategory

public ObjectProperty setCategory(ObjectPropertyCategory category)

Set the category

Parameters:

category - category or null

Returns:

fluent API

getNameI18n

public Map<String,String> getNameI18n()

setNameI18n

public ObjectProperty setNameI18n(Map<String,String> i18nName)

setName

public ObjectProperty setName(String name,
                              String language)

getDescriptionI18n

public Map<String,String> getDescriptionI18n()

setDescriptionI18n

public ObjectProperty setDescriptionI18n(Map<String,String> i18nDescription)

setDescription

public ObjectProperty setDescription(String name,
                                     String language)