lumis.portal.serviceinstance
Interface IServiceInstanceManagerSPI

Package class diagram package IServiceInstanceManagerSPI
All Superinterfaces:
IConfigDeleter, IConfigKeyChecker, IServiceInstanceManager
All Known Implementing Classes:
ServiceInstanceManager

public interface IServiceInstanceManagerSPI
extends IServiceInstanceManager

/** Manager Interface for Service Instance internal operations.

Since:
6.1.0

Method Summary
 boolean existsRestShortName(String restShortName, String serviceInstanceIdToIgnore, ITransaction transaction)
          Verify if a given name exists.
 ServiceInstanceConfig getByRestShortName(String restShortName, ITransaction transaction)
          Get the service's instance by rest short name.
 void serializeFileTransformations(SessionConfig sessionConfig, String serviceInstanceId, OutputStream outputStream, ITransaction transaction)
          serialize a fileTransformation to be used in a new channel created from channel template.
 
Methods inherited from interface lumis.portal.serviceinstance.IServiceInstanceManager
add, add, addOrUpdate, addOrUpdate, clearServiceInstanceCache, delete, deleteCustomProperties, deleteCustomProperty, deserialize, deserializeCustomProperties, deserializeDependency, findServiceInstanceThroughChannelTree, get, getCustomProperties, getCustomProperty, getDependency, getDependencyIdsByServiceInstanceId, getDependentServiceInstanceIds, getDependentServiceInstances, getIds, getIdsByChannelId, getIdsByChannelTree, getIdsByServiceId, getServiceInstanceByDependency, getServiceInstancesByDependency, serialize, serializeCustomProperties, serializeDependencies, setCustomProperties, setCustomProperty, setServiceInstanceDependency, update
 
Methods inherited from interface lumis.portal.serialization.operation.IConfigDeleter
deleteConfig
 
Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker
keyExists
 

Method Detail

existsRestShortName

boolean existsRestShortName(String restShortName,
                            String serviceInstanceIdToIgnore,
                            ITransaction transaction)
                            throws PortalException
Verify if a given name exists.

Parameters:
restShortName - rest short name of the service instance.
serviceInstanceIdToIgnore - service instance id that will not include on the search.
transaction - transaction used to perform the query.
Returns:
true if the name exists otherwise false.
Throws:
PortalException - if any other error occurs during the process.

getByRestShortName

ServiceInstanceConfig getByRestShortName(String restShortName,
                                         ITransaction transaction)
                                         throws PortalException
Get the service's instance by rest short name.

Parameters:
restShortName - rest short name of the service instance.
transaction - transaction used to perform the query.
Returns:
the serviceInstanceConfig that represents the service instance.
Throws:
PortalException - if any other error occurs during the process.

serializeFileTransformations

void serializeFileTransformations(SessionConfig sessionConfig,
                                  String serviceInstanceId,
                                  OutputStream outputStream,
                                  ITransaction transaction)
                                  throws ManagerException,
                                         PortalException
serialize a fileTransformation to be used in a new channel created from channel template.

Parameters:
sessionConfig - user session information.
serviceInstanceId - new serviceInstance´s id
outputStream - the outputstream to serialize the data to.
transaction - transaction used to perform the query.
Throws:
ManagerException - if an error occurs during the process
PortalException - if an error occurs during the process
Since:
6.2.0


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.