de.hybris.platform.search.restriction.session

Class SessionSearchRestriction

java.lang.Object

de.hybris.platform.search.restriction.session.SessionSearchRestriction

public class SessionSearchRestriction
extends Object

SessionSearchRestriction is the object for defining dynamic search restrictions. Example:

 // We want to limit Language to active
 final ComposedTypeModel restrictedType = typeService.getComposedTypeForClass(LanguageModel.class);
 try
 {
        final SessionSearchRestriction restriction = new SessionSearchRestriction("someUniqueCode", "{active} IS TRUE", restrictedType);
        final Collection<SessionSearchRestriction> restrictions = new ArrayList<SessionSearchRestriction>();
        restrictions.add(restriction);
        searchRestrictionService.addSessionSearchRestrictions(restrictions);
 
        // ... business code goes here now ...
 }
 finally
 {
        // clear all dynamic restrictions 
        searchRestrictionService.clearSessionSearchRestrictions();
 }
 

Constructor Summary

Constructors

Constructor and Description
SessionSearchRestriction(String code, String query, ComposedTypeModel restrictedType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object another) Session search restriction are considered equal if their codes and types match.
String	getCode()
String	getQuery()
ComposedTypeModel	getRestrictedType()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionSearchRestriction

public SessionSearchRestriction(String code,
                                String query,
                                ComposedTypeModel restrictedType)

Method Detail

getCode

public String getCode()

getQuery

public String getQuery()

getRestrictedType

public ComposedTypeModel getRestrictedType()

equals

public boolean equals(Object another)

Session search restriction are considered equal if their codes and types match.

Overrides:

equals in class Object