public interface ExtensionPointType extends java.lang.Comparable<ExtensionPointType>, java.io.Serializable
Modifier and Type | Method and Description |
---|---|
void |
addRecordInstanceActions(org.apache.wicket.markup.repeater.RepeatingView view,
IConfigPage configPage,
ConfigPanel parentPanel,
PersistentRecord mainRecord,
PersistentRecord subRecord)
Provides the extension point type an opportunity to insert custom record action links.
|
java.lang.String |
getDescription()
A resource key for a description of what makes this type unique.
|
java.lang.String |
getName()
A resource key for a human-readable name for this type.
|
ReferenceField<?> |
getSettingsRecordForeignKey()
If a settings record type is defined, return the foreign key field that references the main record type
|
RecordMeta<? extends PersistentRecord> |
getSettingsRecordType()
Defines a PersistentRecord type that will be used to add type-specific properties.
|
java.lang.String |
getTypeId()
A string that uniquely identifies this profile type.
|
boolean |
isEnabled()
A flag that indicates whether this type is currently enabled (true) or deprecated (false).
|
ConfigPanel |
newRecordConfigPanel(PersistentRecord[] records,
IConfigPage configPage,
ConfigPanel parentPanel)
Creates a new ConfigPanel that will be used when the user creates a new record of this extension point type.
|
void |
onRecordDestroyed(PersistenceSession session,
PersistentRecord mainRecord,
PersistentRecord subRecord)
Will be called when a profile of this extension point type is deleted, providing an opportunity to do any related
cleanup.
|
java.lang.String getTypeId()
java.lang.String getName()
java.lang.String getDescription()
boolean isEnabled()
RecordMeta<? extends PersistentRecord> getSettingsRecordType()
ReferenceField<?> getSettingsRecordForeignKey()
ConfigPanel newRecordConfigPanel(PersistentRecord[] records, IConfigPage configPage, ConfigPanel parentPanel)
records
- Length will be 1 or 2. Index 0 will always contain the master record for the extension point manager.
Index 1 will contain the extension-point specific sub-record (if applicable)configPage
- The parent IConfigPage that can be used to navigate to new config panels.parentPanel
- The parent RecordActionTable that should be returned to when the configuration is complete.void addRecordInstanceActions(org.apache.wicket.markup.repeater.RepeatingView view, IConfigPage configPage, ConfigPanel parentPanel, PersistentRecord mainRecord, PersistentRecord subRecord)
Provides the extension point type an opportunity to insert custom record action links. Will appear between "edit" and "delete".
Note: This method changed in 7.9. Previously, the method was called "getRecordInstanceActions", and returned a list of actions. Now, it must add its actions directly to the provided view.
view
- The RepeatingView that the action will be added to. Use
"view.newChildId()" to get the id for your action, and then add the action to the view.configPage
- The IConfigPage that will hold the ConfigPanel returned by the action when clicked.parentPanel
- The ConfigPanel that the link will live on. Used to navigate back, if necessary.mainRecord
- The main profile record.subRecord
- The sub-settings profile record (if any).void onRecordDestroyed(PersistenceSession session, PersistentRecord mainRecord, PersistentRecord subRecord)
session
- mainRecord
- subRecord
-