Class ObjectProperty

    • Constructor Detail

      • ObjectProperty

        public ObjectProperty()
        Create empty instance
    • Method Detail

      • getId

        public Integer getId()
        Internal ID of the object property definition
        Returns:
        ID
      • 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