IExternalService

Description:
The base interface class for all external services.

Remarks:

Both supported kinds of services - single-server and multi-server - will derive their classes from this interface, albeit indirectly through an interface specific to the particular kind. External services never derive directly from this class - they always have to derive from either ISingleServerService or IMultiServerService, respectivelly.

public interface IExternalService

Public Interface IExternalService

public interface class IExternalService

type IExternalService = interface end

Name	Return Type	Description
M Execute(IExternalServer, Document, IExternalData)	Boolean	Implement this method to execute the given server.
M GetDescription()	String	Implement this method to return a description of the service.
M GetName()	String	Implement this method to return the name of the service.
M GetServiceId()	ExternalServiceId	Implement this method to return the unique Id of the service.
M GetVendorId()	String	Implement this method to return the vendor Id of the service.
M IsValidServer(IExternalServer)	Boolean	Implement this method to check if the given instance represents a valid server of this service.
M OnServersChanged(Document, ServerChangeCause, IList<Guid>)	None	Implement this method to handle situations when servers for the service have changed.
M OnServersDisparity(Document, IList<Guid>)	DisparityResponse	Implements this method to get notified that the servers in a just opened document differ from those currently set as active for the service.