fr.paris.lutece.plugins.directory.business
Class Directory

java.lang.Object
  extended by fr.paris.lutece.plugins.directory.business.Directory
All Implemented Interfaces:
fr.paris.lutece.portal.service.rbac.RBACResource, fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource

public class Directory
extends Object
implements fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource, fr.paris.lutece.portal.service.rbac.RBACResource

Class Directory


Field Summary
static String RESOURCE_TYPE
           
static String ROLE_NONE
           
static int STATE_DISABLE
           
static int STATE_ENABLE
           
 
Constructor Summary
Directory()
           
 
Method Summary
 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()
           
 String getIdSortEntryFront()
          return the id of the entry used for sorted
 int getIdWorkflow()
           
 int getNumberRecordPerPage()
           
 String getResourceId()
          RBAC resource implementation
 String getResourceTypeCode()
          RBAC resource implementation
 String getRoleKey()
          Gets the directory role
 String getTitle()
           
 String getUnavailabilityMessage()
           
 String getWorkgroup()
           
 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()
           
 boolean isAscendingSortFront()
          return true if the record must be sorted by ascending sort
 boolean isDateModificationShownInAdvancedSearch()
           
 boolean isDateModificationShownInExport()
           
 boolean isDateModificationShownInHistory()
           
 boolean isDateModificationShownInMultiSearch()
           
 boolean isDateModificationShownInResultList()
           
 boolean isDateModificationShownInResultRecord()
           
 boolean isDateModificationShownInSearch()
           
 boolean isDateShownInAdvancedSearch()
           
 boolean isDateShownInExport()
           
 boolean isDateShownInHistory()
           
 boolean isDateShownInMultiSearch()
           
 boolean isDateShownInResultList()
           
 boolean isDateShownInResultRecord()
           
 boolean isDateShownInSearch()
           
 boolean isDisplayComplementarySearchState()
           
 boolean isDisplaySearchState()
           
 boolean isEnabled()
           
 boolean isIndexed()
          Check if the directory is indexed
 boolean isRecordActivated()
           
 void setActions(List<DirectoryAction> directoryActions)
          set a list of action can be use for the directory
 void setAscendingSort(boolean bAscendingSort)
           
 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)
           
 void setDateModificationShownInExport(boolean bDateModificationShownInExport)
           
 void setDateModificationShownInHistory(boolean bDateModificationShownInHistory)
           
 void setDateModificationShownInMultiSearch(boolean bDateModificationShownInMultiSearch)
           
 void setDateModificationShownInResultList(boolean bDateModificationShownInResultList)
           
 void setDateModificationShownInResultRecord(boolean bDateModificationShownInResultRecord)
           
 void setDateModificationShownInSearch(boolean bDateModificationShownInSearch)
           
 void setDateShownInAdvancedSearch(boolean bDateShownInAdvancedSearch)
           
 void setDateShownInExport(boolean bDateShownInExport)
           
 void setDateShownInHistory(boolean bDateShownInHistory)
           
 void setDateShownInMultiSearch(boolean bDateShownInMultiSearch)
           
 void setDateShownInResultList(boolean bDateShownInResultList)
           
 void setDateShownInResultRecord(boolean bDateShownInResultRecord)
           
 void setDateShownInSearch(boolean bDateShownInSearch)
           
 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)
           
 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 setIndexed(boolean bIsIndexed)
          Set indexed
 void setNumberRecordPerPage(int numberRecordPerPage)
          the number of record display per page
 void setRecordActivated(boolean bRecordActivated)
           
 void setRoleKey(String strRole)
          Sets the directory's role
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROLE_NONE

public static final String ROLE_NONE
See Also:
Constant Field Values

RESOURCE_TYPE

public static final String RESOURCE_TYPE
See Also:
Constant Field Values

STATE_ENABLE

public static final int STATE_ENABLE
See Also:
Constant Field Values

STATE_DISABLE

public static final int STATE_DISABLE
See Also:
Constant Field Values
Constructor Detail

Directory

public Directory()
Method Detail

init

public static void init()
Initialize the Directory


getTitle

public String getTitle()
Returns:
the title of the directory

setTitle

public void setTitle(String strTitle)
set the title of the directory

Parameters:
strTitle - the title of the directory

getFrontOfficeTitle

public String getFrontOfficeTitle()
Returns:
the front office title of the directory

setFrontOfficeTitle

public void setFrontOfficeTitle(String strFrontOfficeTitle)
set the front office title of the directory

Parameters:
strFrontOfficeTitle - the front office title of the directory

getDescription

public String getDescription()
Returns:
the description of the directory

isDisplaySearchState

public boolean isDisplaySearchState()
Returns:
the _bDisplaySearchState

setDisplaySearchState

public void setDisplaySearchState(boolean displayState)
Parameters:
displayState - the _bDisplaySearchState to set

isDisplayComplementarySearchState

public boolean isDisplayComplementarySearchState()
Returns:
the _bDisplayComplementarySearchState

setDisplayComplementarySearchState

public void setDisplayComplementarySearchState(boolean displayState)
Parameters:
displayState - the _bDisplayComplementarySearchState to set

setDescription

public void setDescription(String description)
set the description of the directory

Parameters:
description - the description of the directory

getUnavailabilityMessage

public String getUnavailabilityMessage()
Returns:
the unavailability message of the directory

setUnavailabilityMessage

public void setUnavailabilityMessage(String unavailabilityMessage)
set the unavailability message of the directory

Parameters:
unavailabilityMessage - the unavailability message of the directory

getWorkgroup

public String getWorkgroup()
Specified by:
getWorkgroup in interface fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource
Returns:
the work group associate to the directory

setWorkgroup

public void setWorkgroup(String workGroup)
set the work group associate to the directory

Parameters:
workGroup - the work group associate to the directory

getIdDirectory

public int getIdDirectory()
Returns:
the id of the directory

setIdDirectory

public void setIdDirectory(int idDirectory)
set the id of the directory

Parameters:
idDirectory - the id of the directory

isEnabled

public boolean isEnabled()
Returns:
true if the directory is enabled

setEnabled

public void setEnabled(boolean enable)
set true if the directory is enabled

Parameters:
enable - true if the directory is enabled

getDateCreation

public Timestamp getDateCreation()
Returns:
the creation date

setDateCreation

public void setDateCreation(Timestamp dateCreation)
set the creation date

Parameters:
dateCreation - the creation date

getResourceTypeCode

public String getResourceTypeCode()
RBAC resource implementation

Specified by:
getResourceTypeCode in interface fr.paris.lutece.portal.service.rbac.RBACResource
Returns:
The resource type code

getResourceId

public String getResourceId()
RBAC resource implementation

Specified by:
getResourceId in interface fr.paris.lutece.portal.service.rbac.RBACResource
Returns:
The resourceId

getActions

public List<DirectoryAction> getActions()
Returns:
a list of action can be use for the directory

setActions

public void setActions(List<DirectoryAction> directoryActions)
set a list of action can be use for the directory

Parameters:
directoryActions - a list of action must be use for the directory

getRoleKey

public String getRoleKey()
Gets the directory role

Returns:
directory's role as a String

setRoleKey

public void setRoleKey(String strRole)
Sets the directory's role

Parameters:
strRole - The role

getIdResultListTemplate

public int getIdResultListTemplate()
return the id of the result list template

Returns:
the id of the result list template

setIdResultListTemplate

public void setIdResultListTemplate(int idResultListTemplate)
set the id of the result list template

Parameters:
idResultListTemplate - the id of the result list template

getIdResultRecordTemplate

public int getIdResultRecordTemplate()
return the id of the record template

Returns:
he id of the record template

setIdResultRecordTemplate

public void setIdResultRecordTemplate(int idResultRecordTemplate)
set the id of the record template

Parameters:
idResultRecordTemplate - the id of the record template

getIdFormSearchTemplate

public int getIdFormSearchTemplate()
return the id of the form search template

Returns:
the id of the form search template

getNumberRecordPerPage

public int getNumberRecordPerPage()
Returns:
the number of record display per page

setNumberRecordPerPage

public void setNumberRecordPerPage(int numberRecordPerPage)
the number of record display per page

Parameters:
numberRecordPerPage - the number of record display per page

setIdFormSearchTemplate

public void setIdFormSearchTemplate(int idFormSearchTemplate)
set the id of the form search template

Parameters:
idFormSearchTemplate - the id of the form search template

getIdWorkflow

public int getIdWorkflow()
Returns:
the id of the directory workflow

setIdWorkflow

public void setIdWorkflow(int nIdWorkflow)
set the id of the directory worflow

Parameters:
strTitle - the id of the directory worflow

isDateShownInResultList

public boolean isDateShownInResultList()

setDateShownInResultList

public void setDateShownInResultList(boolean bDateShownInResultList)

isDateShownInResultRecord

public boolean isDateShownInResultRecord()

setDateShownInResultRecord

public void setDateShownInResultRecord(boolean bDateShownInResultRecord)

isDateShownInHistory

public boolean isDateShownInHistory()

setDateShownInHistory

public void setDateShownInHistory(boolean bDateShownInHistory)

isDateShownInSearch

public boolean isDateShownInSearch()

setDateShownInSearch

public void setDateShownInSearch(boolean bDateShownInSearch)

isDateShownInAdvancedSearch

public boolean isDateShownInAdvancedSearch()

setDateShownInAdvancedSearch

public void setDateShownInAdvancedSearch(boolean bDateShownInAdvancedSearch)

isDateShownInMultiSearch

public boolean isDateShownInMultiSearch()

setDateShownInMultiSearch

public void setDateShownInMultiSearch(boolean bDateShownInMultiSearch)

isDateShownInExport

public boolean isDateShownInExport()

setDateShownInExport

public void setDateShownInExport(boolean bDateShownInExport)

isDateModificationShownInResultList

public boolean isDateModificationShownInResultList()

setDateModificationShownInResultList

public void setDateModificationShownInResultList(boolean bDateModificationShownInResultList)

isDateModificationShownInResultRecord

public boolean isDateModificationShownInResultRecord()

setDateModificationShownInResultRecord

public void setDateModificationShownInResultRecord(boolean bDateModificationShownInResultRecord)

isDateModificationShownInHistory

public boolean isDateModificationShownInHistory()

setDateModificationShownInHistory

public void setDateModificationShownInHistory(boolean bDateModificationShownInHistory)

isDateModificationShownInSearch

public boolean isDateModificationShownInSearch()

setDateModificationShownInSearch

public void setDateModificationShownInSearch(boolean bDateModificationShownInSearch)

isDateModificationShownInAdvancedSearch

public boolean isDateModificationShownInAdvancedSearch()

setDateModificationShownInAdvancedSearch

public void setDateModificationShownInAdvancedSearch(boolean bDateModificationShownInAdvancedSearch)

isDateModificationShownInMultiSearch

public boolean isDateModificationShownInMultiSearch()

setDateModificationShownInMultiSearch

public void setDateModificationShownInMultiSearch(boolean bDateModificationShownInMultiSearch)

isDateModificationShownInExport

public boolean isDateModificationShownInExport()

setDateModificationShownInExport

public void setDateModificationShownInExport(boolean bDateModificationShownInExport)

isAscendingSort

public boolean isAscendingSort()

setAscendingSort

public void setAscendingSort(boolean bAscendingSort)

getIdSortEntry

public String getIdSortEntry()

setIdSortEntry

public void setIdSortEntry(String strIdSortEntry)

isAscendingSortFront

public boolean isAscendingSortFront()
return true if the record must be sorted by ascending sort

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

setAscendingSortFront

public void setAscendingSortFront(boolean bAscendingSort)
set true if the record must be sorted by ascending sort in front office

Parameters:
bAscendingSort - return true if the record must be sorted by ascending sort

getIdSortEntryFront

public String getIdSortEntryFront()
return the id of the entry used for sorted

Returns:
the id of the entry used for sorted

setIdSortEntryFront

public void setIdSortEntryFront(String strIdSortEntry)
set the id of the entry used for sorted

Parameters:
strIdSortEntry - the id of the entry used for sorted

isRecordActivated

public boolean isRecordActivated()

setRecordActivated

public void setRecordActivated(boolean bRecordActivated)

getXml

public StringBuffer getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                           Locale locale,
                           StringBuffer strListRecord,
                           StringBuffer strListEntry)
return the xml of the directory

Parameters:
plugin - the plugin
locale - the locale
strListRecord - the string list of record associate to the directory
strListEntry - the string list of entry associate to the directory
Returns:
xml

setIndexed

public void setIndexed(boolean bIsIndexed)
Set indexed

Parameters:
bIsIndexed - true if the directory is indexed, false otherwise

isIndexed

public boolean isIndexed()
Check if the directory is indexed

Returns:
true if the directory is indexed, false otherwise


Copyright © 2013 Mairie de Paris. All Rights Reserved.