com.ptc.sce

Interface E3CServices

All Known Implementing Classes:

StandardE3CServices

public interface E3CServices

Interface class for accessing E3C Services. See StandardE3CServices for implementation details

Method Summary

Modifier and Type	Method and Description
com.ptc.sc.sce.api.services.DocumentService	getDocumentService() Gets E3C implementation class for DocumentService.
com.ptc.sc.sce.api.services.GeneralService	getGeneralService() Gets E3C implementation class for GeneralService
com.ptc.sc.sce.api.services.NavTreeService	getNavTreeService() Gets E3C implementation class for NavTreeService.
com.ptc.sc.sce.api.services.SearchService	getSearchService() Gets E3C implementation class for SearchService
<X> X	getServiceFromFactory(java.lang.String key) Returns an instance of the E3C service associated with the supplied key.
void	setSimulateServerDown(boolean simulate) This method should be used for integration tests only.

Method Detail

setSimulateServerDown

void setSimulateServerDown(boolean simulate)

This method should be used for integration tests only. If value is true, then all calls to .getServiceFromFactory() will result in an SCEException with a nested org.omg.CORBA.COMM_FAILURE exception.

Parameters:

simulate - true to throw exceptions, false to resume normal operation.

getNavTreeService

com.ptc.sc.sce.api.services.NavTreeService getNavTreeService()
                                                      throws com.ptc.sc.sce.api.SCEException

Gets E3C implementation class for NavTreeService.

Returns:

the response fromNavItem ServiceFactory.getService() with the NavTreeService class

Throws:

com.ptc.sc.sce.api.SCEException

getDocumentService

com.ptc.sc.sce.api.services.DocumentService getDocumentService()
                                                        throws com.ptc.sc.sce.api.SCEException

Gets E3C implementation class for DocumentService.

Returns:

the response fromNavItem ServiceFactory.getService() with the DocumentService class

Throws:

com.ptc.sc.sce.api.SCEException

getSearchService

com.ptc.sc.sce.api.services.SearchService getSearchService()
                                                    throws com.ptc.sc.sce.api.SCEException

Gets E3C implementation class for SearchService

Returns:

the response fromNavItem ServiceFactory.getService() with the SearchService class

Throws:

com.ptc.sc.sce.api.SCEException

getGeneralService

com.ptc.sc.sce.api.services.GeneralService getGeneralService()
                                                      throws com.ptc.sc.sce.api.SCEException

Gets E3C implementation class for GeneralService

Returns:

the response fromNavItem ServiceFactory.getService() with the GeneralService class

Throws:

com.ptc.sc.sce.api.SCEException

getServiceFromFactory

<X> X getServiceFromFactory(java.lang.String key)
                     throws com.ptc.sc.sce.api.SCEException

Returns an instance of the E3C service associated with the supplied key.

Type Parameters:

X - The Interface for the service to get.

Parameters:

key - The key of the class to get

Returns:

An instance of the requested interface associated with the entered key.

Throws:

com.ptc.sc.sce.api.SCEException - If the E3C runtime is unavailable.