lumis.portal.documentation

Interface IDocumentation

All Known Implementing Classes:

AddCommunityProcessActionHandler, AddFormFieldProcessActionHandler, AddFormProcessActionHandler, AddMobileAppProcessActionHandler, AddQuestionaireProcessActionHandler, AddSeoRuleProcessActionHandler, AddSocialNetworkProcessActionHandler, AlbumAddMultipleProcessActionHandler, AssociationProcessActionHandler, BannerAddDataProcessActionHandler, BannerDeleteDataProcessActionHandler, BannerUpdateDataProcessActionHandler, CancelPublicSubscriptionProcessActionHandler, CommitAndPreviewProcessActionHandler, ContentLockProcessActionHandler, ContentTableAddDataProcessActionHandler, ContentTableAddFileMultiRowDataProcessActionHandler, ContentTableDeleteDataProcessActionHandler, ContentTableUpdateDataProcessActionHandler, DeleteCommunityProcessActionHandler, DeleteQuestionnaireProcessActionHandler, DeleteRelationCommentProcessActionHandler, DeleteWidgetProcessActionHandler, DocumentDeleteProcessActionHandler, EditMobileAppProcessActionHandler, FileListAddProcessActionHandler, FileListEditProcessActionHandler, HierarchicalContentDeleteDataProcessActionHandler, MediaAddMultipleProcessActionHandler, MediaAddProcessActionHandler, MediaAddPublicProcessActionHandler, MediaDeleteProcessActionHandler, MediaDeleteProcessActionHandler, MediaUpdateProcessActionHandler, MicroblogAttachmentsProcessActionHandler, PagePersonalizationContentTableAddProcessActionHandler, PagePersonalizationContentTableEditProcessActionHandler, PostAddProcessActionHandler, PostEditProcessActionHandler, ProcessAnswerProcessActionHandler, PropertyBagProcessActionHandler, TableAddDataProcessActionHandler, TableAddFileMultiRowDataProcessActionHandler, TableAddMultiRowDataProcessActionHandler, TableDeleteDataProcessActionHandler, TableDeleteMultiRowDataProcessActionHandler, TableUpdateDataProcessActionHandler, TableUpdateMultiRowDataProcessActionHandler, UpdateCategorizationRepositoryProcessActionHandler, UpdateChannelsProcessActionHandler, UpdateCommunityProcessActionHandler, UpdateFormFieldProcessActionHandler, UpdateFormProcessActionHandler, UpdateQuestionaireProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserPostDeleteProcessActionHandler, UserSubscriptionProcessActionHandler, UserSubscriptionProcessActionHandler

public interface IDocumentation

Interface that should be implemented by objects that want to support documentation functionality

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns an HTML description.
String	getName() Returns the name of the current object that will be displayed for documentation.

Method Detail

getName

String getName()

Returns the name of the current object that will be displayed for documentation.

Returns:

the name to used for documentation

Since:

9.0.0

getDescription

String getDescription()

Returns an HTML description.

Returns:

the HTML description.

Since:

9.0.0