com.adobe.livecycle.rca.common.beans
Class TemplateSearchFilter

java.lang.Object
  com.adobe.livecycle.rca.common.beans.TemplateSearchFilter

All Implemented Interfaces:

Serializable

public class TemplateSearchFilter
extends Object
implements Serializable

This filter allows you specify review template search criteria to be AND-ed together. TemplateSearchFilter is used to search for review templates. Each attribute of the filter represent a filtering criteria and one of more filter criteria can be used to search for review templates. All filter attributes or criteria are joined by AND condition and used in like query, so % can be used for wild char searches. e.g. if templateName is set to "Test%" and complianceCode is set to "SOP", then search result will consist of all the templates where name starts with "Test" and complianceCode is set to "SOP". Search results can be paginated. pageSize and pageNumeber attributes in the search filter are used for pagination. if paging in the search results in not required then above attributes should not be set or can be set to 0.

See Also:

Serialized Form

Constructor Summary

TemplateSearchFilter()
creates a template search filter object

TemplateSearchFilter(String templateName, String keywords, String complianceCode, boolean retrieveActiveOnly, String author, Map customAttributes, int pageSize, int pageNumber)
creates a template search filter object

TemplateSearchFilter(String templateName, String keywords, String complianceCode, boolean retrieveActiveOnly, String appName, String author, Map customAttributes, int pageSize, int pageNumber)

Method Summary

String	getAppName()
String	getAuthor() Deprecated. use getCreatedBy()
String	getComplianceCode() get the compliance code used to search templates
String	getCreatedBy()
Map	getCustomAttributes() Get custom attributes map used to search templates.
String	getKeywords() gets the keywords used to search templates
String	getLastModifiedBy()
int	getPageNumber() Page number of the search result, this is only applicable if pageSize is >0.
int	getPageSize() Gets the page size used in pagination calculation.
String	getTemplateName() Gets the template name used to search templates
boolean	isRetrieveActiveOnly() gets active flag on which the search to based
boolean	isRetrieveInActiveOnly()
void	setAppName(String appName)
void	setAuthor(String author) Deprecated. use setCreatedBy(createdBy)
void	setComplianceCode(String complianceCode) Sets the compliance code used to search templates
void	setCreatedBy(String createdBy)
void	setCustomAttributes(Map customAttributes) Set custom attributes map used to search templates.
void	setKeywords(String keywords) Sets the keywords used to search templates
void	setLastModifiedBy(String lastModifiedBy)
void	setPageNumber(int pageNumber) Page number of the search result, this is only applicable if pageSize is >0.
void	setPageSize(int pageSize) Gets the page size used in pagination calculation.
void	setRetrieveActiveOnly(boolean active) sets active flag on which the search to based
void	setRetrieveInActiveOnly(boolean retrieveInActiveOnly)
void	setTemplateName(String templateName) sets the template name used to search templates

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateSearchFilter

public TemplateSearchFilter()

creates a template search filter object

TemplateSearchFilter

public TemplateSearchFilter(String templateName,
                            String keywords,
                            String complianceCode,
                            boolean retrieveActiveOnly,
                            String author,
                            Map customAttributes,
                            int pageSize,
                            int pageNumber)

creates a template search filter object

Parameters:

templateName - name of the template

keywords - string value to be searched in description.

complianceCode - compliance code to be searched

retrieveActiveOnly - if this flag is true, search returns only active templates.

author - Name of the author, whose templates to be searched

customAttributes - Map of custom attributes (if any), to be included in search

pageSize - page size to be used in paging calculations

pageNumber - page number of the search results, to be returned.

TemplateSearchFilter

public TemplateSearchFilter(String templateName,
                            String keywords,
                            String complianceCode,
                            boolean retrieveActiveOnly,
                            String appName,
                            String author,
                            Map customAttributes,
                            int pageSize,
                            int pageNumber)

Method Detail

getTemplateName

public String getTemplateName()

Gets the template name used to search templates

Returns:

template name used to search templates

setTemplateName

public void setTemplateName(String templateName)

sets the template name used to search templates

Parameters:

templateName - template name used to search templates

getKeywords

public String getKeywords()

gets the keywords used to search templates

Returns:

keywords used to search templates

setKeywords

public void setKeywords(String keywords)

Sets the keywords used to search templates

Parameters:

keywords - keywords used to search templates

getComplianceCode

public String getComplianceCode()

get the compliance code used to search templates

Returns:

compliance code used to search templates

setComplianceCode

public void setComplianceCode(String complianceCode)

Sets the compliance code used to search templates

Parameters:

complianceCode - compliance code used to search templates

isRetrieveActiveOnly

public boolean isRetrieveActiveOnly()

gets active flag on which the search to based

Returns:

active flag on which the search to based

setRetrieveActiveOnly

public void setRetrieveActiveOnly(boolean active)

sets active flag on which the search to based

Parameters:

active - active flag on which the search to based

isRetrieveInActiveOnly

public boolean isRetrieveInActiveOnly()

setRetrieveInActiveOnly

public void setRetrieveInActiveOnly(boolean retrieveInActiveOnly)

getAuthor

public String getAuthor()

Deprecated. use getCreatedBy()

gets the author name used to search templates

Returns:

author name used to search templates

setAuthor

public void setAuthor(String author)

Deprecated. use setCreatedBy(createdBy)

sets author name used to search templates

Parameters:

author - author name used to search templates

getCreatedBy

public String getCreatedBy()

setCreatedBy

public void setCreatedBy(String createdBy)

getLastModifiedBy

public String getLastModifiedBy()

setLastModifiedBy

public void setLastModifiedBy(String lastModifiedBy)

getCustomAttributes

public Map getCustomAttributes()

Get custom attributes map used to search templates. Custom attributes are key-value pairs that can be used search.

Returns:

map of custom attributes used to search templates

setCustomAttributes

public void setCustomAttributes(Map customAttributes)

Set custom attributes map used to search templates. Custom attributes are key-value pairs that can be used search.

Parameters:

customAttributes - custom attributes used to search templates

getPageSize

public int getPageSize()

Gets the page size used in pagination calculation. Page size, represents max number of records to be returned in the search results. A value of 0 or less means all the results are to be returned.

Returns:

page size used in pagination calculation.

setPageSize

public void setPageSize(int pageSize)

Gets the page size used in pagination calculation. Page size, represents max number of records to be returned in the search results. A value of 0 or less means all the results are to be returned.

Parameters:

pageSize - page size used in pagination calculation

getPageNumber

public int getPageNumber()

Page number of the search result, this is only applicable if pageSize is >0.

Returns:

Page number of the search result

setPageNumber

public void setPageNumber(int pageNumber)

Page number of the search result, this is only applicable if pageSize is >0.

Parameters:

pageNumber - Page number of the search result,

getAppName

public String getAppName()

setAppName

public void setAppName(String appName)