lumis.doui.service

Interface IDouiService

All Superinterfaces:

IService

All Known Implementing Classes:

ActivityStreamService, AnalyticsService, AutoAdministrationService, BlogService, ChatRoomService, ColService, CommentItService, CommentService, CommunityService, ContentService, DouiService, ForumService, HtmlContentService, HtmlService, MicroblogService, NavigationService, PagePersonalizationService, ProducerService, RssService, SimpleContentService, SocialNetworkIntegrationService, TagService, WikiService, WSRPConsumerService

@StableMinor(version="12.4",
             sinceVersion="4.0")
public interface IDouiService
extends IService

Interface for DOUI based Services.

Since:

4.0.0

Version:

$Revision: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

Method Summary

Modifier and Type	Method and Description
void	addDefaultDouiDefinitionValues(SessionConfig sessionConfig, ServiceConfig serviceConfig, Node douiDefinitionNode, ITransaction transaction)
boolean	hasHtmlField(ITransaction transaction) Indicates if this service has an html field.
boolean	usesDocumentService(ITransaction transaction) Indicates if this service uses a document service (as repository, for example).
boolean	usesFileManager(ITransaction transaction) Indicates if this service uses the FileManager file storage API.
boolean	usesImageService(ITransaction transaction) Deprecated. Since 7.0.0, replaced by usesMediaRepository(ITransaction).
boolean	usesMediaRepository(ITransaction transaction) Indicates if this service may use a media repository.
boolean	usesWidgetRepository(ITransaction transaction) Indicates if this service uses a widget repository.

Methods inherited from interface lumis.portal.service.IService

autoAddDependencies, checkFileAccess, deserializeContent, getDefaultServiceInstanceMenu, instanceAdded, instanceDeleted, instanceDeserialized, instanceDeserialized, instanceLoaded, instanceMoved, instanceMoved, instanceMoved, instanceSerialized, instanceSerialized, instanceUnloaded, load, postRegister, postUnregister, preRegister, preUnregister, unload

Method Detail

addDefaultDouiDefinitionValues

void addDefaultDouiDefinitionValues(SessionConfig sessionConfig,
                                    ServiceConfig serviceConfig,
                                    Node douiDefinitionNode,
                                    ITransaction transaction)
                             throws PortalException

Throws:

PortalException

usesFileManager

boolean usesFileManager(ITransaction transaction)
                 throws PortalException

Indicates if this service uses the FileManager file storage API.

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses the FileManager, false otherwise.

Throws:

PortalException

usesImageService

@Deprecated
boolean usesImageService(ITransaction transaction)
                              throws PortalException

Deprecated. Since 7.0.0, replaced by usesMediaRepository(ITransaction).

Indicates if this service uses an image service (as repository, for example).

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses a image service, false otherwise.

Throws:

PortalException

usesMediaRepository

boolean usesMediaRepository(ITransaction transaction)
                     throws PortalException

Indicates if this service may use a media repository.

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service may use a media service, false otherwise.

Throws:

PortalException

Since:

7.0.0

usesDocumentService

boolean usesDocumentService(ITransaction transaction)
                     throws PortalException

Indicates if this service uses a document service (as repository, for example).

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses a document service, false otherwise.

Throws:

PortalException

usesWidgetRepository

boolean usesWidgetRepository(ITransaction transaction)
                      throws PortalException

Indicates if this service uses a widget repository.

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses a widget repository, false otherwise.

Throws:

PortalException

hasHtmlField

boolean hasHtmlField(ITransaction transaction)
              throws PortalException

Indicates if this service has an html field.

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service has an html field, false otherwise.

Throws:

PortalException