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

java.lang.Object
  extended by fr.paris.lutece.plugins.directory.business.RecordFieldFilter

public class RecordFieldFilter
extends Object

class RecordFieldFilter


Field Summary
static int ALL_INT
           
static int FILTER_FALSE
           
static int FILTER_TRUE
           
static int ORDER_ASC
           
static int ORDER_DESC
           
static int ORDER_NONE
           
 
Constructor Summary
RecordFieldFilter()
           
 
Method Summary
 boolean containsDateFirst()
           
 boolean containsDateLast()
           
 boolean containsIdDirectory()
           
 boolean containsIdEntry()
           
 boolean containsIdField()
           
 boolean containsIdRecord()
           
 boolean containsIsDisabled()
           
 boolean containsIsEntryShownInResultList()
           
 boolean containsIsEntryShownInResultRecord()
           
 boolean containsRoleKeyList()
          Test if the filter contains at least one role key
 boolean containsSortEntry()
          true if an entry should be used to sort the results, false otherwise
 boolean containsSortOrder()
          Return true if sort order is not ORDER_NONE
 boolean containsWorkgroupKeyList()
           
 Timestamp getDateFirst()
           
 Timestamp getDateLast()
           
 int getIdDirectory()
           
 int getIdEntry()
           
 int getIdField()
           
 int getIdRecord()
           
 int getIsDisabled()
           
 int getIsEntryShownInResultList()
           
 int getIsEntryShownInResultRecord()
           
 List<String> getRoleKeyList()
          Get the role key list
 IEntry getSortEntry()
          Gets the entry that should be used to sort the results
 int getSortOrder()
          Gets the sort order.
 fr.paris.lutece.util.ReferenceList getWorkgroupKeyList()
          Get workgroup key list
 boolean includeRoleNull()
           
 boolean isOrderByDateModification()
          Order by date modification
 void setDateFirst(Timestamp begin)
          set the date of the first submit
 void setDateLast(Timestamp end)
          set the date of the last submit
 void setIdDirectory(int idDirectory)
          set the id of directory in the filter
 void setIdEntry(int idEntry)
          set the id of entry depend in the filter
 void setIdField(int idField)
          set the id of field depend in the filter
 void setIdRecord(int idRecord)
          set the id of record in the filter
 void setIsDisabled(int idState)
          Set 1 if the recors return must be enabled 0 if the record return must be disabled
 void setIsEntryShownInResultList(int nIsShown)
          set 1 if the entry associate to the record field must be in the result list, O if the entry associate to the record field must not be in the result list
 void setIsEntryShownInResultRecord(int nIsShown)
          set 1 if the entry associate to the record field must be in the result record, O if the entry associate to the record field must not be in the result record
 void setOrderByDateModification(boolean bOrderByDateModification)
          Set order by date modification
 void setRoleKeyList(List<String> roleKeyList, boolean bIncludeRoleNone, boolean bIncludeRoleNull)
          Set the role key list
 void setSortEntry(IEntry sortEntry)
          Set the entry that should be used to sort the results
 void setSortOrder(int nSortOrder)
          Sets the sort order.
 void setWorkgroupKeyList(fr.paris.lutece.util.ReferenceList workgroupKeyList)
          The workgroup key list to set
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_INT

public static final int ALL_INT
See Also:
Constant Field Values

FILTER_FALSE

public static final int FILTER_FALSE
See Also:
Constant Field Values

FILTER_TRUE

public static final int FILTER_TRUE
See Also:
Constant Field Values

ORDER_NONE

public static final int ORDER_NONE
See Also:
Constant Field Values

ORDER_ASC

public static final int ORDER_ASC
See Also:
Constant Field Values

ORDER_DESC

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

RecordFieldFilter

public RecordFieldFilter()
Method Detail

getSortEntry

public IEntry getSortEntry()
Gets the entry that should be used to sort the results

Returns:
the entry that should be used to sort the results

setSortEntry

public void setSortEntry(IEntry sortEntry)
Set the entry that should be used to sort the results

Parameters:
sortEntry - the entry to use to sort the results, null to use default sort (creation date).

containsSortEntry

public boolean containsSortEntry()
true if an entry should be used to sort the results, false otherwise

Returns:
true if an entry should be used to sort the results, false otherwise.

getSortOrder

public int getSortOrder()
Gets the sort order. Default is ORDER_NONE

Returns:
the sort order
See Also:
ORDER_ASC, ORDER_DESC, ORDER_NONE

setSortOrder

public void setSortOrder(int nSortOrder)
Sets the sort order. Use it with setSortEntry(IEntry)

Parameters:
nSortOrder - the sort order.
See Also:
ORDER_ASC, ORDER_DESC, ORDER_NONE

containsSortOrder

public boolean containsSortOrder()
Return true if sort order is not ORDER_NONE

Returns:
true if sort order is not ORDER_NONE, false otherwise.

getIdDirectory

public int getIdDirectory()
Returns:
the id of directory insert in the filter

setIdDirectory

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

Parameters:
idDirectory - the id of directory to insert in the filter

containsIdDirectory

public boolean containsIdDirectory()
Returns:
true if the filter contain an id of directory

getIdRecord

public int getIdRecord()
Returns:
the id of record insert in the filter

setIdRecord

public void setIdRecord(int idRecord)
set the id of record in the filter

Parameters:
idRecord - the id of the record to insert in the filter

containsIdRecord

public boolean containsIdRecord()
Returns:
true if the filter contain an id of record

getIdField

public int getIdField()
Returns:
the id of field insert in the filter

setIdField

public void setIdField(int idField)
set the id of field depend in the filter

Parameters:
idField - the id of field depend to insert in the filter

containsIdField

public boolean containsIdField()
Returns:
true if the filter contain an id of field depend

getIdEntry

public int getIdEntry()
Returns:
the id of entry insert in the filter

setIdEntry

public void setIdEntry(int idEntry)
set the id of entry depend in the filter

Parameters:
idEntry - the id of entry depend to insert in the filter

containsIdEntry

public boolean containsIdEntry()
Returns:
true if the filter contain an id of entry depend

getDateFirst

public Timestamp getDateFirst()
Returns:
date of the first submit

setDateFirst

public void setDateFirst(Timestamp begin)
set the date of the first submit

Parameters:
begin - date of the first submit

containsDateFirst

public boolean containsDateFirst()
Returns:
true if the filter contain the date of the first submit

getDateLast

public Timestamp getDateLast()
Returns:
date of the last submit

setDateLast

public void setDateLast(Timestamp end)
set the date of the last submit

Parameters:
end - the date of the last submit

containsDateLast

public boolean containsDateLast()
Returns:
true if the filter contain the date of the last submit

getIsEntryShownInResultList

public int getIsEntryShownInResultList()
Returns:
1 if the entry associate to the record field must be in the result list, O if the entry associate to the record field must not be in the result list

setIsEntryShownInResultList

public void setIsEntryShownInResultList(int nIsShown)
set 1 if the entry associate to the record field must be in the result list, O if the entry associate to the record field must not be in the result list

Parameters:
nIsShown - 1 if the entry associate to the record field must be in the result list

containsIsEntryShownInResultList

public boolean containsIsEntryShownInResultList()
Returns:
true if the filter is initialized

getIsEntryShownInResultRecord

public int getIsEntryShownInResultRecord()
Returns:
1 if the entry associate to the record field must be in the result record, O if the entry associate to the record field must not be in the result record

setIsEntryShownInResultRecord

public void setIsEntryShownInResultRecord(int nIsShown)
set 1 if the entry associate to the record field must be in the result record, O if the entry associate to the record field must not be in the result record

Parameters:
nIsShown - 1 if the entry associate to the record field must be in the result record

containsIsEntryShownInResultRecord

public boolean containsIsEntryShownInResultRecord()
Returns:
true if the filter is initialized

getIsDisabled

public int getIsDisabled()
Returns:
1 if the record return must be enabled 0 if the record return must be disabled

setIsDisabled

public void setIsDisabled(int idState)
Set 1 if the recors return must be enabled 0 if the record return must be disabled

Parameters:
idState - 1 if the record return must be enabled 0 if the record return must be disabled

containsIsDisabled

public boolean containsIsDisabled()
Returns:
true if the filter contain form state

setWorkgroupKeyList

public void setWorkgroupKeyList(fr.paris.lutece.util.ReferenceList workgroupKeyList)
The workgroup key list to set

Parameters:
workgroupKeyList - The workgroup key list

setRoleKeyList

public void setRoleKeyList(List<String> roleKeyList,
                           boolean bIncludeRoleNone,
                           boolean bIncludeRoleNull)
Set the role key list

Parameters:
roleKeyList - The role key list
bIncludeRoleNone - include role set to "none"
bIncludeRoleNull - include role set to "null"

containsRoleKeyList

public boolean containsRoleKeyList()
Test if the filter contains at least one role key

Returns:
true if the filter contain role key list

getRoleKeyList

public List<String> getRoleKeyList()
Get the role key list

Returns:
the role key list

includeRoleNull

public boolean includeRoleNull()
Returns:
the _bIncludeRoleNull

getWorkgroupKeyList

public fr.paris.lutece.util.ReferenceList getWorkgroupKeyList()
Get workgroup key list

Returns:
The workgroup key list

containsWorkgroupKeyList

public boolean containsWorkgroupKeyList()
Returns:
true if the filter contain workgroup key list

setOrderByDateModification

public void setOrderByDateModification(boolean bOrderByDateModification)
Set order by date modification

Parameters:
bOrderByDateModification - true if filter by date modification

isOrderByDateModification

public boolean isOrderByDateModification()
Order by date modification

Returns:
order by date modification


Copyright © 2013 Mairie de Paris. All Rights Reserved.