com.jamasoftware.contour.ws.domain

Class WsFilter

java.lang.Object

com.jamasoftware.contour.ws.domain.WsFilter

public class WsFilter
extends Object

This object represents a Contour filter. A Filter is a way for you to search for similar information based on the fields within Items and then create a filtered list of those Items. For complex Projects with hundreds or thousands of Items, Filters become a time-saving tool for getting to the most relevant Items you are working on. For example, a common use is to create a Filter for tasks that are assigned to you.

Author:

Dylan

Constructor Summary

Constructors

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.

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsFilter

public WsFilter()

Creates an empty WsFilter object.

WsFilter

public WsFilter(Long id)

Creates a new WsFilter object with the given id.

Parameters:

id - id to set for the filter

WsFilter

public WsFilter(String name,
        WsDocumentType documentType,
        WsProject project,
        WsFilterParameter[] parameters,
        Integer scopeId,
        Integer refId)

Creates a new WsFilter object with the given values.

Parameters:

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 filter

scopeId - scope of the reference id (can be null)

refId - reference id (can be null)

Method Detail

getId

public Long getId()

Gets the filter's id

Returns:

the id

setId

public void setId(Long id)

Sets the filter's id

Parameters:

id - the id to set

getName

public String getName()

Gets the filter's name.

Returns:

the name

setName

public void setName(String name)

Sets the filter's name.

Parameters:

name - the name to set

getDocumentType

public WsDocumentType getDocumentType()

Gets the item type associated with this filter (Can be null).

Returns:

the document type

setDocumentType

public void setDocumentType(WsDocumentType documentType)

Sets the item type associated with this filter (Can be null).

Parameters:

documentType - the document type to set

getProject

public WsProject getProject()

Gets the project associated with this filter.

Returns:

the project

setProject

public void setProject(WsProject project)

Sets the project associated with this filter.

Parameters:

project - the project to set

getParameters

public WsFilterParameter[] getParameters()

Gets the filter's parameters.

Returns:

the parameters

See Also:

WsFilterParameter

setParameters

public void setParameters(WsFilterParameter[] parameters)

Sets the filter's parameters.

Parameters:

parameters - the parameters to set

See Also:

WsFilterParameter

getScopeId

public Integer getScopeId()

Gets the filter's scope.

Returns:

the filter's scope

See Also:

WsScope

setScopeId

public void setScopeId(Integer scopeId)

Sets the filter's scope.

Parameters:

scopeId - the filter's scope

getRefId

public Integer getRefId()

Gets the filter's reference id.

Returns:

filter's reference id

setRefId

public void setRefId(Integer refId)

Sets the filter's reference id.

Parameters:

refId - filter's reference id

getIncludeHierarchy

public 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)

Returns:

the includeHierarchy

setIncludeHierarchy

public 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)

Parameters:

includeHierarchy - the includeHierarchy to set

getIsFavorite

public Boolean getIsFavorite()

setIsFavorite

public void setIsFavorite(Boolean isFavorite)

toString

public String toString()

Gets a string representation of this filter.

Overrides:

toString in class Object

Returns:

String