public class Directory extends Object implements fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource, fr.paris.lutece.portal.service.rbac.RBACResource
Modifier and Type | Field and Description |
---|---|
static String |
RESOURCE_TYPE |
static String |
ROLE_NONE |
static int |
STATE_DISABLE |
static int |
STATE_ENABLE |
Constructor and Description |
---|
Directory() |
Modifier and Type | Method and Description |
---|---|
List<DirectoryAction> |
getActions() |
Timestamp |
getDateCreation() |
String |
getDescription() |
String |
getFrontOfficeTitle() |
int |
getIdDirectory() |
int |
getIdFormSearchTemplate()
return the id of the form search template
|
int |
getIdResultListTemplate()
return the id of the result list template
|
int |
getIdResultRecordTemplate()
return the id of the record template
|
String |
getIdSortEntry()
Get the id of the entry to sort
|
String |
getIdSortEntryFront()
return the id of the entry used for sorted
|
int |
getIdWorkflow() |
int |
getIdWorkflowStateToRemove()
Get the id of the workflow state of records that must be permanently
removed
|
int |
getNumberRecordPerPage() |
String |
getResourceId()
RBAC resource implementation
|
String |
getResourceTypeCode()
RBAC resource implementation
|
String |
getRoleKey()
Gets the directory role
|
String |
getTitle() |
String |
getUnavailabilityMessage() |
String |
getWorkgroup()
Get the workgroup key of the directory
|
StringBuffer |
getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin,
Locale locale,
StringBuffer strListRecord,
StringBuffer strListEntry)
return the xml of the directory
|
static void |
init()
Initialize the Directory
|
boolean |
isAscendingSort()
Check if the sort is ascendent
|
boolean |
isAscendingSortFront()
return true if the record must be sorted by ascending sort
|
boolean |
isDateModificationShownInAdvancedSearch()
Check if the modification date should be shown in advanced search
|
boolean |
isDateModificationShownInExport()
Check if the modification date should be exported
|
boolean |
isDateModificationShownInHistory()
Check if the modification date should be shown in history
|
boolean |
isDateModificationShownInMultiSearch()
Check if the modification date should be shown in multi search
|
boolean |
isDateModificationShownInResultList()
Check if the modification date should be shown in the result list
|
boolean |
isDateModificationShownInResultRecord()
Check if the modification date should be shown in the result record
|
boolean |
isDateModificationShownInSearch()
Check if the modification date should be shown in search
|
boolean |
isDateShownInAdvancedSearch()
Check if the creation date should be shown in advanced search
|
boolean |
isDateShownInExport()
Check if the creation date should be exported
|
boolean |
isDateShownInHistory()
Check if the creation date should be shown in history
|
boolean |
isDateShownInMultiSearch()
Check if the creation date should be shown in multi search
|
boolean |
isDateShownInResultList()
Check if the creation date should be shown in the result list
|
boolean |
isDateShownInResultRecord()
Check if the creation date should be shown in the result record
|
boolean |
isDateShownInSearch()
Check if the creation date should be shown in search
|
boolean |
isDisplayComplementarySearchState() |
boolean |
isDisplaySearchState() |
boolean |
isEnabled() |
boolean |
isIndexed()
Check if the directory is indexed
|
boolean |
isRecordActivated()
Check whether record is activated
|
boolean |
isSearchOperatorOr() |
void |
setActions(List<DirectoryAction> directoryActions)
set a list of action can be use for the directory
|
void |
setAscendingSort(boolean bAscendingSort)
Set whether the sort is ascendent
|
void |
setAscendingSortFront(boolean bAscendingSort)
set true if the record must be sorted by ascending sort in front office
|
void |
setDateCreation(Timestamp dateCreation)
set the creation date
|
void |
setDateModificationShownInAdvancedSearch(boolean bDateModificationShownInAdvancedSearch)
Set whether the modification date should be shown in advanced search
|
void |
setDateModificationShownInExport(boolean bDateModificationShownInExport)
Set whether the modification date should be exported
|
void |
setDateModificationShownInHistory(boolean bDateModificationShownInHistory)
Set whether the modification date should be shown in history
|
void |
setDateModificationShownInMultiSearch(boolean bDateModificationShownInMultiSearch)
Set whether the modification date should be shown in multi search
|
void |
setDateModificationShownInResultList(boolean bDateModificationShownInResultList)
Set whether the modification date should be shown in the result list
|
void |
setDateModificationShownInResultRecord(boolean bDateModificationShownInResultRecord)
Set whether the modification date should be shown in the result record
|
void |
setDateModificationShownInSearch(boolean bDateModificationShownInSearch)
Set whether the modification date should be shown in search
|
void |
setDateShownInAdvancedSearch(boolean bDateShownInAdvancedSearch)
Set whether the creation date should be shown in the advanced search
|
void |
setDateShownInExport(boolean bDateShownInExport)
Set whether the creation date should be exported
|
void |
setDateShownInHistory(boolean bDateShownInHistory)
Set whether the creation date should be shown in the history
|
void |
setDateShownInMultiSearch(boolean bDateShownInMultiSearch)
Set whether the creation date should be shown in the multi search
|
void |
setDateShownInResultList(boolean bDateShownInResultList)
Set whether the creation date should be shown in the result list
|
void |
setDateShownInResultRecord(boolean bDateShownInResultRecord)
Set whether the creation date should be shown in the result record
|
void |
setDateShownInSearch(boolean bDateShownInSearch)
Set whether the creation date should be shown in the search
|
void |
setDescription(String description)
set the description of the directory
|
void |
setDisplayComplementarySearchState(boolean displayState) |
void |
setDisplaySearchState(boolean displayState) |
void |
setEnabled(boolean enable)
set true if the directory is enabled
|
void |
setFrontOfficeTitle(String strFrontOfficeTitle)
set the front office title of the directory
|
void |
setIdDirectory(int idDirectory)
set the id of the directory
|
void |
setIdFormSearchTemplate(int idFormSearchTemplate)
set the id of the form search template
|
void |
setIdResultListTemplate(int idResultListTemplate)
set the id of the result list template
|
void |
setIdResultRecordTemplate(int idResultRecordTemplate)
set the id of the record template
|
void |
setIdSortEntry(String strIdSortEntry)
Set the id of the entry to sort
|
void |
setIdSortEntryFront(String strIdSortEntry)
set the id of the entry used for sorted
|
void |
setIdWorkflow(int nIdWorkflow)
set the id of the directory worflow
|
void |
setIdWorkflowStateToRemove(int nIdWorkflowStateToRemove)
Set the id of the workflow state of records that must be permanently
removed
|
void |
setIndexed(boolean bIsIndexed)
Set indexed
|
void |
setNumberRecordPerPage(int numberRecordPerPage)
the number of record display per page
|
void |
setRecordActivated(boolean bRecordActivated)
Set record activated or deactivated
|
void |
setRoleKey(String strRole)
Sets the directory's role
|
void |
setSearchOperatorOr(boolean bSearchOperatorOr) |
void |
setTitle(String strTitle)
set the title of the directory
|
void |
setUnavailabilityMessage(String unavailabilityMessage)
set the unavailability message of the directory
|
void |
setWorkgroup(String workGroup)
set the work group associate to the directory
|
public static final String ROLE_NONE
public static final String RESOURCE_TYPE
public static final int STATE_ENABLE
public static final int STATE_DISABLE
public static void init()
public String getTitle()
public void setTitle(String strTitle)
strTitle
- the title of the directorypublic String getFrontOfficeTitle()
public void setFrontOfficeTitle(String strFrontOfficeTitle)
strFrontOfficeTitle
- the front office title of the directorypublic String getDescription()
public boolean isDisplaySearchState()
public void setDisplaySearchState(boolean displayState)
displayState
- the _bDisplaySearchState to setpublic boolean isDisplayComplementarySearchState()
public void setDisplayComplementarySearchState(boolean displayState)
displayState
- the _bDisplayComplementarySearchState to setpublic void setDescription(String description)
description
- the description of the directorypublic String getUnavailabilityMessage()
public void setUnavailabilityMessage(String unavailabilityMessage)
unavailabilityMessage
- the unavailability message of the directorypublic String getWorkgroup()
getWorkgroup
in interface fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource
public void setWorkgroup(String workGroup)
workGroup
- the work group associate to the directorypublic int getIdDirectory()
public void setIdDirectory(int idDirectory)
idDirectory
- the id of the directorypublic boolean isEnabled()
public void setEnabled(boolean enable)
enable
- true if the directory is enabledpublic Timestamp getDateCreation()
public void setDateCreation(Timestamp dateCreation)
dateCreation
- the creation datepublic String getResourceTypeCode()
getResourceTypeCode
in interface fr.paris.lutece.portal.service.rbac.RBACResource
public String getResourceId()
getResourceId
in interface fr.paris.lutece.portal.service.rbac.RBACResource
public List<DirectoryAction> getActions()
public void setActions(List<DirectoryAction> directoryActions)
directoryActions
- a list of action must be use for the directorypublic String getRoleKey()
public void setRoleKey(String strRole)
strRole
- The rolepublic int getIdResultListTemplate()
public void setIdResultListTemplate(int idResultListTemplate)
idResultListTemplate
- the id of the result list templatepublic int getIdResultRecordTemplate()
public void setIdResultRecordTemplate(int idResultRecordTemplate)
idResultRecordTemplate
- the id of the record templatepublic int getIdFormSearchTemplate()
public int getNumberRecordPerPage()
public void setNumberRecordPerPage(int numberRecordPerPage)
numberRecordPerPage
- the number of record display per pagepublic void setIdFormSearchTemplate(int idFormSearchTemplate)
idFormSearchTemplate
- the id of the form search templatepublic int getIdWorkflow()
public void setIdWorkflow(int nIdWorkflow)
nIdWorkflow
- the id of the directory worflowpublic int getIdWorkflowStateToRemove()
public void setIdWorkflowStateToRemove(int nIdWorkflowStateToRemove)
nIdWorkflowStateToRemove
- The id of the workflow state of records
that must be permanently removedpublic boolean isDateShownInResultList()
public void setDateShownInResultList(boolean bDateShownInResultList)
bDateShownInResultList
- True if the creation date should be shown
in the result list, false otherwisepublic boolean isDateShownInResultRecord()
public void setDateShownInResultRecord(boolean bDateShownInResultRecord)
bDateShownInResultRecord
- True if the creation date should be shown
in the result record, false otherwisepublic boolean isDateShownInHistory()
public void setDateShownInHistory(boolean bDateShownInHistory)
bDateShownInHistory
- True if the creation date should be shown
in the history, false otherwisepublic boolean isDateShownInSearch()
public void setDateShownInSearch(boolean bDateShownInSearch)
bDateShownInSearch
- True if the creation date should be shown
in the search, false otherwisepublic boolean isDateShownInAdvancedSearch()
public void setDateShownInAdvancedSearch(boolean bDateShownInAdvancedSearch)
bDateShownInAdvancedSearch
- True if the creation date should be
shown in the advanced search, false otherwisepublic boolean isDateShownInMultiSearch()
public void setDateShownInMultiSearch(boolean bDateShownInMultiSearch)
bDateShownInMultiSearch
- True if the creation date should be shown
in the multi search, false otherwisepublic boolean isDateShownInExport()
public void setDateShownInExport(boolean bDateShownInExport)
bDateShownInExport
- True if the creation date should be
exported, false otherwisepublic boolean isDateModificationShownInResultList()
public void setDateModificationShownInResultList(boolean bDateModificationShownInResultList)
bDateModificationShownInResultList
- True if the modification date
should be shown in the result list, false otherwisepublic boolean isDateModificationShownInResultRecord()
public void setDateModificationShownInResultRecord(boolean bDateModificationShownInResultRecord)
bDateModificationShownInResultRecord
- True if the modification date
should be shown in the result record, false otherwisepublic boolean isDateModificationShownInHistory()
public void setDateModificationShownInHistory(boolean bDateModificationShownInHistory)
bDateModificationShownInHistory
- True if the modification date
should be shown in history, false otherwisepublic boolean isDateModificationShownInSearch()
public void setDateModificationShownInSearch(boolean bDateModificationShownInSearch)
bDateModificationShownInSearch
- True if the modification date
should be shown in search, false otherwisepublic boolean isDateModificationShownInAdvancedSearch()
public void setDateModificationShownInAdvancedSearch(boolean bDateModificationShownInAdvancedSearch)
bDateModificationShownInAdvancedSearch
- True if the modification
date should be shown in advanced search, false otherwisepublic boolean isDateModificationShownInMultiSearch()
public void setDateModificationShownInMultiSearch(boolean bDateModificationShownInMultiSearch)
bDateModificationShownInMultiSearch
- True if the modification
date should be shown in multi search, false otherwisepublic boolean isDateModificationShownInExport()
public void setDateModificationShownInExport(boolean bDateModificationShownInExport)
bDateModificationShownInExport
- True if the modification
date should be exported, false otherwisepublic boolean isAscendingSort()
public void setAscendingSort(boolean bAscendingSort)
bAscendingSort
- True if the sort is ascendent, false otherwisepublic String getIdSortEntry()
public void setIdSortEntry(String strIdSortEntry)
strIdSortEntry
- the id of the entry to sortpublic boolean isAscendingSortFront()
public void setAscendingSortFront(boolean bAscendingSort)
bAscendingSort
- return true if the record must be sorted by
ascending sortpublic String getIdSortEntryFront()
public void setIdSortEntryFront(String strIdSortEntry)
strIdSortEntry
- the id of the entry used for sortedpublic boolean isRecordActivated()
public void setRecordActivated(boolean bRecordActivated)
bRecordActivated
- True if record is activated, false otherwisepublic StringBuffer getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin, Locale locale, StringBuffer strListRecord, StringBuffer strListEntry)
plugin
- the pluginlocale
- the localestrListRecord
- the string list of record associate to the directorystrListEntry
- the string list of entry associate to the directorypublic void setIndexed(boolean bIsIndexed)
bIsIndexed
- true if the directory is indexed, false otherwisepublic boolean isIndexed()
public boolean isSearchOperatorOr()
public void setSearchOperatorOr(boolean bSearchOperatorOr)
_bSearchOperatorOr
- true if the search operator using is ORCopyright © 2016 City of Paris. All rights reserved.