IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.impord
Interface IAuxiliaryImportServices


public interface IAuxiliaryImportServices

The IAuxiliaryImportServices Interface maintains a model of all auxiliary services required to perform an import operation. Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability.


Field Summary
static String IMPORT_LOG
          Predefined Service Identifier to reference the import log instance from a service model.
static String IMPORT_LOG_SERVICE
          Predefined Service Identifier to reference the import log service from this model
static String IMPORT_ROLLBACK_MANAGER
          Predefined Service Identifier to reference the import rollback manager from this model
 
Method Summary
 IImportLogService getImportLogService()
          Retrieves an instance of the import logging service - IImportLogService
 IRollbackManager getRollbackManager()
          Retrieves an instance of the import action manager - IImportActionManager
 Object getService(String serviceID)
          Retrieve the service associated with the given serviceID.
 void registerService(String serviceID, Object service)
          Associate a service instance with a serviceID.
 void registerService(String serviceID, Object service, IAuxiliaryImportServiceValidator validator)
          Associate a service instance with a serviceID and a validator.
 IStatus validateService(String serviceID)
          Validate the service registered with the model for the given serviceID.
 

Field Detail

IMPORT_ROLLBACK_MANAGER

public static final String IMPORT_ROLLBACK_MANAGER
Predefined Service Identifier to reference the import rollback manager from this model

See Also:
Constant Field Values

IMPORT_LOG_SERVICE

public static final String IMPORT_LOG_SERVICE
Predefined Service Identifier to reference the import log service from this model

See Also:
Constant Field Values

IMPORT_LOG

public static final String IMPORT_LOG
Predefined Service Identifier to reference the import log instance from a service model.

See Also:
Constant Field Values
Method Detail

getService

public Object getService(String serviceID)
Retrieve the service associated with the given serviceID.

Parameters:
serviceID - is the identifier associated with a service registered with this model.
Returns:
the actual service object associated with the given serviceID or null if no association can be found.
Throws:
IllegalArgumentException - if serviceID is null.

registerService

public void registerService(String serviceID,
                            Object service)
Associate a service instance with a serviceID.

Parameters:
serviceID - is the given identifier for the service instance to be registered with.
service - is the instance of the service to be associated with the given serviceID.
Throws:
IllegalArgumentException - if serviceID is null.

registerService

public void registerService(String serviceID,
                            Object service,
                            IAuxiliaryImportServiceValidator validator)
Associate a service instance with a serviceID and a validator.

Parameters:
serviceID - is the given identifier for the service instance to be registered with.
service - is the instance of the service to be associated with the given serviceID.
validator - is the callback validator associated with the serviceID. The validator is invoked whenever validateService for this serviceID is invoked. If this argument is null it is equivalent to invoking registerService method.
Throws:
IllegalArgumentException - if serviceID is null.

validateService

public IStatus validateService(String serviceID)
Validate the service registered with the model for the given serviceID.

Parameters:
serviceID - is the identifier associated with a service registered with this model.
Returns:
status of the operation.
Throws:
IllegalArgumentException - if serviceID parameter is null.

getRollbackManager

public IRollbackManager getRollbackManager()
Retrieves an instance of the import action manager - IImportActionManager

Returns:
the import action manager

getImportLogService

public IImportLogService getImportLogService()
Retrieves an instance of the import logging service - IImportLogService

Returns:
the import logging service

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.