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 java.lang.Object
implements fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource, fr.paris.lutece.portal.service.rbac.RBACResource

Class Directory


Field Summary
static java.lang.String RESOURCE_TYPE
           
static java.lang.String ROLE_NONE
           
static int STATE_DISABLE
           
static int STATE_ENABLE
           
 
Constructor Summary
Directory()
           
 
Method Summary
 java.util.List<DirectoryAction> getActions()
           
 java.sql.Timestamp getDateCreation()
           
 java.lang.String getDescription()
           
 int getIdDirectory()
           
 int getIdFormSearchTemplate()
          return the id of the form search template
 int getIdResultIsGeolocalized()
          Returns -1 if not localized, 1 otherwise
 int getIdResultListTemplate()
          return the id of the result list template
 int getIdResultRecordTemplate()
          return the id of the record template
 int getIdWorkflow()
           
 int getNumberRecordPerPage()
           
 java.lang.String getResourceId()
          RBAC resource implementation
 java.lang.String getResourceTypeCode()
          RBAC resource implementation
 java.lang.String getRoleKey()
          Gets the directory role
 java.lang.String getTitle()
           
 java.lang.String getUnavailabilityMessage()
           
 java.lang.String getWorkgroup()
           
 java.lang.StringBuffer getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale, java.lang.StringBuffer strListRecord, java.lang.StringBuffer strListEntry)
          return the xml of the directory
static void init()
          Initialize the Directory
 boolean isDisplayComplementarySearchState()
           
 boolean isDisplaySearchState()
           
 boolean isEnabled()
           
 void setActions(java.util.List<DirectoryAction> directoryActions)
          set a list of action can be use for the directory
 void setDateCreation(java.sql.Timestamp dateCreation)
          set the creation date
 void setDescription(java.lang.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 setIdDirectory(int idDirectory)
          set the id of the directory
 void setIdFormSearchTemplate(int idFormSearchTemplate)
          set the id of the form search template
 void setIdResultIsGeolocalized(int nIdResultIsGeolocalized)
          Put -1 if not localized, 1 otherwise
 void setIdResultListTemplate(int idResultListTemplate)
          set the id of the result list template
 void setIdResultRecordTemplate(int idResultRecordTemplate)
          set the id of the record template
 void setIdWorkflow(int nIdWorkflow)
          set the id of the directory worflow
 void setNumberRecordPerPage(int numberRecordPerPage)
          the number of record display per page
 void setRoleKey(java.lang.String strRole)
          Sets the directory's role
 void setTitle(java.lang.String strTitle)
          set the title of the directory
 void setUnavailabilityMessage(java.lang.String unavailabilityMessage)
          set the unavailability message of the directory
 void setWorkgroup(java.lang.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 java.lang.String ROLE_NONE
See Also:
Constant Field Values

RESOURCE_TYPE

public static final java.lang.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 java.lang.String getTitle()
Returns:
the title of the directory

setTitle

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

Parameters:
strTitle - the title of the directory

getDescription

public java.lang.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(java.lang.String description)
set the description of the directory

Parameters:
description - the description of the directory

getUnavailabilityMessage

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

setUnavailabilityMessage

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

Parameters:
unavailabilityMessage - the unavailability message of the directory

getWorkgroup

public java.lang.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(java.lang.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 java.sql.Timestamp getDateCreation()
Returns:
the creation date

setDateCreation

public void setDateCreation(java.sql.Timestamp dateCreation)
set the creation date

Parameters:
dateCreation - the creation date

getResourceTypeCode

public java.lang.String getResourceTypeCode()
RBAC resource implementation

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

getResourceId

public java.lang.String getResourceId()
RBAC resource implementation

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

getActions

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

setActions

public void setActions(java.util.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 java.lang.String getRoleKey()
Gets the directory role

Returns:
directory's role as a String

setRoleKey

public void setRoleKey(java.lang.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

getIdResultIsGeolocalized

public int getIdResultIsGeolocalized()
Returns -1 if not localized, 1 otherwise

Returns:
the _nIdResultIsGeolocalized

setIdResultIsGeolocalized

public void setIdResultIsGeolocalized(int nIdResultIsGeolocalized)
Put -1 if not localized, 1 otherwise

Parameters:
nIdResultIsGeolocalized - the _nIdResultIsGeolocalized to set

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

getXml

public java.lang.StringBuffer getXml(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                     java.util.Locale locale,
                                     java.lang.StringBuffer strListRecord,
                                     java.lang.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


Copyright © 2009 Mairie de Paris. All Rights Reserved.