Package org.silverpeas.core.contribution.model

Interface SilverpeasContent

All Superinterfaces:

Contribution, Identifiable, Instance<Contribution>, Nameable, Securable, Serializable, SilverpeasResource

All Known Subinterfaces:

SilverContentInterface, SilverpeasToolContent

All Known Implementing Classes:

AbstractSilverpeasContentManager.ContributionWrapper, Comment, PublicationDetail, QuestionContainerDetail, QuestionContainerHeader, SilverContent

public interface SilverpeasContent
extends Identifiable, Contribution

A contribution with a single content that is managed by an application of the Silverpeas collaborative portal. The content of the contribution can be empty. This interface defines the common properties the different type of content in Silverpeas has to support. It is defined for compatibility reason with the old content API (in which the contribution and content concepts are entangled). This interface links the old Content Management API with the new one represented by the Contribution and ContributionContent models.

Method Summary

Modifier and Type	Method	Description
String	getComponentInstanceId()	Gets the unique identifier of the Silverpeas component instance that manages this content.
String	getId()	Gets the identifier of this content in the Silverpeas component providing it.
default ContributionIdentifier	getIdentifier()	Contribution default implementations.
default String	getSilverpeasContentId()	Gets the unique identifier of this content among all the contents managed in the Silverpeas collaborative portal.

Methods inherited from interface org.silverpeas.core.contribution.model.Contribution

canBeAccessedBy, getContributionType, getDescription, getModel, getName, getResourcePath, getTitle, isIndexable

Methods inherited from interface org.silverpeas.core.Instance

getParent

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

canBeDeletedBy, canBeFiledInBy, canBeModifiedBy

Methods inherited from interface org.silverpeas.core.SilverpeasResource

getCreationDate, getCreator, getLastUpdateDate, getLastUpdater

Method Detail

getId

String getId()

Gets the identifier of this content in the Silverpeas component providing it. This identifier is only unique among all the contents managed by the same component (whatever its different instances). As each type of contents in Silverpeas is provided by a single Silverpeas component, the identifier of a content is then specific to the component it belongs to. It is a way for an instance of a such component to identify uniquely the different contents it manages. So, each component can have their own policy to identify their content, whatever the way they are identified in Silverpeas.

Specified by:

getId in interface Identifiable

Returns:

the identifier of this content.

getComponentInstanceId

String getComponentInstanceId()

Gets the unique identifier of the Silverpeas component instance that manages this content.

Returns:

the unique identifier of the component instance in the Silverpeas collaborative portal.

getSilverpeasContentId

default String getSilverpeasContentId()

Gets the unique identifier of this content among all the contents managed in the Silverpeas collaborative portal. It is the alone unique identifier of a content in the whole Silverpeas portal; it is referred as the Silverpeas content identifier or the silver content identifier. For each content put into the Silverpeas collaborative portal, an entry is uniquely created in the whole system so that is can be referred by transversal services and by component instances others the one that manages it. For compatibility reason, the Silverpeas content identifier of contents that are no yet taken into account in the whole system isn't defined, so an empty string is then returned.

Returns:

the unique identifier of this content in the whole Silverpeas collaborative portal. Can be empty if no such identifier is defined for the type of this content (default).

getIdentifier

default ContributionIdentifier getIdentifier()

Contribution default implementations.

Specified by:

getIdentifier in interface Contribution

Specified by:

getIdentifier in interface SilverpeasResource

Returns:

the unique identifier of the contribution.