ModuleCriteria (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.common.query.PagingCriteria
- - com.whitestein.lsps.engine.dto.ModuleCriteria

All Implemented Interfaces:

Serializable
```
public class ModuleCriteria
extends PagingCriteria
```
Class for defining search criteria for modules with paging capability.

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

ModuleCriteria()
Default constructor

ModuleCriteria(int count)

ModuleCriteria(int index, int count)

Constructors
Constructor and Description
`ModuleCriteria()` Default constructor
`ModuleCriteria(int count)`
`ModuleCriteria(int index, int count)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescriptionPattern()`
`Boolean`	`getExecatubale()`
`String`	`getHash()` Returns the module hash.
`Long`	`getId()`
`String`	`getNamePattern()` getter for name pattern
`ModuleOrdering`	`getOrdering()` Returns the ordering.
`Date`	`getUploadedFrom()`
`Date`	`getUploadedTo()`
`String`	`getVersionPattern()` gets version pattern
`boolean`	`isIncludeEntries()` Returns true if the module entries are to be included (default false).
`boolean`	`isIncludeExecutableOnly()` Returns true if only the executable modules are to be included (default false).
`boolean`	`isIncludeImports()` Returns true if the imported modules are to be included (default false).
`boolean`	`isIncludeLatestOnly()` Returns true if only the latest uploaded modules should be included (default false).
`boolean`	`isIncludeSystem()` Returns true if the system modules are to be included (default false).
`boolean`	`isIncludeUnloaded()` Returns true if the unloaded modules are to be included (default false).
`boolean`	`isNamePatternCaseInsensitive()`
`boolean`	`isVersionPatternCaseInsensitive()`
`void`	`setDescriptionPattern(String pattern)`
`void`	`setExecutable(Boolean value)`
`void`	`setHash(String hash)` Sets the module hash
`void`	`setId(Long id)`
`void`	`setIncludeEntries(boolean includeEntries)` Sets whether the module entries are to be included (default false).
`void`	`setIncludeExecutableOnly(boolean includeExecutableOnly)` Sets whether only the executable modules are to be included (default false).
`void`	`setIncludeImports(boolean includeImports)` Sets whether the imported modules are to be included (default false).
`void`	`setIncludeLatestOnly(boolean latestOnly)` Sets including of only the latest uploaded modules (default false).
`void`	`setIncludeSystem(boolean includeSystem)` Sets whether the system modules are to be included (default false).
`void`	`setIncludeUnloaded(boolean includeUnloaded)` Sets whether the unloaded modules are to be included (default false).
`void`	`setNamePattern(String namePattern)` set name pattern
`void`	`setNamePatternCaseInsensitive(boolean namePatternCaseInsensitive)` Sets the value of a flag specifying whether the name pattern is case insensitive.
`void`	`setOrdering(ModuleColumn column, OrderDirection direction)` Sets the ordering using the given column and direction.
`void`	`setUploadedFrom(Date from)`
`void`	`setUploadedTo(Date to)`
`void`	`setVersionPattern(String versionPattern)` setter for version pattern
`void`	`setVersionPatternCaseInsensitive(boolean versionPatternCaseInsensitive)` Sets the value of a flag specifying whether the version pattern is case insensitive.

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, toString, wait, wait, wait

- Constructor Detail
  - ModuleCriteria
```
public ModuleCriteria()
```
    Default constructor
  - ModuleCriteria
```
public ModuleCriteria(int index,
                      int count)
```
    Parameters:
    
    index -
    
    count -
  - ModuleCriteria
```
public ModuleCriteria(int count)
```
    Parameters:
    
    count -
- Method Detail
  - getNamePattern
```
public String getNamePattern()
```
    getter for name pattern
    
    Returns:
    
    string name pattern
  - setNamePattern
```
public void setNamePattern(String namePattern)
```
    set name pattern
    
    Parameters:
    
    namePattern -
  - isNamePatternCaseInsensitive
```
public boolean isNamePatternCaseInsensitive()
```
    Returns:
    
    true if the name pattern is case insensitive
  - setNamePatternCaseInsensitive
```
public void setNamePatternCaseInsensitive(boolean namePatternCaseInsensitive)
```
    Sets the value of a flag specifying whether the name pattern is case insensitive.
    
    Parameters:
    
    namePatternCaseInsensitive -
  - getVersionPattern
```
public String getVersionPattern()
```
    gets version pattern
    
    Returns:
    
    string version pattern
  - setVersionPattern
```
public void setVersionPattern(String versionPattern)
```
    setter for version pattern
    
    Parameters:
    
    versionPattern -
  - isVersionPatternCaseInsensitive
```
public boolean isVersionPatternCaseInsensitive()
```
    Returns:
    
    true if the version pattern is case insensitive
  - setVersionPatternCaseInsensitive
```
public void setVersionPatternCaseInsensitive(boolean versionPatternCaseInsensitive)
```
    Sets the value of a flag specifying whether the version pattern is case insensitive.
    
    Parameters:
    
    versionPatternCaseInsensitive -
  - getHash
```
public String getHash()
```
    Returns the module hash.
    
    Returns:
    
    hash
  - setHash
```
public void setHash(String hash)
```
    Sets the module hash
    
    Parameters:
    
    hash -
  - isIncludeLatestOnly
```
public boolean isIncludeLatestOnly()
```
    Returns true if only the latest uploaded modules should be included (default false).
    
    Returns:
    
    true if only the latest uploaded modules should be included (default false)
  - setIncludeLatestOnly
```
public void setIncludeLatestOnly(boolean latestOnly)
```
    Sets including of only the latest uploaded modules (default false).
    
    Parameters:
    
    latestOnly -
  - isIncludeSystem
```
public boolean isIncludeSystem()
```
    Returns true if the system modules are to be included (default false).
    
    Returns:
    
    true if the system modules are to be included (default false)
  - setIncludeSystem
```
public void setIncludeSystem(boolean includeSystem)
```
    Sets whether the system modules are to be included (default false).
    
    Parameters:
    
    includeSystem -
  - isIncludeUnloaded
```
public boolean isIncludeUnloaded()
```
    Returns true if the unloaded modules are to be included (default false).
    
    Returns:
    
    true if the unloaded modules are to be included (default false)
  - setIncludeUnloaded
```
public void setIncludeUnloaded(boolean includeUnloaded)
```
    Sets whether the unloaded modules are to be included (default false).
    
    Parameters:
    
    includeUnloaded -
  - isIncludeImports
```
public boolean isIncludeImports()
```
    Returns true if the imported modules are to be included (default false).
    
    Returns:
    
    true if the imported modules are to be included (default false)
  - setIncludeImports
```
public void setIncludeImports(boolean includeImports)
```
    Sets whether the imported modules are to be included (default false).
    
    Parameters:
    
    includeImports -
  - isIncludeEntries
```
public boolean isIncludeEntries()
```
    Returns true if the module entries are to be included (default false).
    
    Returns:
    
    true if the module entries are to be included (default false)
  - setIncludeEntries
```
public void setIncludeEntries(boolean includeEntries)
```
    Sets whether the module entries are to be included (default false).
    
    Parameters:
    
    includeEntries -
  - isIncludeExecutableOnly
```
public boolean isIncludeExecutableOnly()
```
    Returns true if only the executable modules are to be included (default false).
    
    Returns:
    
    true if only the executable modules are to be included (default false)
  - setIncludeExecutableOnly
```
public void setIncludeExecutableOnly(boolean includeExecutableOnly)
```
    Sets whether only the executable modules are to be included (default false).
    
    Parameters:
    
    includeExecutableOnly -
  - setId
```
public void setId(Long id)
```
  - getId
```
public Long getId()
```
  - setDescriptionPattern
```
public void setDescriptionPattern(String pattern)
```
  - getDescriptionPattern
```
public String getDescriptionPattern()
```
  - setUploadedFrom
```
public void setUploadedFrom(Date from)
```
  - getUploadedFrom
```
public Date getUploadedFrom()
```
  - setUploadedTo
```
public void setUploadedTo(Date to)
```
  - getUploadedTo
```
public Date getUploadedTo()
```
  - setExecutable
```
public void setExecutable(Boolean value)
```
  - getExecatubale
```
public Boolean getExecatubale()
```
  - setOrdering
```
public void setOrdering(ModuleColumn column,
                        OrderDirection direction)
```
    Sets the ordering using the given column and direction.
    
    Parameters:
    
    column -
    
    direction -
  - getOrdering
```
public ModuleOrdering getOrdering()
```
    Returns the ordering.
    
    Returns:
    
    the ordering

Class ModuleCriteria

Nested Class Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ModuleCriteria

ModuleCriteria

ModuleCriteria

Method Detail

getNamePattern

setNamePattern

isNamePatternCaseInsensitive

setNamePatternCaseInsensitive

getVersionPattern

setVersionPattern

isVersionPatternCaseInsensitive

setVersionPatternCaseInsensitive

getHash

setHash

isIncludeLatestOnly

setIncludeLatestOnly

isIncludeSystem

setIncludeSystem

isIncludeUnloaded

setIncludeUnloaded

isIncludeImports

setIncludeImports

isIncludeEntries

setIncludeEntries

isIncludeExecutableOnly

setIncludeExecutableOnly

setId

getId

setDescriptionPattern

getDescriptionPattern

setUploadedFrom

getUploadedFrom

setUploadedTo

getUploadedTo

setExecutable

getExecatubale

setOrdering

getOrdering