Package org.silverpeas.core.admin.component.model

Interface SilverpeasSharedComponentInstance

All Superinterfaces:

Identifiable, LocalizedResource, Nameable, Securable, Serializable, SilverpeasComponentInstance, SilverpeasResource, Translatable

All Known Implementing Classes:

ComponentInst, ComponentInstLight

public interface SilverpeasSharedComponentInstance
extends SilverpeasComponentInstance, LocalizedResource, Securable

Author:

Yohann Chastagnier

Method Summary

Modifier and Type	Method	Description
default boolean	canBeAccessedBy(User user)	Checks the given user can access this resource.
default boolean	canBeFiledInBy(User user)	Checks the given user can file in this resource another resource.
default boolean	canBeModifiedBy(User user)	Is the user can modify this component instance?
static Optional<SilverpeasSharedComponentInstance>	getById(String sharedComponentInstanceId)	Gets a personal silverpeas component instance from the specified identifier.
BasicIdentifier	getIdentifier()	Gets the unique identifier of this resource.

Methods inherited from interface org.silverpeas.core.Identifiable

getId

Methods inherited from interface org.silverpeas.core.i18n.LocalizedResource

getTranslation

Methods inherited from interface org.silverpeas.core.security.Securable

canBeDeletedBy

Methods inherited from interface org.silverpeas.core.admin.component.model.SilverpeasComponentInstance

getDescription, getDescription, getHighestSilverpeasRolesFor, getLabel, getLabel, getName, getOrderPosition, getParameterValue, getSilverpeasRolesFor, getSpaceId, isHidden, isPersonal, isPublic, isRemoved, isTopicTracker, isWorkflow

Methods inherited from interface org.silverpeas.core.SilverpeasResource

getCreationDate, getCreator, getLastUpdateDate, getLastUpdater

Method Detail

getById

static Optional<SilverpeasSharedComponentInstance> getById(String sharedComponentInstanceId)

Gets a personal silverpeas component instance from the specified identifier.

Parameters:

sharedComponentInstanceId - a personal component instance identifier as string.

Returns:

an optional silverpeas personal component instance of SilverpeasSharedComponentInstance.

getIdentifier

BasicIdentifier getIdentifier()

Description copied from interface: SilverpeasResource

Gets the unique identifier of this resource.

Specified by:

getIdentifier in interface SilverpeasResource

Returns:

the ResourceIdentifier object representing the unique identifier of the resource.

canBeAccessedBy

default boolean canBeAccessedBy(User user)

Description copied from interface: Securable

Checks the given user can access this resource.

Specified by:

canBeAccessedBy in interface Securable

Parameters:

user - a user in Silverpeas.

Returns:

true if the user can access the data managed by this instance, false otherwise.

canBeModifiedBy

default boolean canBeModifiedBy(User user)

Is the user can modify this component instance?

Specified by:

canBeModifiedBy in interface Securable

Parameters:

user - a user in Silverpeas.

Returns:

true if the user can both access this component instance and has management privilege on this component instance (by being either an administrator or a space manager)

canBeFiledInBy

default boolean canBeFiledInBy(User user)

Description copied from interface: Securable

Checks the given user can file in this resource another resource. This behaviour control is only pertinent for resources acting as a container of other resources. By default, it returns false so that it requires to be implemented by any securable resource type supporting filing.

Specified by:

canBeFiledInBy in interface Securable

Parameters:

user - a user in Silverpeas.

Returns:

true if the user can file in this resource another resource.