com.tsgrp.opencontent.core.query.model

Class OCAuthoritySearchCriteria

java.lang.Object

com.tsgrp.opencontent.core.query.model.OCAuthoritySearchCriteria

public class OCAuthoritySearchCriteria
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHORITY_TYPE_GROUP
static java.lang.String	AUTHORITY_TYPE_USER
static java.lang.String	ORDER_TYPE_ASC
static java.lang.String	ORDER_TYPE_DESC

Method Summary

Modifier and Type	Method and Description
static OCAuthoritySearchCriteria	createSearchCriteria(java.lang.String authorityType, OCAuthoritySearchCriterion criterion, java.lang.String orderType, java.lang.String childOfAuthority, java.lang.String authorityHasChild) Static factory method that returns a new, validated OCAuthoritySearchCriteria bean instance.
java.lang.String	getAuthorityHasChild()
java.lang.String	getAuthorityType()
java.lang.String	getChildOfAuthority()
OCAuthoritySearchCriterion	getCriterion()
java.lang.String	getOrderType()
void	setAuthorityHasChild(java.lang.String authorityHasChild)
void	setAuthorityType(java.lang.String authorityType)
void	setChildOfAuthority(java.lang.String childOfAuthority)
void	setCriterion(OCAuthoritySearchCriterion criterion)
void	setOrderType(java.lang.String orderType)
static void	validate(OCAuthoritySearchCriteria criteria)

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORITY_TYPE_USER

public static final java.lang.String AUTHORITY_TYPE_USER

See Also:

Constant Field Values

AUTHORITY_TYPE_GROUP

public static final java.lang.String AUTHORITY_TYPE_GROUP

See Also:

Constant Field Values

ORDER_TYPE_ASC

public static final java.lang.String ORDER_TYPE_ASC

See Also:

Constant Field Values

ORDER_TYPE_DESC

public static final java.lang.String ORDER_TYPE_DESC

See Also:

Constant Field Values

Method Detail

createSearchCriteria

public static OCAuthoritySearchCriteria createSearchCriteria(java.lang.String authorityType,
                                                             OCAuthoritySearchCriterion criterion,
                                                             java.lang.String orderType,
                                                             java.lang.String childOfAuthority,
                                                             java.lang.String authorityHasChild)

Static factory method that returns a new, validated OCAuthoritySearchCriteria bean instance.

Parameters:

authorityType - - Which type of authority to search on. Cannot be null, AUTHORITY_TYPE_USER ("user") or AUTHORITY_TYPE_GROUP ("group")

criterion - - Define criterion to search on. Can be null, see OCAuthoritySearchCriterion

orderType - - Define how to sort results. Can be null, if supplied, must be either ORDER_TYPE_ASC ("asc") or ORDER_TYPE_DESC ("desc")

childOfAuthority - - Filter results on whether or not authorities are children of the supplied authority. For instance, if you are searching for users who are a member of a group, supply the group name here. Can be null.

authorityHasChild - - NOT CURRENTLY SUPPORTED, PASS NULL IN. Filter results on whether or not this authority has the specified authority as a child. Can be null.

Returns:

new validated OCAuthoritySearchCriteria bean

Throws:

java.lang.IllegalArgumentException

validate

public static void validate(OCAuthoritySearchCriteria criteria)

Parameters:

criteria -

Throws:

java.lang.IllegalArgumentException

getAuthorityType

public java.lang.String getAuthorityType()

Returns:

the authorityType

setAuthorityType

public void setAuthorityType(java.lang.String authorityType)

Parameters:

authorityType - the authorityType to set

getCriterion

public OCAuthoritySearchCriterion getCriterion()

Returns:

the criterion

setCriterion

public void setCriterion(OCAuthoritySearchCriterion criterion)

Parameters:

criterion - the criterion to set

getOrderType

public java.lang.String getOrderType()

Returns:

the orderType

setOrderType

public void setOrderType(java.lang.String orderType)

Parameters:

orderType - the orderType to set

getChildOfAuthority

public java.lang.String getChildOfAuthority()

Returns:

the childOfAuthority

setChildOfAuthority

public void setChildOfAuthority(java.lang.String childOfAuthority)

Parameters:

childOfAuthority - the childOfAuthority to set

getAuthorityHasChild

public java.lang.String getAuthorityHasChild()

Returns:

the authorityHasChild

setAuthorityHasChild

public void setAuthorityHasChild(java.lang.String authorityHasChild)

Parameters:

authorityHasChild - the authorityHasChild to set