Package com.idmedia.translationstudio.api.firstspirit

Interface IClientWorkflowAPI

public interface IClientWorkflowAPI

Main API. Can be obtained simply by

TranslationStudio.get(@NotNull GuiScriptContext pContext);

Author:

Phillip Austerfield

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IClientWorkflowAPI.FormFactory	Form Factory which uses the workflow context (cannot be manipulated manually)
static interface	IClientWorkflowAPI.RegisterOperationFactory	Operation Factory

Method Summary

Modifier and Type	Method	Description
ITranslationRequestFormSpecific	getGenericTranslationRequestForm(de.espirit.firstspirit.access.project.Project pProject)	Create a generic request form
ITranslationRequestFormSpecificFull	getGenericTranslationRequestFormComplete(de.espirit.firstspirit.access.project.Project pProject)	Create a generic request form
IClientWorkflowAPI.FormFactory	requestFormFactory()	Request the Form Factory to use forms in scripts
IClientWorkflowAPI.RegisterOperationFactory	requestRegisterOperationFactory()	Request a registration operation factory to submit translation requests to TranslationStudio
de.espirit.firstspirit.access.store.contentstore.Content2	selectContent2FromScriptForm()
void	showMessage(String sMessage)	Display a message
void	showMessage(String sMessage, String sTitle)	Display a Message in a message box

Method Detail

showMessage

void showMessage(String sMessage,
                 String sTitle)

Display a Message in a message box

Parameters:

sMessage - Message

sTitle - Title

showMessage

void showMessage(String sMessage)

Display a message

Parameters:

sMessage - Message

requestFormFactory

IClientWorkflowAPI.FormFactory requestFormFactory()

Request the Form Factory to use forms in scripts

Returns:

Form Factory Instance

selectContent2FromScriptForm

@Nullable
de.espirit.firstspirit.access.store.contentstore.Content2 selectContent2FromScriptForm()

requestRegisterOperationFactory

IClientWorkflowAPI.RegisterOperationFactory requestRegisterOperationFactory()

Request a registration operation factory to submit translation requests to TranslationStudio

Returns:

getGenericTranslationRequestForm

@NotNull
ITranslationRequestFormSpecific getGenericTranslationRequestForm(@NotNull
                                                                 de.espirit.firstspirit.access.project.Project pProject)

Create a generic request form

Parameters:

pProject -

Returns:

getGenericTranslationRequestFormComplete

@NotNull
ITranslationRequestFormSpecificFull getGenericTranslationRequestFormComplete(@NotNull
                                                                             de.espirit.firstspirit.access.project.Project pProject)

Create a generic request form

Parameters:

pProject -

Returns: