Class FormComponentTypeImpl
- java.lang.Object
-
- nl.gx.webmanager.wcb.foundation.ComponentBase
-
- nl.gx.webmanager.wcb.foundation.ComponentTypeBase
-
- nl.gx.webmanager.wcb.formcomponenttype.impl.FormComponentTypeImpl
-
- All Implemented Interfaces:
DelegatedControllerAware
,Component
,ComponentType
,FormComponentType
public final class FormComponentTypeImpl extends ComponentTypeBase implements FormComponentType
Implementation class for the FormComponentType.- Author:
- bartk
-
-
Field Summary
-
Fields inherited from class nl.gx.webmanager.wcb.foundation.ComponentTypeBase
myJcrService, mySiteworksUtil
-
Fields inherited from class nl.gx.webmanager.wcb.foundation.ComponentBase
myBundleContext, myComponentBundle, myComponentDefinition
-
-
Constructor Summary
Constructors Constructor Description FormComponentTypeImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
checkComponentDefinition(ComponentDefinition componentDefinition)
Check whether a componentDefinition is valid for this componentType.String
getComponentInterface()
Return the component interface this componentType provides.String
getComponentTypeInterface()
Returns the componentType interface this componentType publishes.boolean
installComponent(ComponentDefinition componentDefinition)
Invoked when a component of this component type is installed.boolean
purgeComponent(ComponentDefinition componentDefinition)
Deletes the content created by instances of the component type.boolean
startComponent(Component component)
Starts an installed component.boolean
stopComponent(Component component)
Stops an installed component.boolean
uninstallComponent(ComponentDefinition componentDefinition)
Uninstalls a component.boolean
updateComponent(ComponentDefinition componentDefinition)
Updates a component.-
Methods inherited from class nl.gx.webmanager.wcb.foundation.ComponentTypeBase
componentAdded, componentRemoved, createEditLanguageLabels, createOrUpdatePermissions, createOrUpdatePermissions, createOrUpdateRbacCategory, createPermission, createPermission, createPermissions, createPermissions, deleteEditLanguageLabels, deletePermissions, deletePermissions, deployResources, disableMenuItems, enableComponentForAllWebsites, enableMenuItems, getComponent, getComponentCount, getComponentManager, getComponents, getLocaleIdFromResourceName, getPreferencesService, grantsMenuItemAccess, installComponent, logError, updatePermissionsForPermissionGroups
-
Methods inherited from class nl.gx.webmanager.wcb.foundation.ComponentBase
dependencyAdded, dependencyRemoved, exportContent, extensionAdded, extensionRemoved, getBundleContext, getClassesFromBundle, getClassForName, getComponentBundle, getComponentDefinition, getDelegatedController, getExtensions, getId, getInstance, getInstanceForName, getPrivateNode, getPrivateNode, getTypeId, getWrapperDefinitions, importContent, internalDoStart, internalDoStop, onDestroy, onInit, onInstall, onPurge, onStart, onStop, onUninstall, onUpdate, purgeContent, setBundleContext, setComponentBundle, setComponentBundle, setComponentDefinition, setComponentManager, setDelegatedController
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface nl.gx.webmanager.wcb.ComponentType
deployResources, enableComponentForAllWebsites, getComponent, getComponentCount, getComponents, installComponent
-
-
-
-
Method Detail
-
installComponent
public final boolean installComponent(ComponentDefinition componentDefinition)
Description copied from interface:ComponentType
Invoked when a component of this component type is installed. The component type implements installation logic that is applicable for all components of this type and then invokes onInstall to allow inherited component types to implement additional logic. The onInstall callback method is only invoked if the generic component installation logic was successful.- Specified by:
installComponent
in interfaceComponentType
- Overrides:
installComponent
in classComponentTypeBase
- Parameters:
componentDefinition
- Definition of the component that is to be installed- Returns:
- true if the component was successfully installed
-
updateComponent
public final boolean updateComponent(ComponentDefinition componentDefinition)
Description copied from interface:ComponentType
Updates a component.- Specified by:
updateComponent
in interfaceComponentType
- Overrides:
updateComponent
in classComponentTypeBase
- Parameters:
componentDefinition
- Definition of the component that is to be installed- Returns:
- true if the component was successfully updated
-
purgeComponent
public final boolean purgeComponent(ComponentDefinition componentDefinition)
Description copied from interface:ComponentType
Deletes the content created by instances of the component type.- Specified by:
purgeComponent
in interfaceComponentType
- Overrides:
purgeComponent
in classComponentTypeBase
- Parameters:
componentDefinition
- Definition of the component that is to be purged- Returns:
- true if the component was successfully purged
-
uninstallComponent
public final boolean uninstallComponent(ComponentDefinition componentDefinition)
Description copied from interface:ComponentType
Uninstalls a component. Uninstalling means all files and objects instantiated by the component's definition are deleted.- Specified by:
uninstallComponent
in interfaceComponentType
- Overrides:
uninstallComponent
in classComponentTypeBase
- Parameters:
componentDefinition
- Definition of the component that is to be uninstalled- Returns:
- true if the component was successfully uninstalled
-
checkComponentDefinition
public final boolean checkComponentDefinition(ComponentDefinition componentDefinition)
Description copied from interface:ComponentType
Check whether a componentDefinition is valid for this componentType.- Specified by:
checkComponentDefinition
in interfaceComponentType
- Overrides:
checkComponentDefinition
in classComponentTypeBase
- Parameters:
componentDefinition
- definition of a component that is validated- Returns:
- a boolean value indicating whether the componentDefinition is valid
-
getComponentInterface
public String getComponentInterface()
Description copied from interface:ComponentType
Return the component interface this componentType provides.- Specified by:
getComponentInterface
in interfaceComponentType
- Returns:
- identifier for provided type
-
getComponentTypeInterface
public String getComponentTypeInterface()
Description copied from interface:ComponentType
Returns the componentType interface this componentType publishes.- Specified by:
getComponentTypeInterface
in interfaceComponentType
- Returns:
- identifier for provided type
-
startComponent
public boolean startComponent(Component component)
Description copied from interface:ComponentType
Starts an installed component.- Specified by:
startComponent
in interfaceComponentType
- Specified by:
startComponent
in classComponentTypeBase
- Parameters:
component
- Component that should be started- Returns:
- true if the component was successfully started
-
stopComponent
public boolean stopComponent(Component component)
Description copied from interface:ComponentType
Stops an installed component.- Specified by:
stopComponent
in interfaceComponentType
- Specified by:
stopComponent
in classComponentTypeBase
- Parameters:
component
- Component that should be stopped- Returns:
- true if the component was successfully stopped
-
-