Class AbstractSilverpeasContentManager.ContributionWrapper

    • Method Detail

      • getWrappedInstance

        public Contribution getWrappedInstance()
      • getId

        public String getId()
        Description copied from interface: SilverpeasContent
        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
        Specified by:
        getId in interface SilverpeasContent
        Returns:
        the identifier of this content.
      • getSilverpeasContentId

        public String getSilverpeasContentId()
        Description copied from interface: SilverpeasContent
        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.
        Specified by:
        getSilverpeasContentId in interface SilverpeasContent
        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).
      • getTitle

        public String getTitle()
        Description copied from interface: Contribution
        Gets the title of this contribution if any. By default returns an empty String.
        Specified by:
        getTitle in interface Contribution
        Returns:
        the contribution's title in the specified language. Can be empty if no title was set or no title is defined for a such contribution.
      • getDescription

        public String getDescription()
        Description copied from interface: Contribution
        Gets a description about this contribution if any. By default returns an empty String.
        Specified by:
        getDescription in interface Contribution
        Specified by:
        getDescription in interface Nameable
        Returns:
        the description on this contribution. Can be empty if no description was set or no description is defined for a such contribution.
      • getContributionType

        public String getContributionType()
        Description copied from interface: Contribution
        Gets the type of this contribution. The type is a label that identifies uniquely a kind of contribution handled by a Silverpeas application. By default, this method returns the simple name of the class implementing this interface.
        Specified by:
        getContributionType in interface Contribution
        Returns:
        the label of the type of this contribution.
      • isIndexable

        public boolean isIndexable()
        Description copied from interface: Contribution
        Is this contribution indexable? By default true.
        Specified by:
        isIndexable in interface Contribution
        Returns:
        a boolean indicating if this contribution can be taken in charge by the Indexation Engine. By default, any contribution in Silverpeas are indexable unless specified otherwise.
      • canBeAccessedBy

        public boolean canBeAccessedBy​(User user)
        Description copied from interface: Contribution
        Is the specified user can access this contribution?

        By default Securable.canBeAccessedBy(User) is implemented so that a user can access a contribution if it has enough rights to access the application instance in which is managed this contribution.
        Indeed, this behavior is mostly the common one.
        But In the case the application instance distributes its contribution along of a categorization tree and the nodes of this tree support access rights, then the user must have also the rights to access the node to which belongs the content.
        Of course it could exist other access rules...

        Specified by:
        canBeAccessedBy in interface Contribution
        Specified by:
        canBeAccessedBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user can access this content, false otherwise.
      • canBeModifiedBy

        public boolean canBeModifiedBy​(User user)
        Description copied from interface: Securable
        Checks the given user can modify this resource. By default, if the user can access this securable resource, then it can also modify it.
        Specified by:
        canBeModifiedBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user can modify the data managed by this instance, false otherwise.
      • canBeDeletedBy

        public boolean canBeDeletedBy​(User user)
        Description copied from interface: Securable
        Checks the given user can delete this resource. By default, if the user can modify this securable resource, then it can also delete it.
        Specified by:
        canBeDeletedBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user can delete the data managed by this instance, false otherwise.