com.modeliosoft.modelio.cms.api.files

Interface IFileChangesRecorder

public interface IFileChangesRecorder

Service to record changes on external files to be versioned and associated to CMS nodes.

All recorded changes will then be automatically added to the next SVN operation run on the associated CMS node (committed with the model, or reverted with it).

This service may be used by code generation modules to add and manage generated files to version. The module should use this service when it detects a file must be regenerated, has moved or will be deleted.

Since:

3.5

Author:

cmarin

Method Summary

Modifier and Type	Method and Description
java.io.File	getRecordedFile(MObject related, java.lang.String key) Look for an existing recorded file path.
void	recordDeletedFile(MObject related, java.lang.String key, java.io.File file) Record a file deletion.
java.io.File	recordFile(MObject related, java.lang.String key, java.io.File file) Record a file to be associated with the CMS node SVN operations.
java.io.File	recordFileMove(MObject related, java.lang.String key, java.io.File oldFile, java.io.File newFile) Record a moved/renamed file.

Method Detail

recordFile

java.io.File recordFile(MObject related,
                        java.lang.String key,
                        java.io.File file)

Record a file to be associated with the CMS node SVN operations.

Parameters:

related - the CMS node

key - : a key to identify the file among all files associated to the element.

file - the associated file path

Returns:

the previously recorded file for the same reference and key. null if first record.

recordDeletedFile

void recordDeletedFile(MObject related,
                       java.lang.String key,
                       java.io.File file)

Record a file deletion.

file parameter is optional

Parameters:

related - the related CMS node

key - a key to identify the file among all files associated to the element.

file - the deleted file.

getRecordedFile

java.io.File getRecordedFile(MObject related,
                             java.lang.String key)

Look for an existing recorded file path.

Looks into recordFile(MObject, String, File) and recordFileMove(MObject, String, File, File) calls.

Parameters:

related - the related CMS node

key - a key to identify the file among all files associated to the element.

Returns:

the recorded file path or null.

recordFileMove

java.io.File recordFileMove(MObject related,
                            java.lang.String key,
                            java.io.File oldFile,
                            java.io.File newFile)

Record a moved/renamed file.

Parameters:

related - the CMS node

key - a key to identify the file among all files associated to the element.

oldFile - the previous file path.

newFile - the new file path.

Returns:

the previous recorded file name