org.bimserver.plugins.services

Class BimBotAbstractService

java.lang.Object

org.bimserver.plugins.services.ServicePlugin

org.bimserver.plugins.services.AbstractService

org.bimserver.plugins.services.BimBotAbstractService

All Implemented Interfaces:

BimBotsServiceInterface, Plugin

public abstract class BimBotAbstractService
extends AbstractService
implements BimBotsServiceInterface

Nested Class Summary

Nested classes/interfaces inherited from class org.bimserver.plugins.services.AbstractService

AbstractService.ProgressType, AbstractService.RunningService

Constructor Summary

Constructors

Constructor and Description
BimBotAbstractService()

Method Summary

Modifier and Type	Method and Description
void	addRequiredRights(ServiceDescriptor serviceDescriptor)
Set<String>	getAvailableInputs()
Set<String>	getAvailableOutputs()
abstract String	getOutputSchema()
void	newRevision(AbstractService.RunningService runningService, BimServerClientInterface bimServerClientInterface, long poid, long roid, String userToken, long soid, SObjectType settings) This method gets called when there is a new revision

Methods inherited from class org.bimserver.plugins.services.AbstractService

getPluginContext, getProgressType, getSettingsDefinition, init, register, unregister

Methods inherited from class org.bimserver.plugins.services.ServicePlugin

getLocalBimServerClientInterface, getPluginType, getServiceInterface, registerNewExtendedDataOnProjectHandler, registerNewExtendedDataOnRevisionHandler, registerNewRevisionHandler, unregisterNewRevisionHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bimserver.bimbots.BimBotsServiceInterface

runBimBot

Constructor Detail

BimBotAbstractService

public BimBotAbstractService()

Method Detail

newRevision

public void newRevision(AbstractService.RunningService runningService,
                        BimServerClientInterface bimServerClientInterface,
                        long poid,
                        long roid,
                        String userToken,
                        long soid,
                        SObjectType settings)
                 throws Exception

Description copied from class: AbstractService

This method gets called when there is a new revision

Specified by:

newRevision in class AbstractService

Parameters:

runningService - A reference to the RunningService, you can use it to update the progress if you know it

bimServerClientInterface - A client with the proper authorization on this or a remote BIMserver to fetch the revision, and write extended data to

poid - ProjectID of the project

roid - RevisionID of the new revision

userToken - Optional token, unused at the moment

soid - ServiceID

settings - Optional settings a user might have given in the InternalService settings

Throws:

Exception

addRequiredRights

public void addRequiredRights(ServiceDescriptor serviceDescriptor)

Specified by:

addRequiredRights in class AbstractService

getAvailableOutputs

public Set<String> getAvailableOutputs()
                                throws BimBotsException

Specified by:

getAvailableOutputs in interface BimBotsServiceInterface

Throws:

BimBotsException

getAvailableInputs

public Set<String> getAvailableInputs()
                               throws BimBotsException

Specified by:

getAvailableInputs in interface BimBotsServiceInterface

Throws:

BimBotsException

getOutputSchema

public abstract String getOutputSchema()