Package de.elo.ix.client.serverevents
Class IXServerEventsHandler
java.lang.Object
de.elo.ix.client.serverevents.IXServerEventsHandler
- All Implemented Interfaces:
byps.Remote
,IXServerEvents
,de.elo.utils.net.Remote
,java.rmi.Remote
public abstract class IXServerEventsHandler extends java.lang.Object implements IXServerEvents
This class helps to implement the IXServerEvents interface.
Your project should inherit from this class and implement
the IXServerEvents methods. Each implmented method has
to be added to the collection implementedMethods:
implementedMethods["onAfterCheckinSord"] = true;
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
appName
protected java.lang.String
appVersion
protected IXConnectionMapEventHandler
connMap
protected java.util.HashSet<java.lang.String>
implementedMethods
-
Constructor Summary
Constructors Constructor Description IXServerEventsHandler(java.lang.String appName, java.lang.String appVersion)
-
Method Summary
Modifier and Type Method Description java.lang.String
getAppInfo(IXServerEventsContext ec)
This mandatory method returns information about the application that implements the interface.boolean
hasMethod(IXServerEventsContext ec, java.lang.String methodName)
This mandatory method tests, wether an interace method is implemented.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface de.elo.ix.client.IXServerEvents
executeRegisteredFunction, executeRegisteredFunctionString, getUserNames, onAfterCheckinActivity, onAfterCheckinDocEnd, onAfterCheckinMap, onAfterCheckinNotes, onAfterCheckinReminder, onAfterCheckinSord, onAfterCheckinUsers, onAfterDelegateWorkflowNode, onAfterDeleteMap, onAfterDeleteSord, onAfterEndEditWorkFlowNode, onAfterLogin, onAfterRefSord, onAfterStartWorkFlow, onBeforeCheckinActivity, onBeforeCheckinDocEnd, onBeforeCheckinMap, onBeforeCheckinNotes, onBeforeCheckinSord, onBeforeCheckinUsers, onBeforeDelegateWorkflowNode, onBeforeDeleteMap, onBeforeDeleteSord, onBeforeFindSords, onBeforeFindSordsInternalSQL, onBeforeLogin, onBeforeRefSord, onBeforeStartWorkFlow, onBeforeTakeWorkFlowNode, onCheckSordAccess, onCreateDoc, onCreateSord, onFileUploadBuildResponse, onFindClose, onFindSordsResult, onInheritKeywording, onReadSord, onSendFeedToISearch, onSendSordToISearch
-
Field Details
-
appName
protected java.lang.String appName -
appVersion
protected java.lang.String appVersion -
connMap
-
implementedMethods
protected java.util.HashSet<java.lang.String> implementedMethods
-
-
Constructor Details
-
IXServerEventsHandler
public IXServerEventsHandler(java.lang.String appName, java.lang.String appVersion)
-
-
Method Details
-
getAppInfo
Description copied from interface:IXServerEvents
This mandatory method returns information about the application that implements the interface. It should return the application name and version and the implementors name. The returned String is printed into the log file and is added to error messages. This method is mandatory.- Specified by:
getAppInfo
in interfaceIXServerEvents
- Parameters:
ec
- Execution context.- Returns:
- String
- Throws:
byps.RemoteException
- Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.- See Also:
IXServerEvents.getAppInfo(IXServerEventsContext)
-
hasMethod
public boolean hasMethod(IXServerEventsContext ec, java.lang.String methodName) throws byps.RemoteExceptionDescription copied from interface:IXServerEvents
This mandatory method tests, wether an interace method is implemented. The Indexserver calls this function for each method, before the method is called the first time.- Specified by:
hasMethod
in interfaceIXServerEvents
- Parameters:
ec
- Execution context.methodName
- Method name.- Returns:
- true, if the method is implemented.
- Throws:
byps.RemoteException
- Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.- See Also:
IXServerEvents.hasMethod(IXServerEventsContext, String)
-