com.jamasoftware.contour.domain
Class Filter

java.lang.Object
  com.jamasoftware.contour.domain.DomainObjectBaseSupport
      com.jamasoftware.contour.domain.DomainObjectSupport
          com.jamasoftware.contour.domain.Filter

All Implemented Interfaces:

DomainObject, DomainObjectBase, OrganizationAware, ScopedObject, java.io.Serializable, java.lang.Comparable<Filter>

@Entity
public class Filter
extends DomainObjectSupport
implements java.lang.Comparable<Filter>, ScopedObject

Filter object that represents a saved search query.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jamasoftware.contour.domain.DomainObjectBase

ORGANIZATION_COLUMN_NAME

Constructor Summary

Filter()

Filter(java.lang.Integer id)

Filter(java.lang.Integer id, java.lang.String name, java.lang.String description)

Filter(java.lang.String name, java.lang.String description)

Method Summary

void	add(com.jamasoftware.contour.service.dto.FilterParameter para)
void	addFilterParameter(com.jamasoftware.contour.service.dto.FilterParameter param)
int	compareTo(Filter o)
com.jamasoftware.contour.project.domain.Project	getCurrentProject()
User	getCurrentUser()
java.lang.String	getDescription()
DocumentGroup	getDocumentGroupDEPRECATED() Deprecated. Filters have type and project instead of group
DocumentType	getDocumentType()
java.lang.Integer	getId()
java.lang.Boolean	getIsHidden()
org.apache.lucene.search.Filter	getLuceneFilter()
java.lang.String	getName()
java.lang.Integer	getOrganizationId()
java.util.List<com.jamasoftware.contour.service.dto.FilterParameter>	getParameters()
java.lang.Integer	getRefId()
java.lang.Integer	getScopeId()
java.lang.String	getXmlString()
java.lang.String	getXmlToString()
void	setCurrentProject(com.jamasoftware.contour.project.domain.Project currentProject)
void	setCurrentUser(User currentUser)
void	setDescription(java.lang.String description)
void	setDocumentGroupDEPRECATED(DocumentGroup documentGroup) Deprecated. Filters have type and project instead of group
void	setDocumentType(DocumentType documentType)
void	setId(java.lang.Integer lookupId)
void	setIsHidden(java.lang.Boolean isHidden)
void	setLuceneFilter(org.apache.lucene.search.Filter luceneFilter)
void	setName(java.lang.String displayDescription)
void	setOrganizationId(java.lang.Integer organizationId)
void	setParameters(java.util.List<com.jamasoftware.contour.service.dto.FilterParameter> params)
void	setRefId(java.lang.Integer refId)
void	setScopeId(java.lang.Integer scope)
void	setXmlString(java.lang.String xml)
java.lang.String	toString()

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectSupport

getCreatedBy, getCreatedDate, getModifiedBy, getModifiedDate, setCreatedBy, setCreatedDate, setModifiedBy, setModifiedDate

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectBaseSupport

equals, hashCode, isNewObject, obtainAclObjectIdentity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Filter

public Filter()

Filter

public Filter(java.lang.Integer id)

Filter

public Filter(java.lang.String name,
              java.lang.String description)

Filter

public Filter(java.lang.Integer id,
              java.lang.String name,
              java.lang.String description)

Method Detail

getId

public java.lang.Integer getId()

Specified by:

getId in interface DomainObjectBase

setId

public void setId(java.lang.Integer lookupId)

Specified by:

setId in interface DomainObjectBase

getName

public java.lang.String getName()

setName

public void setName(java.lang.String displayDescription)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getXmlString

public java.lang.String getXmlString()

setXmlString

public void setXmlString(java.lang.String xml)

getScopeId

public java.lang.Integer getScopeId()

Specified by:

getScopeId in interface ScopedObject

setScopeId

public void setScopeId(java.lang.Integer scope)

Specified by:

setScopeId in interface ScopedObject

getParameters

public java.util.List<com.jamasoftware.contour.service.dto.FilterParameter> getParameters()

setParameters

public void setParameters(java.util.List<com.jamasoftware.contour.service.dto.FilterParameter> params)

addFilterParameter

public void addFilterParameter(com.jamasoftware.contour.service.dto.FilterParameter param)

compareTo

public int compareTo(Filter o)

Specified by:

compareTo in interface java.lang.Comparable<Filter>

getDocumentType

public DocumentType getDocumentType()

setDocumentType

public void setDocumentType(DocumentType documentType)

getRefId

public java.lang.Integer getRefId()

Specified by:

getRefId in interface ScopedObject

setRefId

public void setRefId(java.lang.Integer refId)

Specified by:

setRefId in interface ScopedObject

getOrganizationId

public java.lang.Integer getOrganizationId()

Specified by:

getOrganizationId in interface DomainObjectBase

Specified by:

getOrganizationId in interface OrganizationAware

setOrganizationId

public void setOrganizationId(java.lang.Integer organizationId)

Specified by:

setOrganizationId in interface DomainObjectBase

getIsHidden

public java.lang.Boolean getIsHidden()

Returns:

the isHidden

setIsHidden

public void setIsHidden(java.lang.Boolean isHidden)

Parameters:

isHidden - the isHidden to set

getCurrentUser

public User getCurrentUser()

setCurrentUser

public void setCurrentUser(User currentUser)

getCurrentProject

public com.jamasoftware.contour.project.domain.Project getCurrentProject()

setCurrentProject

public void setCurrentProject(com.jamasoftware.contour.project.domain.Project currentProject)

getXmlToString

public java.lang.String getXmlToString()

Specified by:

getXmlToString in interface DomainObject

add

public void add(com.jamasoftware.contour.service.dto.FilterParameter para)

getLuceneFilter

public org.apache.lucene.search.Filter getLuceneFilter()

setLuceneFilter

public void setLuceneFilter(org.apache.lucene.search.Filter luceneFilter)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object.

getDocumentGroupDEPRECATED

@Deprecated
public DocumentGroup getDocumentGroupDEPRECATED()

Deprecated. Filters have type and project instead of group

setDocumentGroupDEPRECATED

@Deprecated
public void setDocumentGroupDEPRECATED(DocumentGroup documentGroup)

Deprecated. Filters have type and project instead of group