Package cz.vutbr.fit.layout.api
Interface Service
-
- All Known Subinterfaces:
AreaTreeOperator,ArtifactService,Tagger
- All Known Implementing Classes:
BaseArtifactService,BaseOperator,BaseParametrizedOperation,BaseService,OperatorApplicationProvider,OperatorWrapperProvider,VisualBoxTreeProvider
public interface ServiceA generic service with its ID, name and description.- Author:
- burgetr
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetCategory()A category that allows to group similar services.StringgetDescription()Obtains a longer description of the service.StringgetId()Obtains a unique ID of the serviceStringgetName()Obtains a descriptive name of the service that may be presented to the user.voidsetServiceManager(ServiceManager manager)Assigns a service manager to the service.
-
-
-
Method Detail
-
getId
String getId()
Obtains a unique ID of the service
-
getName
String getName()
Obtains a descriptive name of the service that may be presented to the user.- Returns:
- the operator name
-
getDescription
String getDescription()
Obtains a longer description of the service.- Returns:
- the description
-
getCategory
String getCategory()
A category that allows to group similar services.- Returns:
- Category name or
nullwhen no category is assigned.
-
setServiceManager
void setServiceManager(ServiceManager manager)
Assigns a service manager to the service. This is typically called by the service manager itself during the service initialization.- Parameters:
manager- The service manager to be set.
-
-