Package org.silverpeas.core.admin.component.service

Interface SilverpeasComponentInstanceProvider

All Known Implementing Classes:

DefaultSilverpeasComponentInstanceProvider

public interface SilverpeasComponentInstanceProvider

In charge of providing silverpeas component instance.

Author:

Yohann Chastagnier

Method Summary

Modifier and Type	Method	Description
static SilverpeasComponentInstanceProvider	get()	Gets the instance of the implementation of the interface.
Optional<SilverpeasComponentInstance>	getById(String componentInstanceId)	Gets a any silverpeas component instance from the specified identifier.
String	getComponentName(String componentInstanceId)	Gets the name of the component from which the specified instance was spawn.
Optional<SilverpeasPersonalComponentInstance>	getPersonalById(String personalComponentInstanceId)	Gets a personal silverpeas component instance from the specified identifier.
Optional<SilverpeasSharedComponentInstance>	getSharedById(String sharedComponentInstanceId)	Gets a shared silverpeas component instance from the specified identifier.

Method Detail

get

static SilverpeasComponentInstanceProvider get()

Gets the instance of the implementation of the interface.

Returns:

an implementation of SilverpeasComponentInstanceProvider.

getById

Optional<SilverpeasComponentInstance> getById(String componentInstanceId)

Gets a any silverpeas component instance from the specified identifier.

Parameters:

componentInstanceId - a component instance identifier as string.

Returns:

an optional silverpeas component instance of SilverpeasComponentInstance.

getSharedById

Optional<SilverpeasSharedComponentInstance> getSharedById(String sharedComponentInstanceId)

Gets a shared silverpeas component instance from the specified identifier.

Parameters:

sharedComponentInstanceId - a shared component instance identifier as string.

Returns:

an optional silverpeas shared component instance of SilverpeasPersonalComponentInstance.

getPersonalById

Optional<SilverpeasPersonalComponentInstance> getPersonalById(String personalComponentInstanceId)

Gets a personal silverpeas component instance from the specified identifier.

Parameters:

personalComponentInstanceId - a personal component instance identifier as string.

Returns:

an optional silverpeas personal component instance of SilverpeasPersonalComponentInstance.

getComponentName

String getComponentName(String componentInstanceId)

Gets the name of the component from which the specified instance was spawn. The component instance identifier is made up of the name of the component with a local identifier that is peculiar to the type of the component. This method is a centralized way to get the component name from a component instance identifier.

Parameters:

componentInstanceId - the unique identifier of the component instance.

Returns: