Package com.communardo.confluence.metadata.fieldtype

Interface DefaultValueSupport

All Superinterfaces:

Transferable

public interface DefaultValueSupport
extends Transferable

Interface for all types to make them able to handle defaultvalues

Method Summary

Modifier and Type	Method	Description
void	deleteDefaultValue(MetadataSet metadataSet, MetadataField metadataField)	Delete a default value of a field for a given set
String	exportDefaultValueConfiguration(MetadataSet metadataSet, MetadataField metadataField)	export the default value defined for a field of a specific type in a set
void	importDefaultValueConfiguration(MetadataSet metadataSet, MetadataField metadataField, String exportedConfiguration)	import the default value defined for a field of a specific type in a set
DataObject	loadDefaultValue(MetadataSet metadataSet, MetadataField metadataField)	Load the defaultvalue of a field for a given set.
String	renderDefaultValueEdit(MetadataSet metadataSet, MetadataField metadataField, DataObject object)	render the edit representation of the default value.
void	saveDefaultValue(MetadataSet metadataSet, MetadataField metadataField, DataObject dataObject)	Save a dataobject representing the default value
void	saveDefaultValue(Map<String,String[]> parameters, MetadataSet metadataSet, MetadataField metadataField)	save a default value for a given set

Methods inherited from interface com.communardo.confluence.metadata.fieldtype.Transferable

copyDataObject, createDataObject, exportDataObject, exportTypeConfiguration, importTypeConfiguration

Method Detail

loadDefaultValue

DataObject loadDefaultValue(MetadataSet metadataSet,
                            MetadataField metadataField)

Load the defaultvalue of a field for a given set.

Parameters:

metadataSet -

metadataField - The Metadata field in the set

Returns:

the dataobject representation for the default value

saveDefaultValue

void saveDefaultValue(Map<String,String[]> parameters,
                      MetadataSet metadataSet,
                      MetadataField metadataField)

save a default value for a given set

Parameters:

parameters - the parametermap needed to create a dataObject internally

metadataSet -

metadataField - The Metadata field in the set

saveDefaultValue

void saveDefaultValue(MetadataSet metadataSet,
                      MetadataField metadataField,
                      DataObject dataObject)

Save a dataobject representing the default value

Parameters:

metadataSet - The Metadata set where a field is assigned

metadataField - The Metadata field in the set

dataObject -

deleteDefaultValue

void deleteDefaultValue(MetadataSet metadataSet,
                        MetadataField metadataField)

Delete a default value of a field for a given set

Parameters:

metadataSet - -the given metadata set

renderDefaultValueEdit

String renderDefaultValueEdit(MetadataSet metadataSet,
                              MetadataField metadataField,
                              DataObject object)

render the edit representation of the default value. This method is used during administration of the default values inside the set administration

Parameters:

metadataSet - The Metadata set where a field is assigned

metadataField - The Metadata field in the set

object -

Returns:

html which represents the default value dataobject

exportDefaultValueConfiguration

String exportDefaultValueConfiguration(MetadataSet metadataSet,
                                       MetadataField metadataField)
                                throws MetadataExportException

export the default value defined for a field of a specific type in a set

Parameters:

metadataSet - The Metadata set where a field is assigned

metadataField - The Metadata field in the set

Returns:

A string which gets written to the export file. This should then be reimportable via the import method

Throws:

MetadataExportException - in case the import failed

importDefaultValueConfiguration

void importDefaultValueConfiguration(MetadataSet metadataSet,
                                     MetadataField metadataField,
                                     String exportedConfiguration)
                              throws MetadataImportException

import the default value defined for a field of a specific type in a set

Parameters:

metadataSet - The Metadata set where a field is assigned

metadataField - The Metadata field in the set

exportedConfiguration - the string from the export representing the default value configuration for a specific field in a set

Throws:

MetadataImportException - in case the import failed