|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ComponentInstanceManager
Manages components inside the Endeca CAS Service.
Method Summary | |
---|---|
void |
createComponentInstance(ComponentTypeId componentTypeId,
ComponentInstanceId componentInstanceId)
Creates a component instance of the given type with the given id. |
void |
deleteComponentInstance(ComponentInstanceId componentInstanceId)
Deletes the given component instance. |
ComponentInstanceDescriptor |
getComponentInstanceDescriptor(ComponentInstanceId componentInstanceId)
|
boolean |
hasComponentInstance(ComponentInstanceId componentInstanceId)
|
List<ComponentInstanceDescriptor> |
listComponentInstances()
Lists all component instances defined in the system. |
List<ComponentTypeDescriptor> |
listComponentTypes()
Lists all component types defined in the system. |
Method Detail |
---|
@ResponseWrapper(className="com.endeca.itl.component.manager.ListComponentTypesResponse") List<ComponentTypeDescriptor> listComponentTypes() throws ComponentManagerException
ComponentManagerException
@ResponseWrapper(className="com.endeca.itl.component.manager.ListComponentInstancesResponse") List<ComponentInstanceDescriptor> listComponentInstances() throws ComponentManagerException
ComponentManagerException
ComponentInstanceDescriptor getComponentInstanceDescriptor(ComponentInstanceId componentInstanceId) throws ComponentInstanceNotFoundException
ComponentInstanceNotFoundException
- if the componentInstanceId is not foundboolean hasComponentInstance(ComponentInstanceId componentInstanceId) throws ComponentManagerException
ComponentManagerException
void createComponentInstance(ComponentTypeId componentTypeId, ComponentInstanceId componentInstanceId) throws ComponentManagerException, InvalidComponentInstanceException, ComponentTypeNotFoundException
InvalidComponentInstanceException
- if the instance id is already in use or has invalid
characters
ComponentTypeNotFoundException
- if the component type is not registered with the system
ComponentManagerException
- if there was an error starting the component instancevoid deleteComponentInstance(ComponentInstanceId componentInstanceId) throws ComponentManagerException, ComponentInstanceNotFoundException
ComponentInstanceNotFoundException
- if the ComponentInstanceManager does not contain the
component instance
ComponentManagerException
- if there was an error stopping the component instance
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |