com.viaoa.context

Class OAUserAccess

java.lang.Object

com.viaoa.context.OAUserAccess

public class OAUserAccess
extends Object

Used to set the "boundaries" of what objects & properties/methods can be accessed by a user (or system).
Used to determine if an object is included in a propertyPath from a root OAObject/Hub.AO Separate methods for Visible and Enabled property paths, both On and Off (Not).
Has methods to add multiple obj/hub and propertyPaths, so that all are searched to see if an Object is included in any of the root + paths. Allows for adding child[ren] OAUserAccess Used by OAContext

    OAUserAccess ua = new OAUserAccess();
    ua.addVisible(buyer, BuyerPP.location().company().clients().products().campaigns().pp);

    boolean bx = ua.getHasVisible(camp);
    bx = ua.getHasVisible(new AppUser());
    bx = ua.getHasVisible(new Campaign());

    bx = ua.getHasVisible(company);
    bx = ua.getHasVisible(new Company());

    bx = ua.getHasVisible(client);
    bx = ua.getHasVisible(product);
    bx = ua.getHasVisible(null);
    bx = ua.getHasVisible(new Product());

Author:

vvia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OAUserAccess.UserAccess Keeps track of all defined propertyPaths, with root obj/hub.ao

Constructor Summary

Constructors

Constructor and Description
OAUserAccess()
OAUserAccess(boolean bDefaultEnabled, boolean bDefaultVisible) Create new OAUserAccess that can be used to see if a propertyPath is enabled or visible.

Method Summary

Modifier and Type	Method and Description
void	addEnabled(Class<? extends OAObject> c)
void	addEnabled(Class<? extends OAObject> c, String propertyName)
void	addEnabled(Hub hub, String pp)
void	addEnabled(Hub hub, String pp, String propertyName)
void	addEnabled(Hub hub, String pp, String propertyName, boolean bOnlyEndProperty)
void	addEnabled(OAObject obj, String pp)
void	addEnabled(OAObject obj, String pp, String propertyName)
void	addEnabled(OAObject obj, String pp, String propertyName, boolean bOnlyEndProperty)
void	addNotEnabled(Class<? extends OAObject> c)
void	addNotEnabled(Class<? extends OAObject> c, String propertyName)
void	addNotEnabled(Hub hub, String pp, String propertyName)
void	addNotEnabled(Hub hub, String pp, String propertyName, boolean bOnlyEndProperty)
void	addNotEnabled(OAObject obj, String pp)
void	addNotEnabled(OAObject obj, String pp, String propertyName)
void	addNotEnabled(OAObject obj, String pp, String propertyName, boolean bOnlyEndProperty)
void	addNotVisible(Class<? extends OAObject> c)
void	addNotVisible(Class<? extends OAObject> c, String propertyName)
void	addNotVisible(Hub hub, String pp)
void	addNotVisible(Hub hub, String pp, String propertyName, boolean bOnlyEndProperty)
void	addNotVisible(OAObject obj, String pp)
void	addNotVisible(OAObject obj, String pp, String propertyName)
void	addNotVisible(OAObject obj, String pp, String propertyName, boolean bOnlyEndProperty)
void	addUserAccess(OAUserAccess ua) Add child UserAccess to chain together, where the return value from the parent will be the default value when checking the children.
void	addVisible(Class<? extends OAObject> c)
void	addVisible(Class<? extends OAObject> c, String propertyName)
void	addVisible(Hub hub, String pp)
void	addVisible(Hub hub, String pp, String propertyName)
void	addVisible(Hub hub, String pp, String propertyName, boolean bOnlyEndProperty)
void	addVisible(OAObject obj, String pp)
void	addVisible(OAObject obj, String pp, String propertyName)
void	addVisible(OAObject obj, String pp, String propertyName, boolean bOnlyEndProperty)
boolean	getEnabled(Class clazz)
boolean	getEnabled(OAObject obj)
protected boolean	getEnabled(OAObject obj, Class cz, String propertyName, boolean bDefault) Checks to see if an OAObject & (optional) propertyName should be enabled.
boolean	getEnabled(OAObject obj, String propertyName)
boolean	getEnabled(OAObject obj, String propertyName, boolean bDefault)
String	getExtraWhereClause(Class clazz)
protected boolean	getIsInSamePropertyPath(OAObject objSearch, String propertyName, ArrayList<OAUserAccess.UserAccess> alUserAccess) See if an Object is included in any of the Root obj/hub + propertyPaths.
boolean	getVisible(Class clazz)
boolean	getVisible(OAObject obj)
protected boolean	getVisible(OAObject obj, Class cz, String propertyName, boolean bDefault) Checks to see if an OAObject & (optional) propertyName should be visible.
boolean	getVisible(OAObject obj, String propertyName)
protected boolean	getVisible(OAObject obj, String propertyName, boolean bDefault)
void	setValidPackage(Package packageValid)
boolean	updateSelect(OASelect sel)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAUserAccess

public OAUserAccess()

OAUserAccess

public OAUserAccess(boolean bDefaultEnabled,
                    boolean bDefaultVisible)

Create new OAUserAccess that can be used to see if a propertyPath is enabled or visible.

Method Detail

updateSelect

public boolean updateSelect(OASelect sel)

getExtraWhereClause

public String getExtraWhereClause(Class clazz)

setValidPackage

public void setValidPackage(Package packageValid)

addUserAccess

public void addUserAccess(OAUserAccess ua)

Add child UserAccess to chain together, where the return value from the parent will be the default value when checking the children.

Parameters:

ua -

addEnabled

public void addEnabled(Class<? extends OAObject> c)

addNotEnabled

public void addNotEnabled(Class<? extends OAObject> c)

addVisible

public void addVisible(Class<? extends OAObject> c)

addNotVisible

public void addNotVisible(Class<? extends OAObject> c)

addEnabled

public void addEnabled(Class<? extends OAObject> c,
                       String propertyName)

addNotEnabled

public void addNotEnabled(Class<? extends OAObject> c,
                          String propertyName)

addVisible

public void addVisible(Class<? extends OAObject> c,
                       String propertyName)

addNotVisible

public void addNotVisible(Class<? extends OAObject> c,
                          String propertyName)

addEnabled

public void addEnabled(OAObject obj,
                       String pp)

addEnabled

public void addEnabled(OAObject obj,
                       String pp,
                       String propertyName)

addEnabled

public void addEnabled(OAObject obj,
                       String pp,
                       String propertyName,
                       boolean bOnlyEndProperty)

addEnabled

public void addEnabled(Hub hub,
                       String pp)

addEnabled

public void addEnabled(Hub hub,
                       String pp,
                       String propertyName)

addEnabled

public void addEnabled(Hub hub,
                       String pp,
                       String propertyName,
                       boolean bOnlyEndProperty)

addNotEnabled

public void addNotEnabled(OAObject obj,
                          String pp)

addNotEnabled

public void addNotEnabled(OAObject obj,
                          String pp,
                          String propertyName)

addNotEnabled

public void addNotEnabled(OAObject obj,
                          String pp,
                          String propertyName,
                          boolean bOnlyEndProperty)

addNotEnabled

public void addNotEnabled(Hub hub,
                          String pp,
                          String propertyName)

addNotEnabled

public void addNotEnabled(Hub hub,
                          String pp,
                          String propertyName,
                          boolean bOnlyEndProperty)

addVisible

public void addVisible(OAObject obj,
                       String pp)

addVisible

public void addVisible(OAObject obj,
                       String pp,
                       String propertyName)

addVisible

public void addVisible(OAObject obj,
                       String pp,
                       String propertyName,
                       boolean bOnlyEndProperty)

addVisible

public void addVisible(Hub hub,
                       String pp)

addVisible

public void addVisible(Hub hub,
                       String pp,
                       String propertyName)

addVisible

public void addVisible(Hub hub,
                       String pp,
                       String propertyName,
                       boolean bOnlyEndProperty)

Parameters:

hub -

pp -

propertyName -

bOnlyEndProperty -

addNotVisible

public void addNotVisible(OAObject obj,
                          String pp)

addNotVisible

public void addNotVisible(OAObject obj,
                          String pp,
                          String propertyName)

addNotVisible

public void addNotVisible(OAObject obj,
                          String pp,
                          String propertyName,
                          boolean bOnlyEndProperty)

addNotVisible

public void addNotVisible(Hub hub,
                          String pp)

addNotVisible

public void addNotVisible(Hub hub,
                          String pp,
                          String propertyName,
                          boolean bOnlyEndProperty)

getEnabled

public boolean getEnabled(OAObject obj)

getEnabled

public boolean getEnabled(OAObject obj,
                          String propertyName)

getEnabled

public boolean getEnabled(Class clazz)

getEnabled

public boolean getEnabled(OAObject obj,
                          String propertyName,
                          boolean bDefault)

getEnabled

protected boolean getEnabled(OAObject obj,
                             Class cz,
                             String propertyName,
                             boolean bDefault)

Checks to see if an OAObject & (optional) propertyName should be enabled. Uses the following steps:

1. starts with result set to default value (true/false)
2. checks if the class is enabled (result set to true).
3. checks if the class is not enabled (result set to false).
4. if property name, then checks if class+propertyName is enabled (result set to true).
5. if property name, then checks if class+propertyName is not enabled (result set to false).
6. checks to see if obj [& prop] are in the enabled propert paths (result set to true)
7. checks to see if obj [& prop] are in the not enabled propert paths (result set to false)
8. calls child[ren] recursively setting result.
9. returns result

getVisible

public boolean getVisible(Class clazz)

getVisible

public boolean getVisible(OAObject obj)

getVisible

public boolean getVisible(OAObject obj,
                          String propertyName)

getVisible

protected boolean getVisible(OAObject obj,
                             String propertyName,
                             boolean bDefault)

getVisible

protected boolean getVisible(OAObject obj,
                             Class cz,
                             String propertyName,
                             boolean bDefault)

Checks to see if an OAObject & (optional) propertyName should be visible. Uses the following steps:

1. starts with result set to default value (true/false) 1: checks if the class is enabled (result set to true).
2. checks if the class is not enabled (result set to false).
3. if property name, then checks if class+propertyName is enabled (result set to true).
4. if property name, then checks if class+propertyName is not enabled (result set to false).
5. checks to see if obj [& prop] are in the enabled propert paths (result set to true)
6. checks to see if obj [& prop] are in the not enabled propert paths (result set to false)
7. calls child[ren] recursively setting result. 8: returns result

getIsInSamePropertyPath

protected boolean getIsInSamePropertyPath(OAObject objSearch,
                                          String propertyName,
                                          ArrayList<OAUserAccess.UserAccess> alUserAccess)

See if an Object is included in any of the Root obj/hub + propertyPaths. This is done by using the property path to search from the root obj/hub.at and then reversing the pp from the search object to find a common root.