org.pentaho.platform.api.engine
Interface IServiceConfig

All Known Implementing Classes:

ServiceConfig

public interface IServiceConfig

The configuration spec for a platform managed service

Author:

aphillips

Method Summary

java.lang.String	getDescription() Returns the localized title for this web service.
java.util.Collection<java.lang.Class<?>>	getExtraClasses()
java.lang.String	getId() Returns the unique id of this web service.
java.lang.Class<?>	getServiceClass() Returns the web service bean class
java.lang.String	getServiceType()
java.lang.String	getTitle() Returns the localized title for this web service.
boolean	isEnabled() Returns the enabled state of this service

Method Detail

getId

java.lang.String getId()

Returns the unique id of this web service. This should not be localized

Returns:

a unique id for this web service

isEnabled

boolean isEnabled()

Returns the enabled state of this service

Returns:

Current enable/disable state

getExtraClasses

java.util.Collection<java.lang.Class<?>> getExtraClasses()

getServiceClass

java.lang.Class<?> getServiceClass()

Returns the web service bean class

Returns:

bean class or id by which the class can be looked up

getTitle

java.lang.String getTitle()

Returns the localized title for this web service. This is shown on the services list page. Defaults to service id if not set.

Returns:

natural language name for the service

getDescription

java.lang.String getDescription()

Returns the localized title for this web service. This is shown on the services list page.

Returns:

Description

getServiceType

java.lang.String getServiceType()