Package com.groiss.store

Interface Exportable

All Superinterfaces:

KeyValuePair<String,String>, Persistent, Serializable

All Known Implementing Classes:

CheckedPersistent, DirectoryServer, EvaluationResult, ExportablePersistentObject, Recipient

public interface Exportable
extends Persistent

Classes that want to provide the possibility of being exported/imported by the import/export functionality of @enterprise must implement this interface.

Field Summary

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method	Description
default void	beforeImport(Map<String,Persistent> values)	This method is called by the importer after the object is filled with data.
default List<Field>	exportFields()	Here a class can return the names of fields which should be exported during an @enterprise export.
default List<Exportable>	getAdditionalObjects(boolean isReference)	return a list of objects that must be exported with this object (after it).
default List<Exportable>	getRequiredObjects(boolean isReference)	This method is called by the exporter before an object is exported.
default List<Exportable>	getRequiredReferences()	Returns a list of references that cannot be found in the persistent fields.

Methods inherited from interface com.groiss.store.Persistent

afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, toListString

Method Details

exportFields

default List<Field> exportFields()
                          throws Exception

Here a class can return the names of fields which should be exported during an @enterprise export.

Returns:

A list containing the fields for export.

Throws:

Exception

getRequiredObjects

default List<Exportable> getRequiredObjects(boolean isReference)
                                     throws Exception

This method is called by the exporter before an object is exported. The object can add required objects.

Parameters:

isReference - is this a reference to an exported object

Returns:

preReqObjects List containing required objects. Required objects must be Persistent objects implementing the Exportable interface.

Throws:

Exception

getRequiredReferences

default List<Exportable> getRequiredReferences()
                                        throws Exception

Returns a list of references that cannot be found in the persistent fields.

Returns:

a list of exportable

Throws:

Exception

getAdditionalObjects

default List<Exportable> getAdditionalObjects(boolean isReference)
                                       throws Exception

return a list of objects that must be exported with this object (after it).

Parameters:

isReference - is this a reference to an exported object

Throws:

Exception

beforeImport

default void beforeImport(Map<String,Persistent> values)

This method is called by the importer after the object is filled with data. The object can change itself

Parameters:

values - contains a map of the object identifier (classname:oid) to the new objects.