Index (Lutece directory rest module 3.0.2-SNAPSHOT API)

A C D F G I M P R S T U

A

addToDirectory(String, ServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService: Add a record in a directory with the parameters given if they match
addToDirectory(String, ServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService: Add a record in a directory with the parameters given if they match

C

completeRecord(int, ServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService: Gets record fields values from the request and complete the record for asynchronous record creation.
completeRecord(int, ServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService: Gets record fields values from the request and complete the record for asynchronous record creation.
convertRequest(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService: Convert the HTTP request to a MultipartHttpServletRequest
convertRequest(HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService: Convert the HTTP request to a MultipartHttpServletRequest

D

deleteRecord(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService: delete the record
deleteRecord(int, HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService: delete the record
DirectoryFormatterJson - Class in fr.paris.lutece.plugins.directory.modules.rest.service.formatters: Format directory output to the JSON format Example of the formatted directories list JSON :
[ { "Id":1, "Title":"directoryTitle", "Description":"directoryDescription", "IsEnable":true, "Role":"none", "Workgroup":"all", "IdWorkflow":1 }, { ... }, ... ]
DirectoryFormatterJson() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterJson
DirectoryFormatterXml - Class in fr.paris.lutece.plugins.directory.modules.rest.service.formatters: Format directory output to the XML format Example of the formatted directories list XML : SUCCESS 1 directoryTitle directoryDescription true none all 1 ...
DirectoryFormatterXml() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterXml
DirectoryRest - Class in fr.paris.lutece.plugins.directory.modules.rest.rs: DirectoryRest
DirectoryRest() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest
DirectoryRestConstants - Class in fr.paris.lutece.plugins.directory.modules.rest.util.constants: DirectoryRestConstants
DirectoryRestException - Exception in fr.paris.lutece.plugins.directory.modules.rest.service: DirectoryRestException
DirectoryRestException(String) - Constructor for exception fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestException: Constructor
DirectoryRestHttpServletRequest - Class in fr.paris.lutece.plugins.directory.modules.rest.service.http: DirectoryRestHttpServletRequest This wrapper allows the request to have additional parameters.
DirectoryRestHttpServletRequest(HttpServletRequest, MultivaluedMap<String, String>) - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.http.DirectoryRestHttpServletRequest: Constructor
DirectoryRestService - Class in fr.paris.lutece.plugins.directory.modules.rest.service: DirectoryRestService
DirectoryRestService() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService
DirectoryWriter - Class in fr.paris.lutece.plugins.directory.modules.rest.service.writers: DirectoryWriter
DirectoryWriter() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.writers.DirectoryWriter
doDeleteRecord(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest: Delete a record
doInsertOrCompleteRecord(MultivaluedMap<String, String>, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest: Insert or complete a record
doMultipartInsertOrCompleteRecord(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest: Insert or complete a record in enctype multipart
doMultipartUpdateRecord(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest: Update a record in enctype multipart
doUpdateRecord(MultivaluedMap<String, String>, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest: Update a record





F

format(Directory) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterJson
format(List<Directory>) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterJson
format(Directory) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterXml
format(List<Directory>) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterXml
format(Record) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterJson
format(List<Record>) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterJson
format(Record) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterXml
format(List<Record>) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterXml
formatError(String, String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterJson
formatError(String, String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.DirectoryFormatterXml
formatError(String, String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterJson
formatError(String, String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterXml
fr.paris.lutece.plugins.directory.modules.rest.rs - package fr.paris.lutece.plugins.directory.modules.rest.rs
 
fr.paris.lutece.plugins.directory.modules.rest.service - package fr.paris.lutece.plugins.directory.modules.rest.service
 
fr.paris.lutece.plugins.directory.modules.rest.service.formatters - package fr.paris.lutece.plugins.directory.modules.rest.service.formatters
 
fr.paris.lutece.plugins.directory.modules.rest.service.http - package fr.paris.lutece.plugins.directory.modules.rest.service.http
 
fr.paris.lutece.plugins.directory.modules.rest.service.writers - package fr.paris.lutece.plugins.directory.modules.rest.service.writers
 
fr.paris.lutece.plugins.directory.modules.rest.util.constants - package fr.paris.lutece.plugins.directory.modules.rest.util.constants
 




G

getDirectoriesList(int) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Get the directories list

getDirectoriesList() - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get the list of directories

getDirectoriesList() - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get the list of directories

getDirectory(int) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Get the directory

getDirectory(int) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get the directory given the id directory

getDirectory(int) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get the directory given the id directory

getEntries(Record) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get the list of entries from the record

getEntries(Record) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get the list of entries from the record

getIdsEntry(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get the ids entry from the parameters of the request.

getIdsEntry(int) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get all entries

getIdsEntry(int, HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get the ids entry from the parameters of the request.

getIdsEntry(int) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get all entries

getMapIdEntryListRecordField(Record) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Get the map of id entry - List de Record Field

getMapIdEntryListRecordField(Record) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Get the map of id entry - List de Record Field

getParameter(String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.http.DirectoryRestHttpServletRequest
getParameterValues(String) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.http.DirectoryRestHttpServletRequest
getRecord(int, int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Get the record

getRecord(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Gets the record

getRecord(int, HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Gets the record

getRecordsList(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Get the records list

getRecordsList(int, HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Finds the list

getRecordsList(int, HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Finds the list

getWADL(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Get the wadl.xml content





I

IDirectoryRestService - Interface in fr.paris.lutece.plugins.directory.modules.rest.service

IDirectoryRestService

insertOrCompleteRecord(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Creates or updates the record

insertOrCompleteRecord(HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Creates or updates the record

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.writers.DirectoryWriter
isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.writers.RecordWriter




M

MARK_BASE_URL - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
MESSAGE_DIRECTORY_REST - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
MESSAGE_RECORD_NOT_FOUND - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 




P

PARAMETER_ID_DIRECTORY - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PARAMETER_ID_DIRECTORY_RECORD - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PARAMETER_ID_ENTRY_FILTER - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PARAMETER_ID_RESOURCE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PARAMETER_ID_WORKFLOW - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PARAMETER_RESOURCE_TYPE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PATH_ID_DIRECTORY - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PATH_ID_DIRECTORY_RECORD - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PATH_RECORD - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PATH_RECORDS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PATH_WADL - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PROPERTY_FIELD_WORKFLOW_PREFIX - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PROPERTY_MAX_NUMBER_RECORDS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PROPERTY_MULTIPART_NORMALIZE_FILE_NAME - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PROPERTY_MULTIPART_REQUEST_SIZE_MAX - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
PROPERTY_MULTIPART_SIZE_THRESHOLD - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 




R

RecordFormatterJson - Class in fr.paris.lutece.plugins.directory.modules.rest.service.formatters

Format record output to the JSON format
 Example of a formatted record JSON :
 

 
 [
         {
                 "Id":1,
                 "state":
                 {
                         "id-state":1,
                         "name":"state1",
                         "description":"State 1",
                         "id-workflow":"1",
                         "is-initial-state":"true",
                         "is-required-workgroup-assigned":"false"
                 },
                 "RecordFields":
                 [
                         {
                                 "group1":
                                 {
                                         "recordFieldTitle1":"recordFieldValue1"
                                 },
                                 {
                                         "recordFieldTitle2":
                                         {
                                                                                                "choiceTitle2":"choiceValue2",
                                               "choiceTitle3":"choiceValue3"
                                        }
                                 }
                         },
                         {
                                 "recordFieldTitle3":"recordFieldValue3"
                         },
                         {
                                 "recordFieldTitle4":
                                 {
                                                                                "choiceTitle4":"choiceValue4",
                                                                                "choiceTitle5":"choiceValue5"
                                }
                         }

                 ]
         }
         {
                 "Id:2,
                 ...
  }
 ]
 

RecordFormatterJson() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterJson
 
RecordFormatterXml - Class in fr.paris.lutece.plugins.directory.modules.rest.service.formatters

Format record output to the XML format
 Example of the formatted record XML :
 

 
 
                 SUCCESS
                 
                         
                                 1
                                 
                                         1
                                         state1
                                         State 1
                                         1
                                         true
                                         false
                                 
                                 
                                         recordFieldValue1
                                         
                                                 value1
                                                 value2
                                         
                                 
                         
                 
 
 

RecordFormatterXml() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.formatters.RecordFormatterXml
 
RecordWriter - Class in fr.paris.lutece.plugins.directory.modules.rest.service.writers

RecordWriter

RecordWriter() - Constructor for class fr.paris.lutece.plugins.directory.modules.rest.service.writers.RecordWriter
 




S

setDirectoryRestService(IDirectoryRestService) - Method in class fr.paris.lutece.plugins.directory.modules.rest.rs.DirectoryRest

Set the directory rest service

SLASH - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
STATUS_SUCCESS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 




T

TAG_DESCRIPTION - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_DIRECTORIES - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_DIRECTORY - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_HEIGHT - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_ID - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_ID_WORKFLOW - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_IS_ENABLE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_RECORD - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_RECORD_FIELDS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_RECORDS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_RESPONSE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_ROLE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_STATUS - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_TITLE - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_WIDTH - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TAG_WORKGROUP - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 
TEMPLATE_WADL - Static variable in class fr.paris.lutece.plugins.directory.modules.rest.util.constants.DirectoryRestConstants
 




U

updateRecord(HttpServletRequest) - Method in class fr.paris.lutece.plugins.directory.modules.rest.service.DirectoryRestService

Update record

updateRecord(HttpServletRequest) - Method in interface fr.paris.lutece.plugins.directory.modules.rest.service.IDirectoryRestService

Update record


A C D F G I M P R S T U