ccc.api.core
Class ResourceCriteria

java.lang.Object
  ccc.api.core.ResourceCriteria

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PageCriteria

public class ResourceCriteria
extends java.lang.Object
implements java.io.Serializable

Criteria class for resource search.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Constructor Summary

ResourceCriteria()
Constructor.

Method Summary

java.util.Date	getChangedAfter() Accessor.
java.util.Date	getChangedBefore() Accessor.
java.lang.Boolean	getLocked() Accessor.
java.lang.Boolean	getMainmenu() Accessor.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Accessor.
java.lang.String	getName() Accessor.
java.util.UUID	getParent() Accessor.
java.lang.Boolean	getPublished() Accessor.
java.lang.String	getSortField() Accessor.
SortOrder	getSortOrder() Accessor.
java.lang.String	getTag() Accessor.
ResourceType	getType() Accessor.
void	matchMetadatum(java.lang.String name, java.lang.String value) Match the specified metadatum.
void	setChangedAfter(java.util.Date date) Mutator.
void	setChangedBefore(java.util.Date date) Mutator.
void	setLocked(java.lang.Boolean locked) Mutator.
void	setMainmenu(java.lang.Boolean mainmenu) Mutator.
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Mutator.
void	setName(java.lang.String name) Mutator.
void	setParent(java.util.UUID parent) Mutator.
void	setPublished(java.lang.Boolean published) Mutator.
void	setSortField(java.lang.String sortField) Mutator.
void	setSortOrder(SortOrder sortOrder) Mutator.
void	setTag(java.lang.String tag) Mutator.
void	setType(ResourceType type) Mutator.
void	sort(java.lang.String field, SortOrder order) Sort the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCriteria

public ResourceCriteria()

Constructor.

Method Detail

getType

public final ResourceType getType()

Accessor.

Returns:

Returns the Type.

setType

public final void setType(ResourceType type)

Mutator.

Parameters:

type - The type to set.

getParent

public final java.util.UUID getParent()

Accessor.

Returns:

The parent.

getTag

public final java.lang.String getTag()

Accessor.

Returns:

The tag.

getChangedBefore

public final java.util.Date getChangedBefore()

Accessor.

Returns:

Date changed before.

setChangedBefore

public final void setChangedBefore(java.util.Date date)

Mutator.

Parameters:

date - Date changed before.

getChangedAfter

public final java.util.Date getChangedAfter()

Accessor.

Returns:

Date changed after.

setChangedAfter

public final void setChangedAfter(java.util.Date date)

Mutator.

Parameters:

date - Date changed after.

setTag

public final void setTag(java.lang.String tag)

Mutator.

Parameters:

tag - The tag.

setParent

public final void setParent(java.util.UUID parent)

Mutator.

Parameters:

parent - The resource's parent.

setMainmenu

public final void setMainmenu(java.lang.Boolean mainmenu)

Mutator.

Parameters:

mainmenu - Included in main menu.

getMainmenu

public final java.lang.Boolean getMainmenu()

Accessor.

Returns:

Included in main menu.

getPublished

public final java.lang.Boolean getPublished()

Accessor.

Returns:

Returns the published.

setPublished

public final void setPublished(java.lang.Boolean published)

Mutator.

Parameters:

published - The published to set.

getLocked

public final java.lang.Boolean getLocked()

Accessor.

Returns:

Returns the locked.

setLocked

public final void setLocked(java.lang.Boolean locked)

Mutator.

Parameters:

locked - The locked to set.

sort

public final void sort(java.lang.String field,
                       SortOrder order)

Sort the results.

Parameters:

field - The paragraph to sort on.

order - The order to sort.

getSortOrder

public final SortOrder getSortOrder()

Accessor.

Returns:

The order by which results will be sorted.

getSortField

public final java.lang.String getSortField()

Accessor.

Returns:

The field on which to sort results.

setSortField

public final void setSortField(java.lang.String sortField)

Mutator.

Parameters:

sortField - The field to sort on.

setSortOrder

public final void setSortOrder(SortOrder sortOrder)

Mutator.

Parameters:

sortOrder - The order to sort in.

matchMetadatum

public final void matchMetadatum(java.lang.String name,
                                 java.lang.String value)

Match the specified metadatum.

Parameters:

name - The metadatum name.

value - The metadatum value.

getMetadata

public final java.util.Map<java.lang.String,java.lang.String> getMetadata()

Accessor.

Returns:

The metadata to match.

setMetadata

public final void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Mutator.

Parameters:

metadata - The metadata to set.

getName

public java.lang.String getName()

Accessor.

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Mutator.

Parameters:

name - The name to set.