Package org.pentaho.platform.api.engine
Interface IServiceConfig
-
public interface IServiceConfig
The configuration spec for a platform managed service- Author:
- aphillips
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDescription()
Returns the localized title for this web service.Collection<Class<?>>
getExtraClasses()
String
getId()
Returns the unique id of this web service.Class<?>
getServiceClass()
Returns the web service bean classString
getServiceType()
String
getTitle()
Returns the localized title for this web service.boolean
isEnabled()
Returns the enabled state of this service
-
-
-
Method Detail
-
getId
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
Collection<Class<?>> getExtraClasses()
-
getServiceClass
Class<?> getServiceClass()
Returns the web service bean class- Returns:
- bean class or id by which the class can be looked up
-
getTitle
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
String getDescription()
Returns the localized title for this web service. This is shown on the services list page.- Returns:
- Description
-
getServiceType
String getServiceType()
-
-