Package de.hybris.platform.comments.model

Class ComponentModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.comments.model.ComponentModel

All Implemented Interfaces:

Serializable

public class ComponentModel
extends ItemModel

Generated model class for type Component first defined at extension comments.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_COMMENTCOMPONENTRELATION	Generated relation code constant for relation CommentComponentRelation defining source attribute comment in extension comments.
static final String	_DOMAINCOMPONENTRELATION	Generated relation code constant for relation DomainComponentRelation defining source attribute domain in extension comments.
static final String	_TYPECODE	Generated model type code constant.
static final String	AVAILABLECOMMENTTYPES	Generated constant - Attribute key of Component.availableCommentTypes attribute defined at extension comments.
static final String	CODE	Generated constant - Attribute key of Component.code attribute defined at extension comments.
static final String	COMMENT	Generated constant - Attribute key of Component.comment attribute defined at extension comments.
static final String	CREATEPERMITTED	Generated constant - Attribute key of Component.createPermitted attribute defined at extension comments.
static final String	DOMAIN	Generated constant - Attribute key of Component.domain attribute defined at extension comments.
static final String	NAME	Generated constant - Attribute key of Component.name attribute defined at extension comments.
static final String	READPERMITTED	Generated constant - Attribute key of Component.readPermitted attribute defined at extension comments.
static final String	REMOVEPERMITTED	Generated constant - Attribute key of Component.removePermitted attribute defined at extension comments.
static final String	WRITEPERMITTED	Generated constant - Attribute key of Component.writePermitted attribute defined at extension comments.

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor	Description
ComponentModel()	Generated constructor - Default constructor for generic creation.
ComponentModel(DomainModel _domain)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.1 Please use the default constructor without parameters
ComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
ComponentModel(String _code, DomainModel _domain, ItemModel _owner)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.1 Please use the default constructor without parameters

Method Summary

Modifier and Type	Method	Description
Collection<CommentTypeModel>	getAvailableCommentTypes()	Deprecated, for removal: This API element is subject to removal in a future version. since ages
String	getCode()	Generated method - Getter of the Component.code attribute defined at extension comments.
Collection<PrincipalModel>	getCreatePermitted()	Generated method - Getter of the Component.createPermitted attribute defined at extension comments.
Collection<PrincipalModel>	getCreatePermitted(Locale loc)	Generated method - Getter of the Component.createPermitted attribute defined at extension comments.
DomainModel	getDomain()	Generated method - Getter of the Component.domain attribute defined at extension comments.
String	getName()	Generated method - Getter of the Component.name attribute defined at extension comments.
Collection<PrincipalModel>	getReadPermitted()	Generated method - Getter of the Component.readPermitted attribute defined at extension comments.
Collection<PrincipalModel>	getReadPermitted(Locale loc)	Generated method - Getter of the Component.readPermitted attribute defined at extension comments.
Collection<PrincipalModel>	getRemovePermitted()	Generated method - Getter of the Component.removePermitted attribute defined at extension comments.
Collection<PrincipalModel>	getRemovePermitted(Locale loc)	Generated method - Getter of the Component.removePermitted attribute defined at extension comments.
Collection<PrincipalModel>	getWritePermitted()	Generated method - Getter of the Component.writePermitted attribute defined at extension comments.
Collection<PrincipalModel>	getWritePermitted(Locale loc)	Generated method - Getter of the Component.writePermitted attribute defined at extension comments.
void	setCode(String value)	Generated method - Initial setter of Component.code attribute defined at extension comments.
void	setCreatePermitted(Collection<PrincipalModel> value)	Generated method - Setter of Component.createPermitted attribute defined at extension comments.
void	setCreatePermitted(Collection<PrincipalModel> value, Locale loc)	Generated method - Setter of Component.createPermitted attribute defined at extension comments.
void	setDomain(DomainModel value)	Generated method - Initial setter of Component.domain attribute defined at extension comments.
void	setName(String value)	Generated method - Setter of Component.name attribute defined at extension comments.
void	setReadPermitted(Collection<PrincipalModel> value)	Generated method - Setter of Component.readPermitted attribute defined at extension comments.
void	setReadPermitted(Collection<PrincipalModel> value, Locale loc)	Generated method - Setter of Component.readPermitted attribute defined at extension comments.
void	setRemovePermitted(Collection<PrincipalModel> value)	Generated method - Setter of Component.removePermitted attribute defined at extension comments.
void	setRemovePermitted(Collection<PrincipalModel> value, Locale loc)	Generated method - Setter of Component.removePermitted attribute defined at extension comments.
void	setWritePermitted(Collection<PrincipalModel> value)	Generated method - Setter of Component.writePermitted attribute defined at extension comments.
void	setWritePermitted(Collection<PrincipalModel> value, Locale loc)	Generated method - Setter of Component.writePermitted attribute defined at extension comments.

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

• Constant Field Values

_DOMAINCOMPONENTRELATION

public static final String _DOMAINCOMPONENTRELATION

Generated relation code constant for relation DomainComponentRelation defining source attribute domain in extension comments.

See Also:

• Constant Field Values

_COMMENTCOMPONENTRELATION

public static final String _COMMENTCOMPONENTRELATION

Generated relation code constant for relation CommentComponentRelation defining source attribute comment in extension comments.

See Also:

• Constant Field Values

CODE

public static final String CODE

Generated constant - Attribute key of Component.code attribute defined at extension comments.

See Also:

• Constant Field Values

NAME

public static final String NAME

Generated constant - Attribute key of Component.name attribute defined at extension comments.

See Also:

• Constant Field Values

AVAILABLECOMMENTTYPES

public static final String AVAILABLECOMMENTTYPES

Generated constant - Attribute key of Component.availableCommentTypes attribute defined at extension comments.

See Also:

• Constant Field Values

DOMAIN

public static final String DOMAIN

Generated constant - Attribute key of Component.domain attribute defined at extension comments.

See Also:

• Constant Field Values

COMMENT

public static final String COMMENT

Generated constant - Attribute key of Component.comment attribute defined at extension comments.

See Also:

• Constant Field Values

READPERMITTED

public static final String READPERMITTED

Generated constant - Attribute key of Component.readPermitted attribute defined at extension comments.

See Also:

• Constant Field Values

WRITEPERMITTED

public static final String WRITEPERMITTED

Generated constant - Attribute key of Component.writePermitted attribute defined at extension comments.

See Also:

• Constant Field Values

CREATEPERMITTED

public static final String CREATEPERMITTED

Generated constant - Attribute key of Component.createPermitted attribute defined at extension comments.

See Also:

• Constant Field Values

REMOVEPERMITTED

public static final String REMOVEPERMITTED

Generated constant - Attribute key of Component.removePermitted attribute defined at extension comments.

See Also:

• Constant Field Values

Constructor Details

ComponentModel

public ComponentModel()

Generated constructor - Default constructor for generic creation.

ComponentModel

public ComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

ctx - the model context to be injected, must not be null

ComponentModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public ComponentModel(DomainModel _domain)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.1 Please use the default constructor without parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_domain - initial attribute declared by type Component at extension comments

ComponentModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public ComponentModel(String _code,
 DomainModel _domain,
 ItemModel _owner)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.1 Please use the default constructor without parameters

Generated constructor - for all mandatory and initial attributes.

Parameters:

_code - initial attribute declared by type Component at extension comments

_domain - initial attribute declared by type Component at extension comments

_owner - initial attribute declared by type Item at extension core

Method Details

getAvailableCommentTypes

@Deprecated(since="ages",
            forRemoval=true)
@Accessor(qualifier="availableCommentTypes",
          type=GETTER)
public Collection<CommentTypeModel> getAvailableCommentTypes()

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Generated method - Getter of the Component.availableCommentTypes attribute defined at extension comments. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the availableCommentTypes

getCode

@Accessor(qualifier="code",
          type=GETTER)
public String getCode()

Generated method - Getter of the Component.code attribute defined at extension comments.

Returns:

the code - unique identifier of the component

getCreatePermitted

@Accessor(qualifier="createPermitted",
          type=GETTER)
public Collection<PrincipalModel> getCreatePermitted()

Generated method - Getter of the Component.createPermitted attribute defined at extension comments.

Returns:

the createPermitted

getCreatePermitted

@Accessor(qualifier="createPermitted",
          type=GETTER)
public Collection<PrincipalModel> getCreatePermitted(Locale loc)

Generated method - Getter of the Component.createPermitted attribute defined at extension comments.

Parameters:

loc - the value localization key

Returns:

the createPermitted

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getDomain

@Accessor(qualifier="domain",
          type=GETTER)
public DomainModel getDomain()

Generated method - Getter of the Component.domain attribute defined at extension comments.

Returns:

the domain

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName()

Generated method - Getter of the Component.name attribute defined at extension comments.

Returns:

the name - Name of the component

getReadPermitted

@Accessor(qualifier="readPermitted",
          type=GETTER)
public Collection<PrincipalModel> getReadPermitted()

Generated method - Getter of the Component.readPermitted attribute defined at extension comments.

Returns:

the readPermitted

getReadPermitted

@Accessor(qualifier="readPermitted",
          type=GETTER)
public Collection<PrincipalModel> getReadPermitted(Locale loc)

Generated method - Getter of the Component.readPermitted attribute defined at extension comments.

Parameters:

loc - the value localization key

Returns:

the readPermitted

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getRemovePermitted

@Accessor(qualifier="removePermitted",
          type=GETTER)
public Collection<PrincipalModel> getRemovePermitted()

Generated method - Getter of the Component.removePermitted attribute defined at extension comments.

Returns:

the removePermitted

getRemovePermitted

@Accessor(qualifier="removePermitted",
          type=GETTER)
public Collection<PrincipalModel> getRemovePermitted(Locale loc)

Generated method - Getter of the Component.removePermitted attribute defined at extension comments.

Parameters:

loc - the value localization key

Returns:

the removePermitted

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getWritePermitted

@Accessor(qualifier="writePermitted",
          type=GETTER)
public Collection<PrincipalModel> getWritePermitted()

Generated method - Getter of the Component.writePermitted attribute defined at extension comments.

Returns:

the writePermitted

getWritePermitted

@Accessor(qualifier="writePermitted",
          type=GETTER)
public Collection<PrincipalModel> getWritePermitted(Locale loc)

Generated method - Getter of the Component.writePermitted attribute defined at extension comments.

Parameters:

loc - the value localization key

Returns:

the writePermitted

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setCode

@Accessor(qualifier="code",
          type=SETTER)
public void setCode(String value)

Generated method - Initial setter of Component.code attribute defined at extension comments. Can only be used at creation of model - before first save.

Parameters:

value - the code - unique identifier of the component

setCreatePermitted

@Accessor(qualifier="createPermitted",
          type=SETTER)
public void setCreatePermitted(Collection<PrincipalModel> value)

Generated method - Setter of Component.createPermitted attribute defined at extension comments.

Parameters:

value - the createPermitted

setCreatePermitted

@Accessor(qualifier="createPermitted",
          type=SETTER)
public void setCreatePermitted(Collection<PrincipalModel> value,
 Locale loc)

Generated method - Setter of Component.createPermitted attribute defined at extension comments.

Parameters:

value - the createPermitted

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setDomain

@Accessor(qualifier="domain",
          type=SETTER)
public void setDomain(DomainModel value)

Generated method - Initial setter of Component.domain attribute defined at extension comments. Can only be used at creation of model - before first save.

Parameters:

value - the domain

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(String value)

Generated method - Setter of Component.name attribute defined at extension comments.

Parameters:

value - the name - Name of the component

setReadPermitted

@Accessor(qualifier="readPermitted",
          type=SETTER)
public void setReadPermitted(Collection<PrincipalModel> value)

Generated method - Setter of Component.readPermitted attribute defined at extension comments.

Parameters:

value - the readPermitted

setReadPermitted

@Accessor(qualifier="readPermitted",
          type=SETTER)
public void setReadPermitted(Collection<PrincipalModel> value,
 Locale loc)

Generated method - Setter of Component.readPermitted attribute defined at extension comments.

Parameters:

value - the readPermitted

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setRemovePermitted

@Accessor(qualifier="removePermitted",
          type=SETTER)
public void setRemovePermitted(Collection<PrincipalModel> value)

Generated method - Setter of Component.removePermitted attribute defined at extension comments.

Parameters:

value - the removePermitted

setRemovePermitted

@Accessor(qualifier="removePermitted",
          type=SETTER)
public void setRemovePermitted(Collection<PrincipalModel> value,
 Locale loc)

Generated method - Setter of Component.removePermitted attribute defined at extension comments.

Parameters:

value - the removePermitted

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setWritePermitted

@Accessor(qualifier="writePermitted",
          type=SETTER)
public void setWritePermitted(Collection<PrincipalModel> value)

Generated method - Setter of Component.writePermitted attribute defined at extension comments.

Parameters:

value - the writePermitted

setWritePermitted

@Accessor(qualifier="writePermitted",
          type=SETTER)
public void setWritePermitted(Collection<PrincipalModel> value,
 Locale loc)

Generated method - Setter of Component.writePermitted attribute defined at extension comments.

Parameters:

value - the writePermitted

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language