Package org.xwiki.component.wiki

Interface WikiComponent

  • public interface WikiComponent
    Represents the definition of a wiki component implementation. A java component can extend this interface if it needs to be bound to a document, in order to be unregistered and registered again when the document is modified, and unregistered when the document is deleted.
    Since:
    4.2M3
    Version:
    $Id: a60502842f2f5f1861b8997cabb8c3344a8d49d7 $

    • Method Detail

      • getDocumentReference

        DocumentReference getDocumentReference()
        Get the reference of the document this component instance is bound to.
        Returns:
        the reference to the document holding this wiki component definition.

      • getEntityReference

        default EntityReference getEntityReference()
        Get the entity reference of the bounded component instance.
        Returns:
        the entity reference bounded to the component
        Since:
        9.5RC1

      • getAuthorReference

        DocumentReference getAuthorReference()
        Get the reference to the author of the document this component instance is bound to.
        Returns:
        the reference to the author of the document holding this wiki component definition.

      • getRoleType

        Type getRoleType()
        Returns:
        the role implemented by this component implementation.

      • getRoleHint

        String getRoleHint()
        Returns:
        the hint of the role implemented by this component implementation.