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: 122fb7648b05aa1fb31b280e8bd1cd73b046f57e $

Method Summary

DocumentReference	getAuthorReference() Get the reference to the author of the document this component instance is bound to.
DocumentReference	getDocumentReference() Get the reference of the document this component instance is bound to.
String	getRoleHint()
Type	getRoleType()
WikiComponentScope	getScope()

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.

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.

getScope

WikiComponentScope getScope()

Returns:

the WikiComponentScope of the component.