com.ibm.commerce.accesscontrol.policymanager
Class AccessClause

java.lang.Object
  |
  +--com.ibm.commerce.accesscontrol.policymanager.AccessClause

public class AccessClause
extends java.lang.Object

This class encapsulates the parameters returned from the getAccessClause() of the Policy Manager implementation. The accessClauseString carries the 'where' clause of the SQL query, and the flag prefilteringSuccessful indicates whether the prefiltering operation could be completed successfully or not.


Constructor Summary
AccessClause()
          Constructs the AccessClause instance
 
Method Summary
 java.lang.String getAccessClauseString()
          Returns the 'where' clause of the generated query.
 java.util.ArrayList getParameterList()
          Insert the method's description here.
 boolean isPostfilteringNeeded()
          Indicates whether or not post filtering should be done on the result of the access clause string.
 boolean isPrefilteringSuccessful()
          Returns the flag indicating the result of the prefiltering operation
 void postfilteringNeeded(boolean bNeeded)
          Sets the flag indicating if post-filtering is neeeded.
 void prefilteringSuccessful(boolean bSuccess)
          Sets the flag indicating the result of the Prefiltering operation
 void setAccessClauseString(java.lang.String strClauseString)
          Sets the 'where' clause String, generated out of prefiltering process
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AccessClause

public AccessClause()
Constructs the AccessClause instance
Method Detail

getAccessClauseString

public java.lang.String getAccessClauseString()
Returns the 'where' clause of the generated query. Can never be null. One should call isPrefilteringSuccessful() in order to determine if this 'where' clause is fully correct
Returns:
The 'where' clause of the generated query
See Also:
isPrefilteringSuccessful()

getParameterList

public java.util.ArrayList getParameterList()
Insert the method's description here. Creation date: (2/8/02 6:25:33 PM)
Returns:
java.util.ArrayList

isPostfilteringNeeded

public boolean isPostfilteringNeeded()
Indicates whether or not post filtering should be done on the result of the access clause string. This should be checked only if pre-filtering was successful.
Returns:
true if postfiltering is needed.

isPrefilteringSuccessful

public boolean isPrefilteringSuccessful()
Returns the flag indicating the result of the prefiltering operation
Returns:
true if the prefiltering query generation is successful. false otherwise.

postfilteringNeeded

public void postfilteringNeeded(boolean bNeeded)
Sets the flag indicating if post-filtering is neeeded. This is only meaningful if pre-filtering is successful.
Parameters:
bNeeded - True if post-filtering is needed, i.e., the result of the access clause query string is a super-set of the allowed resources; false if otherwise

prefilteringSuccessful

public void prefilteringSuccessful(boolean bSuccess)
Sets the flag indicating the result of the Prefiltering operation

setAccessClauseString

public void setAccessClauseString(java.lang.String strClauseString)
Sets the 'where' clause String, generated out of prefiltering process