Package de.hybris.platform.commons.model

Class FormatModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.commons.model.FormatModel

All Implemented Interfaces:

Serializable

public class FormatModel
extends ItemModel

Generated model class for type Format first defined at extension commons.

See Also:

• Serialized Form

Nested Class Summary

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

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_TYPECODE	Generated model type code constant.
static final String	CHAINED	Generated constant - Attribute key of Format.chained attribute defined at extension commons.
static final String	CODE	Generated constant - Attribute key of Format.code attribute defined at extension commons.
static final String	DOCUMENTTYPE	Generated constant - Attribute key of Format.documentType attribute defined at extension commons.
static final String	INITIAL	Generated constant - Attribute key of Format.initial attribute defined at extension commons.
static final String	NAME	Generated constant - Attribute key of Format.name attribute defined at extension commons.
static final String	VALIDFOR	Generated constant - Attribute key of Format.validFor attribute defined at extension commons.

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
FormatModel()	Generated constructor - Default constructor for generic creation.
FormatModel(ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
FormatModel(String _code, DocumentTypeEnum _documentType, ItemFormatterModel _initial)	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
FormatModel(String _code, DocumentTypeEnum _documentType, ItemFormatterModel _initial, 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<MediaFormatterModel>	getChained()	Generated method - Getter of the Format.chained attribute defined at extension commons.
String	getCode()	Generated method - Getter of the Format.code attribute defined at extension commons.
DocumentTypeEnum	getDocumentType()	Generated method - Getter of the Format.documentType attribute defined at extension commons.
ItemFormatterModel	getInitial()	Generated method - Getter of the Format.initial attribute defined at extension commons.
String	getName()	Generated method - Getter of the Format.name attribute defined at extension commons.
String	getName(Locale loc)	Generated method - Getter of the Format.name attribute defined at extension commons.
Collection<ComposedTypeModel>	getValidFor()	Generated method - Getter of the Format.validFor attribute defined at extension commons.
void	setChained(Collection<MediaFormatterModel> value)	Generated method - Setter of Format.chained attribute defined at extension commons.
void	setCode(String value)	Generated method - Initial setter of Format.code attribute defined at extension commons.
void	setDocumentType(DocumentTypeEnum value)	Generated method - Setter of Format.documentType attribute defined at extension commons.
void	setInitial(ItemFormatterModel value)	Generated method - Setter of Format.initial attribute defined at extension commons.
void	setName(String value)	Generated method - Setter of Format.name attribute defined at extension commons.
void	setName(String value, Locale loc)	Generated method - Setter of Format.name attribute defined at extension commons.
void	setValidFor(Collection<ComposedTypeModel> value)	Generated method - Setter of Format.validFor attribute defined at extension commons.

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

CODE

public static final String CODE

Generated constant - Attribute key of Format.code attribute defined at extension commons.

See Also:

• Constant Field Values

NAME

public static final String NAME

Generated constant - Attribute key of Format.name attribute defined at extension commons.

See Also:

• Constant Field Values

INITIAL

public static final String INITIAL

Generated constant - Attribute key of Format.initial attribute defined at extension commons.

See Also:

• Constant Field Values

DOCUMENTTYPE

public static final String DOCUMENTTYPE

Generated constant - Attribute key of Format.documentType attribute defined at extension commons.

See Also:

• Constant Field Values

CHAINED

public static final String CHAINED

Generated constant - Attribute key of Format.chained attribute defined at extension commons.

See Also:

• Constant Field Values

VALIDFOR

public static final String VALIDFOR

Generated constant - Attribute key of Format.validFor attribute defined at extension commons.

See Also:

• Constant Field Values

Constructor Details

FormatModel

public FormatModel()

Generated constructor - Default constructor for generic creation.

FormatModel

public FormatModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

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

FormatModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public FormatModel(String _code,
 DocumentTypeEnum _documentType,
 ItemFormatterModel _initial)

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:

_code - initial attribute declared by type Format at extension commons

_documentType - initial attribute declared by type Format at extension commons

_initial - initial attribute declared by type Format at extension commons

FormatModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public FormatModel(String _code,
 DocumentTypeEnum _documentType,
 ItemFormatterModel _initial,
 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 Format at extension commons

_documentType - initial attribute declared by type Format at extension commons

_initial - initial attribute declared by type Format at extension commons

_owner - initial attribute declared by type Item at extension core

Method Details

getChained

@Accessor(qualifier="chained",
          type=GETTER)
public Collection<MediaFormatterModel> getChained()

Generated method - Getter of the Format.chained attribute defined at extension commons. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the chained

getCode

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

Generated method - Getter of the Format.code attribute defined at extension commons.

Returns:

the code

getDocumentType

@Accessor(qualifier="documentType",
          type=GETTER)
public DocumentTypeEnum getDocumentType()

Generated method - Getter of the Format.documentType attribute defined at extension commons.

Returns:

the documentType

getInitial

@Accessor(qualifier="initial",
          type=GETTER)
public ItemFormatterModel getInitial()

Generated method - Getter of the Format.initial attribute defined at extension commons.

Returns:

the initial

getName

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

Generated method - Getter of the Format.name attribute defined at extension commons.

Returns:

the name

getName

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

Generated method - Getter of the Format.name attribute defined at extension commons.

Parameters:

loc - the value localization key

Returns:

the name

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getValidFor

@Accessor(qualifier="validFor",
          type=GETTER)
public Collection<ComposedTypeModel> getValidFor()

Generated method - Getter of the Format.validFor attribute defined at extension commons. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the validFor

setChained

@Accessor(qualifier="chained",
          type=SETTER)
public void setChained(Collection<MediaFormatterModel> value)

Generated method - Setter of Format.chained attribute defined at extension commons.

Parameters:

value - the chained

setCode

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

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

Parameters:

value - the code

setDocumentType

@Accessor(qualifier="documentType",
          type=SETTER)
public void setDocumentType(DocumentTypeEnum value)

Generated method - Setter of Format.documentType attribute defined at extension commons.

Parameters:

value - the documentType

setInitial

@Accessor(qualifier="initial",
          type=SETTER)
public void setInitial(ItemFormatterModel value)

Generated method - Setter of Format.initial attribute defined at extension commons.

Parameters:

value - the initial

setName

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

Generated method - Setter of Format.name attribute defined at extension commons.

Parameters:

value - the name

setName

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

Generated method - Setter of Format.name attribute defined at extension commons.

Parameters:

value - the name

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setValidFor

@Accessor(qualifier="validFor",
          type=SETTER)
public void setValidFor(Collection<ComposedTypeModel> value)

Generated method - Setter of Format.validFor attribute defined at extension commons.

Parameters:

value - the validFor