de.hybris.platform.patches

Interface Patch

All Known Subinterfaces:

DemoPatch, SimpleDemoPatch

All Known Implementing Classes:

AbstractDemoPatch, AbstractPatch, MajorErrorPatch, MinorErrorPatch, Patch1x0, Patch2x0, Patch2x1

public interface Patch

Interface for all patches that needs to be updated on running system.

Method Summary

Modifier and Type	Method and Description
default void	createEssentialData() Executes patch during project essential data step
void	createProjectData(StructureState structureState) Execute Patch with given structureState.
java.lang.String	getPatchDescription() Returns Patch description.
java.lang.String	getPatchId() Returns unique patch id (e.g PD_V_1.0.1).
java.lang.String	getPatchName() Returns Patch name.
Release	getRelease() Gets release that patch is part of.
StructureState	getStructureState() Gets StructureState from this patch

Method Detail

createProjectData

void createProjectData(StructureState structureState)

Execute Patch with given structureState.

Parameters:

structureState - that should be used for creating project data

getPatchId

java.lang.String getPatchId()

Returns unique patch id (e.g PD_V_1.0.1).

Returns:

patch id

getPatchName

java.lang.String getPatchName()

Returns Patch name.

Returns:

patch name (visible in admin console)

getPatchDescription

java.lang.String getPatchDescription()

Returns Patch description.

Returns:

description what this patch is about

getRelease

Release getRelease()

Gets release that patch is part of.

Returns:

release that patch is part of

getStructureState

StructureState getStructureState()

Gets StructureState from this patch

Returns:

StructureState from this patch

createEssentialData

default void createEssentialData()

Executes patch during project essential data step