fr.toutatice.ecm.platform.service.editablewindows

Interface EditableWindowService

All Known Implementing Classes:

EditableWindowServiceImpl

public interface EditableWindowService

Service for editable window registration

Author:

Loïc Billon

Method Summary

Methods

Modifier and Type	Method and Description
Map.Entry<EwDescriptor,EditableWindow>	findByCode(String code) Get an EW by code
Map.Entry<EwDescriptor,EditableWindow>	getEwEntry(org.nuxeo.ecm.core.api.DocumentModel doc, String uri) Get descriptor and instance of an EW
String	prepareCreation(org.nuxeo.ecm.core.api.DocumentModel doc, EditableWindow specific, String fragmentCategory, String region, String belowUri, String code2) Used to instanciate a new editable window in a page.

Method Detail

findByCode

Map.Entry<EwDescriptor,EditableWindow> findByCode(String code)
                                                  throws EwServiceException

Get an EW by code

Parameters:

code -

Returns:

the EW instance

Throws:

EwServiceException

getEwEntry

Map.Entry<EwDescriptor,EditableWindow> getEwEntry(org.nuxeo.ecm.core.api.DocumentModel doc,
                                                String uri)
                                                  throws EwServiceException

Get descriptor and instance of an EW

Parameters:

doc -

uri -

Returns:

Entry.set

Throws:

EwServiceException

prepareCreation

String prepareCreation(org.nuxeo.ecm.core.api.DocumentModel doc,
                     EditableWindow specific,
                     String fragmentCategory,
                     String region,
                     String belowUri,
                     String code2)
                       throws EwServiceException

Used to instanciate a new editable window in a page.

Parameters:

doc -

specific -

fragmentCategory -

region -

belowUri -

code2 -

Returns:

Throws:

EwServiceException