fr.paris.lutece.plugins.directory.web.action
Interface IDirectorySearchFields

All Known Implementing Classes:
DefaultDirectorySearchFields, DirectoryAdminSearchFields, DirectorySiteSearchFields

public interface IDirectorySearchFields

Visualization of all needed for searched record.

Author:
merlinfe

Method Summary
 String getCurrentPageIndex()
          Current page index
 Date getDateCreationBeginRecord()
          Date creation begin record
 Date getDateCreationEndRecord()
          Date creation end record
 Date getDateCreationRecord()
          Date creation record
 Date getDateModificationBeginRecord()
          Date modification begin record
 Date getDateModificationEndRecord()
          Date modification end record
 Date getDateModificationRecord()
          Date modification record
 String getDefaultIdSortEntry(Directory directory)
          return the default entry used for sorting the records
 int getDefaultItemsPerPage()
          Default items per page
 int getIdDirectory()
          Id directory
 int getIdEntry()
          Id entry
 int getIsDisabled()
           
 int getItemsPerPage()
          Items per page
 HashMap<String,List<RecordField>> getMapQuery()
          Map query
 IEntry getSortEntry()
          Get the sort entry
 int getSortOrder()
          Get the sort order
 boolean isDefaultAscendingSort(Directory directory)
          return true if the record must be sorted by ascending sort
 boolean isSortByDateModification()
          Check if it must be sort by date modification
 void setCurrentPageIndex(String strCurrentPageIndex)
          Current page index
 void setDateCreationBeginRecord(Date dateCreationBeginRecord)
          Date creation begin record
 void setDateCreationEndRecord(Date dateCreationEndRecord)
          Date creation end record
 void setDateCreationRecord(Date dateCreationRecord)
          Date creation record
 void setDateModificationBeginRecord(Date dateModificationBeginRecord)
          Date modification begin record
 void setDateModificationEndRecord(Date dateModificationEndRecord)
          Date modification end record
 void setDateModificationRecord(Date dateModificationRecord)
          Date modification record
 void setDefaultItemsPerPage(int nDefaultItemsPerPage)
          Default items per page
 void setIdDirectory(int nIdDirectory)
          Id directory
 void setIdEntry(int nIdEntry)
          Id entry
 void setIsDisabled(int nIsDisabled)
          set true if the records displayed must be disabled
 void setItemsPerPage(int nItemsPerPage)
          Items per page
 void setMapQuery(HashMap<String,List<RecordField>> mapQuery)
          Map query
 void setSortByDateModification(boolean bSortByDateModification)
          Set true if it must be sort by date modification
 void setSortEntry(IEntry sortEntry)
          Set the sort entry
 void setSortOrder(int nSortOrder)
          Set the sort order
 void setSortParameters(javax.servlet.http.HttpServletRequest request, Directory directory, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Set the sort parameters
 

Method Detail

getDefaultItemsPerPage

int getDefaultItemsPerPage()
Default items per page

Returns:
default items per page

setDefaultItemsPerPage

void setDefaultItemsPerPage(int nDefaultItemsPerPage)
Default items per page

Parameters:
nDefaultItemsPerPage - default items per page

getCurrentPageIndex

String getCurrentPageIndex()
Current page index

Returns:
current page index

setCurrentPageIndex

void setCurrentPageIndex(String strCurrentPageIndex)
Current page index

Parameters:
strCurrentPageIndex - current page index

getIdDirectory

int getIdDirectory()
Id directory

Returns:
id directory

setIdDirectory

void setIdDirectory(int nIdDirectory)
Id directory

Parameters:
nIdDirectory - id directory

getIdEntry

int getIdEntry()
Id entry

Returns:
id entry

setIdEntry

void setIdEntry(int nIdEntry)
Id entry

Parameters:
nIdEntry - id entry

getMapQuery

HashMap<String,List<RecordField>> getMapQuery()
Map query

Returns:
map query

setMapQuery

void setMapQuery(HashMap<String,List<RecordField>> mapQuery)
Map query

Parameters:
mapQuery - map query

getDateCreationBeginRecord

Date getDateCreationBeginRecord()
Date creation begin record

Returns:
date creation begin record

setDateCreationBeginRecord

void setDateCreationBeginRecord(Date dateCreationBeginRecord)
Date creation begin record

Parameters:
dateCreationBeginRecord - date creation begin record

getDateCreationEndRecord

Date getDateCreationEndRecord()
Date creation end record

Returns:
date creation end record

setDateCreationEndRecord

void setDateCreationEndRecord(Date dateCreationEndRecord)
Date creation end record

Parameters:
dateCreationEndRecord - date creation end record

getDateCreationRecord

Date getDateCreationRecord()
Date creation record

Returns:
date creation record

setDateCreationRecord

void setDateCreationRecord(Date dateCreationRecord)
Date creation record

Parameters:
dateCreationRecord - date creation record

setSortEntry

void setSortEntry(IEntry sortEntry)
Set the sort entry

Parameters:
sortEntry - the sort entry

getSortEntry

IEntry getSortEntry()
Get the sort entry

Returns:
the sort entry

setSortOrder

void setSortOrder(int nSortOrder)
Set the sort order

Parameters:
nSortOrder - the sort order

getSortOrder

int getSortOrder()
Get the sort order

Returns:
the sort order

setSortParameters

void setSortParameters(javax.servlet.http.HttpServletRequest request,
                       Directory directory,
                       fr.paris.lutece.portal.service.plugin.Plugin plugin)
Set the sort parameters

Parameters:
request - the HTTP request
directory - the directory
plugin - the plugin

getDefaultIdSortEntry

String getDefaultIdSortEntry(Directory directory)
return the default entry used for sorting the records

Parameters:
directory - the directory
Returns:
the default entry used for sorting the records

isDefaultAscendingSort

boolean isDefaultAscendingSort(Directory directory)
return true if the record must be sorted by ascending sort

Parameters:
directory - the directory
Returns:
true if the record must be sorted by ascending sort

getItemsPerPage

int getItemsPerPage()
Items per page

Returns:
items per page

setItemsPerPage

void setItemsPerPage(int nItemsPerPage)
Items per page

Parameters:
nItemsPerPage - items per page

getIsDisabled

int getIsDisabled()
Returns:
true if the records must be disabled

setIsDisabled

void setIsDisabled(int nIsDisabled)
set true if the records displayed must be disabled

Parameters:
nIsDisabled - true if the records displayed must be disabled

getDateModificationBeginRecord

Date getDateModificationBeginRecord()
Date modification begin record

Returns:
date modification begin record

setDateModificationBeginRecord

void setDateModificationBeginRecord(Date dateModificationBeginRecord)
Date modification begin record

Parameters:
dateModificationBeginRecord - date modification begin record

getDateModificationEndRecord

Date getDateModificationEndRecord()
Date modification end record

Returns:
date modification end record

setDateModificationEndRecord

void setDateModificationEndRecord(Date dateModificationEndRecord)
Date modification end record

Parameters:
dateModificationEndRecord - date modification end record

getDateModificationRecord

Date getDateModificationRecord()
Date modification record

Returns:
date modification record

setDateModificationRecord

void setDateModificationRecord(Date dateModificationRecord)
Date modification record

Parameters:
dateModificationRecord - date modification record

setSortByDateModification

void setSortByDateModification(boolean bSortByDateModification)
Set true if it must be sort by date modification

Parameters:
bSortByDateModification - true if it must be sort by date modification

isSortByDateModification

boolean isSortByDateModification()
Check if it must be sort by date modification

Returns:
true if it must be sort by date modification, false otherwise


Copyright © 2013 Mairie de Paris. All Rights Reserved.