com.whitestein.lsps.os.dto

Class PersonCriteria

java.lang.Object

com.whitestein.lsps.common.query.PagingCriteria

com.whitestein.lsps.os.dto.PersonCriteria

All Implemented Interfaces:

Serializable

public class PersonCriteria
extends PagingCriteria

Supports paged results of persons. The class also provides filtering of the persons using several attributes (e.g. loginNamePattern, detailPattern). If an attribute is set to null (which is the default value) this attribute will not be considered during the filtering process.

Note that by default only active users are returned. If you need to list only the disabled users, set the active property to false, if both active and disabled users are needed, set the property to null.

Since:

1.1

Author:

vgr

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.common.query.PagingCriteria

PagingCriteria.DynamicOrdering

Constructor Summary

Constructors

Constructor and Description
PersonCriteria() Creates new instance with disabled paging.
PersonCriteria(int count) Creates new instance with enabled paging and given result count.
PersonCriteria(int index, int count) Creates new instance with enabled paging and given index and result count.

Method Summary

Modifier and Type	Method and Description
String	getDetailPattern(String detailName) Returns the string pattern of a person detail identified by given detail name, or null if the detail with given name does not exist.
Map<String,String>	getDetailPatterns() Returns a map of person detail patterns.
String	getEmailPattern() Returns the email pattern.
Boolean	getEnabled()
Collection<String>	getExcludePersonIds() Returns the exclude person ids collection.
String	getFirstNamePattern() Returns the first name pattern.
String	getFullNameAndLoginPattern()
String	getId()
Collection<String>	getIncludePersonIds() Returns the include person ids collection.
RoleUnitName	getInRole() Returns the in role constraint.
String	getLastNamePattern() Returns the last name pattern.
String	getLoginNamePattern() Returns the string pattern used to filter persons by their login name.
PersonOrdering	getOrdering() Returns the ordering.
String	getPhonePattern() Returns the phone pattern.
Boolean	isActive() Returns the active flag used to filter persons according to their active state.
boolean	isFirstNamePatternCaseInsensitive() Returns true if the first name pattern is case insensitive.
boolean	isFullNameAndLoginPatternCaseInsensitive()
boolean	isIncludeSubstitution() Returns whether to include substitution information (default false).
boolean	isLastNamePatternCaseInsensitive() Returns true if the last name pattern is case insensitive.
boolean	isLoginNamePatternCaseInsensitive() Returns true if the login pattern is case insensitive.
void	setActive(Boolean active) Sets the active flag used to filter persons according to their active state.
PersonCriteria	setDetailPattern(String detailName, String detailPattern) Sets the string pattern of a person detail identified by given detail name.
void	setEmailPattern(String emailPattern) Sets the email pattern.
void	setEnabled(Boolean value)
void	setExcludeLoginNames(Collection<String> excludePersonIds) Sets the exclude person ids collection.
void	setFirstNamePattern(String firstNamePattern) Sets the first name pattern.
void	setFirstNamePatternCaseInsensitive(boolean firstNamePatternCaseInsensitive) Specifies whether the first name pattern filtering is case insensitive.
void	setFullNameAndLoginPattern(String fullNameAndLoginPattern)
void	setFullNameAndLoginPatternCaseInsensitive(boolean fullNameAndLoginPatternCaseInsensitive)
void	setId(String id)
void	setIncludePersonIds(Collection<String> includePersonIds) Sets the include person ids collection.
void	setIncludeSubstitution(boolean includeSubstitution) Sets whether to include substitution information (default false).
void	setInRole(RoleUnitName role) Sets the in role constraint.
void	setLastNamePattern(String lastNamePattern) Sets the last name pattern.
void	setLastNamePatternCaseInsensitive(boolean lastNamePatternCaseInsensitive) Specifies whether the last name pattern filtering is case insensitive.
void	setLoginNamePattern(String loginNamePattern) Sets the string pattern used to filter persons by their login name.
void	setLoginNamePatternCaseInsensitive(boolean loginNamePatternCaseInsensitive) Specifies whether the login pattern filtering is case insensitive.
void	setOrdering(PersonColumn column) Sets the ascending ordering for the given column.
void	setOrdering(PersonColumn column, OrderDirection direction) Sets the ordering using the given column and direction.
void	setOrdering(PersonOrdering ordering) Sets the ordering.
void	setPhonePattern(String phonePattern) Sets the phone pattern.
String	toString()

Methods inherited from class com.whitestein.lsps.common.query.PagingCriteria

getCount, getDynamicOrdering, getFilters, getIndex, isPaged, setCount, setDynamicOrdering, setFilters, setIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PersonCriteria

public PersonCriteria()

Creates new instance with disabled paging.

PersonCriteria

public PersonCriteria(int count)

Creates new instance with enabled paging and given result count.

Parameters:

count - The maximum number of results to retrieve.

PersonCriteria

public PersonCriteria(int index,
                      int count)

Creates new instance with enabled paging and given index and result count.

Parameters:

index - The position of the first result to retrieve.

count - The maximum number of results to retrieve.

Method Detail

getLoginNamePattern

public String getLoginNamePattern()

Returns the string pattern used to filter persons by their login name.

Returns:

The string pattern used to filter persons by their login name or null if this pattern is not set.

isActive

public Boolean isActive()

Returns the active flag used to filter persons according to their active state.

Returns:

the active flag

setLoginNamePattern

public void setLoginNamePattern(String loginNamePattern)

Sets the string pattern used to filter persons by their login name.

Parameters:

loginNamePattern - The string pattern used to filter persons by their login name.

isLoginNamePatternCaseInsensitive

public boolean isLoginNamePatternCaseInsensitive()

Returns true if the login pattern is case insensitive.

Returns:

true if the login pattern is case insensitive

setLoginNamePatternCaseInsensitive

public void setLoginNamePatternCaseInsensitive(boolean loginNamePatternCaseInsensitive)

Specifies whether the login pattern filtering is case insensitive.

Parameters:

loginNamePatternCaseInsensitive -

getFirstNamePattern

public String getFirstNamePattern()

Returns the first name pattern.

Returns:

the first name pattern

setFirstNamePattern

public void setFirstNamePattern(String firstNamePattern)

Sets the first name pattern.

Parameters:

firstNamePattern -

isFirstNamePatternCaseInsensitive

public boolean isFirstNamePatternCaseInsensitive()

Returns true if the first name pattern is case insensitive.

Returns:

true if the first name pattern is case insensitive

setFirstNamePatternCaseInsensitive

public void setFirstNamePatternCaseInsensitive(boolean firstNamePatternCaseInsensitive)

Specifies whether the first name pattern filtering is case insensitive.

Parameters:

firstNamePatternCaseInsensitive -

getLastNamePattern

public String getLastNamePattern()

Returns the last name pattern.

Returns:

the last name pattern

setLastNamePattern

public void setLastNamePattern(String lastNamePattern)

Sets the last name pattern.

Parameters:

lastNamePattern -

isLastNamePatternCaseInsensitive

public boolean isLastNamePatternCaseInsensitive()

Returns true if the last name pattern is case insensitive.

Returns:

true if the last name pattern is case insensitive

setLastNamePatternCaseInsensitive

public void setLastNamePatternCaseInsensitive(boolean lastNamePatternCaseInsensitive)

Specifies whether the last name pattern filtering is case insensitive.

Parameters:

lastNamePatternCaseInsensitive -

getEmailPattern

public String getEmailPattern()

Returns the email pattern.

Returns:

the email pattern

setEmailPattern

public void setEmailPattern(String emailPattern)

Sets the email pattern.

Parameters:

emailPattern -

getPhonePattern

public String getPhonePattern()

Returns the phone pattern.

Returns:

the phone pattern

setPhonePattern

public void setPhonePattern(String phonePattern)

Sets the phone pattern.

Parameters:

phonePattern -

setActive

public void setActive(Boolean active)

Sets the active flag used to filter persons according to their active state.

Parameters:

active -

getDetailPatterns

public Map<String,String> getDetailPatterns()

Returns a map of person detail patterns.

Returns:

A map of person detail patterns.

getDetailPattern

public String getDetailPattern(String detailName)

Returns the string pattern of a person detail identified by given detail name, or null if the detail with given name does not exist.

Parameters:

detailName - The name of a person detail. Cannot be null.

Returns:

The string pattern of a person detail identified by given detail name, or null if the detail with given name does not exist.

Throws:

NullPointerException - (unchecked) If the detailName argument is null.

setDetailPattern

public PersonCriteria setDetailPattern(String detailName,
                                       String detailPattern)

Sets the string pattern of a person detail identified by given detail name.

Parameters:

detailName - The name of a person detail. Cannot be null.

detailPattern - The string pattern of given person detail. If set to null, the detail pattern with given name will be removed from the detail patterns.

Returns:

Current PersonCriteria instance.

Throws:

NullPointerException - (unchecked) If the detailName argument is null.

getIncludePersonIds

public Collection<String> getIncludePersonIds()

Returns the include person ids collection.

Returns:

the include person ids collection

getExcludePersonIds

public Collection<String> getExcludePersonIds()

Returns the exclude person ids collection.

Returns:

the exclude person ids collection

setIncludePersonIds

public void setIncludePersonIds(Collection<String> includePersonIds)

Sets the include person ids collection.

Parameters:

includePersonIds -

setExcludeLoginNames

public void setExcludeLoginNames(Collection<String> excludePersonIds)

Sets the exclude person ids collection.

Parameters:

excludePersonIds -

getInRole

public RoleUnitName getInRole()

Returns the in role constraint.

Returns:

the in role constraint

setInRole

public void setInRole(RoleUnitName role)

Sets the in role constraint.

Parameters:

role -

isIncludeSubstitution

public boolean isIncludeSubstitution()

Returns whether to include substitution information (default false).

Returns:

whether to include substitution information (default false)

setIncludeSubstitution

public void setIncludeSubstitution(boolean includeSubstitution)

Sets whether to include substitution information (default false).

Parameters:

includeSubstitution -

toString

public String toString()

Overrides:

toString in class Object

getOrdering

public PersonOrdering getOrdering()

Returns the ordering.

Returns:

the ordering

setOrdering

public void setOrdering(PersonOrdering ordering)

Sets the ordering.

Parameters:

ordering -

setOrdering

public void setOrdering(PersonColumn column)

Sets the ascending ordering for the given column.

Parameters:

column -

setOrdering

public void setOrdering(PersonColumn column,
                        OrderDirection direction)

Sets the ordering using the given column and direction.

Parameters:

column -

direction -

setId

public void setId(String id)

getId

public String getId()

setEnabled

public void setEnabled(Boolean value)

getEnabled

public Boolean getEnabled()

getFullNameAndLoginPattern

public String getFullNameAndLoginPattern()

setFullNameAndLoginPattern

public void setFullNameAndLoginPattern(String fullNameAndLoginPattern)

isFullNameAndLoginPatternCaseInsensitive

public boolean isFullNameAndLoginPatternCaseInsensitive()

setFullNameAndLoginPatternCaseInsensitive

public void setFullNameAndLoginPatternCaseInsensitive(boolean fullNameAndLoginPatternCaseInsensitive)