net.sf.basedb.core.query
Class SharedToRestriction

java.lang.Object
  net.sf.basedb.core.query.SharedToRestriction

All Implemented Interfaces:

QueryElement, Restriction

public class SharedToRestriction
extends Object
implements Restriction

A special restriction that works on Shareable items. The restriction is used to find items that have or have not been shared to users/groups and/or projects that meet some specific criteria.

Version:

2.15

Author:

Nicklas

See Also:

Hql.sharedTo(boolean, Restriction, Restriction, Restriction)

Last modified

$Date: 2010-04-21 11:48:29 +0200 (Wed, 21 Apr 2010) $

Field Summary

private Restriction	groups
private Restriction	projects
private boolean	sharedTo
private Restriction	users

Constructor Summary

SharedToRestriction(boolean sharedTo, Restriction users, Restriction groups, Restriction projects)

Method Summary

boolean	equals(Object other) This restriction is equal to another SharedToRestriction if their child restrictions and other parameters are equal.
Collection<? extends QueryElement>	getChildren() Get the children of this query element or null if it has no children.
int	hashCode()
String	toQl(Query query, DbControl dc) Create a query language string of the query element.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sharedTo

private boolean sharedTo

users

private Restriction users

groups

private Restriction groups

projects

private Restriction projects

Constructor Detail

SharedToRestriction

SharedToRestriction(boolean sharedTo,
                    Restriction users,
                    Restriction groups,
                    Restriction projects)

Method Detail

getChildren

public Collection<? extends QueryElement> getChildren()

Description copied from interface: QueryElement

Get the children of this query element or null if it has no children. For example the AddExpression has two children, the expression beeing added.

Specified by:

getChildren in interface QueryElement

Returns:

A collection or null

toQl

public String toQl(Query query,
                   DbControl dc)
            throws BaseException

Description copied from interface: QueryElement

Create a query language string of the query element. Use the Query.getQueryType() method to find out which query language is wanted in case the element requires different syntax for different languages.

Specified by:

toQl in interface QueryElement

Parameters:

query - The query that is about to be executed

dc - The DbControl object used to execute the query

Throws:

BaseException - If there is any other error

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

This restriction is equal to another SharedToRestriction if their child restrictions and other parameters are equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object