cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule Class Reference

Class provides connection of Storyscope Interface module with server. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule:

Collaboration diagram for cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule:

Public Member Functions
void	StoryscopeInterfaceModule ()
String	processRequestBeforePersist (RequestInfo requestInfo)
String	processRequestAfterPersist (RequestInfo requestInfo, boolean persistFailed)
String	messagesFromFlier (Flier flier, EditorSession session)
String	getModuleName (int lang)
String	getModuleDescription (int lang)

Detailed Description

Class provides connection of Storyscope Interface module with server.

Class implements AnotServerModule calss for prupose of Storyscope Interface module.

Author

Martin Petr (xpetrm05)

Definition at line 33 of file StoryscopeInterfaceModule.java.

Constructor & Destructor Documentation

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.StoryscopeInterfaceModule

(

)

Constructor

Definition at line 38 of file StoryscopeInterfaceModule.java.

Member Function Documentation

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.getModuleDescription

(

int

lang

)

Returns description of this module. It will be part of information about server functions.

Parameters

lang	Requested language of description

Returns

Description of this module

Implements cz.vutbr.fit.knot.annotations.comet.AnnotServerModule.

Definition at line 106 of file StoryscopeInterfaceModule.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.getModuleName

(

int

lang

)

Returns name of this module. Name will be included in XML element attribute so usable characters are restricted.

Parameters

lang	Requested language of name

Returns

Name of this module

Implements cz.vutbr.fit.knot.annotations.comet.AnnotServerModule.

Definition at line 94 of file StoryscopeInterfaceModule.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.messagesFromFlier	(	Flier	flier,
		EditorSession	session
	)

This method is called for each sleeping comet handler when he receives flier (part of informations about this or another client request).

Parameters

flier	Flier, which has been sent to all comet handlers.
session	Session associated with comet handler.

Returns

If this handler hasn't react to this flier (not interested) return null, else return messages for client in single string.

Implements cz.vutbr.fit.knot.annotations.comet.AnnotServerModule.

Definition at line 82 of file StoryscopeInterfaceModule.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.processRequestAfterPersist	(	RequestInfo	requestInfo,
		boolean	persistFailed
	)

This method is called when client sent message, these message has been processed and changes in entities are persisted. Composed response is sent to client after calling this method from all modules.

Parameters

requestInfo	Informations about client request
persistFailed	True if changes not persisted, false otherwise.

Returns

String with messages for client or empty string

Implements cz.vutbr.fit.knot.annotations.comet.AnnotServerModule.

Definition at line 65 of file StoryscopeInterfaceModule.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryscopeInterfaceModule.processRequestBeforePersist

(

RequestInfo

requestInfo

)

This method is called when client sent message and these message has been processed. Changes in types, annotations and in other entities are persisted after calling this method from all modules.

Parameters

requestInfo

Informations about client request

Returns

String with messages for client or empty string

Implements cz.vutbr.fit.knot.annotations.comet.AnnotServerModule.

Definition at line 50 of file StoryscopeInterfaceModule.java.

---

The documentation for this class was generated from the following file:

• src/java/cz/vutbr/fit/knot/annotations/modules/StoryscopeInterface/StoryscopeInterfaceModule.java