public class WsFilter extends Object
Constructor and Description |
---|
WsFilter()
Creates an empty WsFilter object.
|
WsFilter(Long id)
Creates a new WsFilter object with the given id.
|
WsFilter(String name,
WsDocumentType documentType,
WsProject project,
WsFilterParameter[] parameters,
Integer scopeId,
Integer refId)
Creates a new WsFilter object with the given values.
|
Modifier and Type | Method and Description |
---|---|
WsDocumentType |
getDocumentType()
Gets the item type associated with this filter (Can be null).
|
Long |
getId()
Gets the filter's id
|
Boolean |
getIncludeHierarchy()
Whether or not the filter includes hierarchy items
(items that are not results of the filter, but are required to construct the hierarchy)
|
Boolean |
getIsFavorite() |
String |
getName()
Gets the filter's name.
|
WsFilterParameter[] |
getParameters()
Gets the filter's parameters.
|
WsProject |
getProject()
Gets the project associated with this filter.
|
Integer |
getRefId()
Gets the filter's reference id.
|
Integer |
getScopeId()
Gets the filter's scope.
|
void |
setDocumentType(WsDocumentType documentType)
Sets the item type associated with this filter (Can be null).
|
void |
setId(Long id)
Sets the filter's id
|
void |
setIncludeHierarchy(Boolean includeHierarchy)
Sets whether or not the filter includes hierarchy items
(items that are not results of the filter, but are required to construct the hierarchy)
|
void |
setIsFavorite(Boolean isFavorite) |
void |
setName(String name)
Sets the filter's name.
|
void |
setParameters(WsFilterParameter[] parameters)
Sets the filter's parameters.
|
void |
setProject(WsProject project)
Sets the project associated with this filter.
|
void |
setRefId(Integer refId)
Sets the filter's reference id.
|
void |
setScopeId(Integer scopeId)
Sets the filter's scope.
|
String |
toString()
Gets a string representation of this filter.
|
public WsFilter()
public WsFilter(Long id)
id
- id to set for the filterpublic WsFilter(String name, WsDocumentType documentType, WsProject project, WsFilterParameter[] parameters, Integer scopeId, Integer refId)
name
- name of the filter (can be null)documentType
- the item type to search (can be null)project
- project to search (can be null)parameters
- parameters of the filterscopeId
- scope of the reference id (can be null)refId
- reference id (can be null)public Long getId()
public void setId(Long id)
id
- the id to setpublic String getName()
public void setName(String name)
name
- the name to setpublic WsDocumentType getDocumentType()
public void setDocumentType(WsDocumentType documentType)
documentType
- the document type to setpublic WsProject getProject()
public void setProject(WsProject project)
project
- the project to setpublic WsFilterParameter[] getParameters()
WsFilterParameter
public void setParameters(WsFilterParameter[] parameters)
parameters
- the parameters to setWsFilterParameter
public Integer getScopeId()
WsScope
public void setScopeId(Integer scopeId)
scopeId
- the filter's scopepublic Integer getRefId()
public void setRefId(Integer refId)
refId
- filter's reference idpublic Boolean getIncludeHierarchy()
public void setIncludeHierarchy(Boolean includeHierarchy)
includeHierarchy
- the includeHierarchy to setpublic Boolean getIsFavorite()
public void setIsFavorite(Boolean isFavorite)
Copyright (c) 2013-2014 Jama Software, Inc. All Rights Reserved.