Package org.rogatio.circlead.control.synchronizer

Interface ISynchronizer

All Known Implementing Classes:

AtlassianSynchronizer, DefaultSynchronizer, FileSynchronizer

public interface ISynchronizer

The Interface of ISynchronizer.

Author:

Matthias Wegner

Method Summary

Modifier and Type	Method	Description
SynchronizerResult	add(IWorkitem workitem)	Adds workitem to synchronized system.
SynchronizerResult	add(IReport report)	Adds the report to synchronized system.
java.lang.String	delete(IWorkitem workitem)	Delete workitem in system which is connected through synchronizer.
IWorkitem	get(java.lang.String id)	Gets the workitem of named id.
java.lang.String	getIdPattern()	Gets the pattern for valid id as regular expression which is allowed for synchronized system.
ISynchronizerRendererEngine	getRenderer()	Gets the renderer which is used to render workitems and reports for target system.
java.util.List<java.lang.String>	loadIndex(WorkitemType workitemType)	Load index for all workitems which where found by synchronizer of named workitem-type.
SynchronizerResult	update(IWorkitem workitem)	Update workitem on synchronized system.
SynchronizerResult	update(IReport report)	Update report on synchronized system.
void	writeIndex()	Write index.

Method Detail

loadIndex

java.util.List<java.lang.String> loadIndex(WorkitemType workitemType)

Load index for all workitems which where found by synchronizer of named workitem-type.

Parameters:

workitemType - the workitem type

Returns:

the list of query results of found items

writeIndex

void writeIndex()

Write index.

get

IWorkitem get(java.lang.String id)
       throws SynchronizerException

Gets the workitem of named id.

Parameters:

id - the workitem of specific synchronizer. Every synchronizer could have own id-logic

Returns:

the loaded workitem

Throws:

SynchronizerException - the synchronizer exception

delete

java.lang.String delete(IWorkitem workitem)
                 throws SynchronizerException

Delete workitem in system which is connected through synchronizer.

Parameters:

workitem - the workitem to delete

Returns:

the result and response of deletion

Throws:

SynchronizerException - the synchronizer exception

add

SynchronizerResult add(IWorkitem workitem)
                throws SynchronizerException

Adds workitem to synchronized system.

Parameters:

workitem - the workitem to add

Returns:

the synchronizer result of adding item

Throws:

SynchronizerException - the synchronizer exception

add

SynchronizerResult add(IReport report)
                throws SynchronizerException

Adds the report to synchronized system.

Parameters:

report - the report to add

Returns:

the synchronizer result

Throws:

SynchronizerException - the synchronizer exception

update

SynchronizerResult update(IReport report)
                   throws SynchronizerException

Update report on synchronized system.

Parameters:

report - the report to update

Returns:

the synchronizer result for update

Throws:

SynchronizerException - the synchronizer exception

update

SynchronizerResult update(IWorkitem workitem)
                   throws SynchronizerException

Update workitem on synchronized system.

Parameters:

workitem - the workitem to update

Returns:

the synchronizer result

Throws:

SynchronizerException - the synchronizer exception

getIdPattern

java.lang.String getIdPattern()

Gets the pattern for valid id as regular expression which is allowed for synchronized system.

Returns:

the id pattern

getRenderer

ISynchronizerRendererEngine getRenderer()

Gets the renderer which is used to render workitems and reports for target system.

Returns:

the renderer for the synchronizer