org.okiproject.serviceapi.roles
Class RolesFactory

java.lang.Object
  |
  +--org.okiproject.serviceapi.roles.RolesFactory
All Implemented Interfaces:
java.io.Serializable

public class RolesFactory
extends java.lang.Object
implements java.io.Serializable

Copyright (c) 2001 Massachusetts Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

RolesFactory

The RolesFactory allows the application developer to create Roles objects in the Roles database, to get Roles objects from the Roles database given selection criteris, to ask questions of Roles such as who can do what with whom.

The key objects in Roles are Authorizations, Functions, People, and and Qualifiers. There are some other objects in Roles that play supporting roles. They are FunctionCatagory, QualifierType, Field, and FieldValue.

There are two methods to create Authorizations. One uses method uses Person, Function, and Qualifier. The other adds effective date and expiration date. For the method without the dates the effective date is today and there is no expiration date.

There are methods for getting Authorizations:

(1) getAuthsSimpleForm

This method is overloaded to allow for combinations
of filtering arguments to find matching Authorizations.

(2) getAuthsForDoingFWithQ

Given a Function and a Qualifier, finds a list of all
Authorizations that would permit a person to do the
Function with the Qualifier. This method is overloaded
so that Authorizations for Functions within a FunctionCategory
can be found. This uses a different algorithm than
getAuthsSimpleForm.

Note that the Qualifier in any found Authorization
might be a parent of the Qualifier give as an argument.

(3) getAuthsGeneralForm

Give a set of criteria/value paris, this method finds
all matching Authorizations. With the general form
the application developer can do anything that the
other two forms of getAuths can do and a lot more.

See Also:
Authorization, Authorizations, Person, Agents, Function, Functions, FunctionCategory, Qualifier, Qualifiers, QualifierType, Field, FieldValue,

$Source: /cvs/oki/org/okiproject/serviceapi/doc/roles/org/okiproject/serviceapi/roles/RolesFactory.html,v $, Serialized Form


Constructor Summary
RolesFactory()
           
 
Method Summary
 Authorization createAuthorization(org.okiproject.serviceapi.roles.Person person, Function function, Qualifier qualifier, GrantPrivilege grant, java.lang.Boolean doFunction)
          Method createAuthorization
 Authorization createAuthorization(org.okiproject.serviceapi.roles.Person person, Function function, Qualifier qualifier, GrantPrivilege grant, java.lang.Boolean doFunction, java.sql.Timestamp effectiveDate, java.sql.Timestamp expirationDate)
          Method createAuthorization
 Function createFunction(java.lang.String name, java.lang.String description, FunctionCategory functionCategory, QualifierType qualifierType)
          Method createFunction
 FunctionCategory createFunctionCategory(java.lang.String category, java.lang.String description)
          Method createFunctionCategory
 Qualifier createQualifier(QualifierType qualifierType, java.lang.String qualifierCode, java.lang.String qualifierDescription, Qualifier parent)
          Method createQualifier
 QualifierType createQualifierType(java.lang.String type, java.lang.String description)
          Method createQualifierType
 void deleteAuthorization(Authorization authorization)
          Method deleteAuthorization
 void deleteFunction(Function function)
          Method deleteFunction
 void deleteFunctionCategory(FunctionCategory functionCategory)
          Method deleteFunctionCategory
 void deleteQualifier(Qualifier qualifier)
          Method deleteQualifier
 void deleteQualifierType(QualifierType qualifierType)
          Method deleteQualifierType
 org.okiproject.serviceapi.common.Agent getAgent()
          Method getAgent
 Authorizations getAuthsForDoingFWithQ(FunctionCategory functionCategory, Qualifier qualifier, java.lang.Boolean isActiveNow)
          Method getAuthsForDoingFWithQ
 Authorizations getAuthsForDoingFWithQ(Function function, Qualifier qualifier, java.lang.Boolean isActiveNow)
          Method getAuthsForDoingFWithQ
 Authorizations getAuthsGeneralForm(FieldValue[] selectionCriteria)
          Method getAuthsGeneralForm
 Authorizations getAuthsSimpleForm(Function function, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(FunctionCategory functionCategory, Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(Function function, Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, Function function, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, FunctionCategory functionCategory, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, FunctionCategory functionCategory, Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, Function function, Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person, Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Authorizations getAuthsSimpleForm(Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Method getAuthsSimpleForm
 Field[] getCompleteAuthorizationFields()
          Method getCompleteAuthorizationFields
 Field[] getCompleteFunctionFields()
          Method getCompleteFunctionFields
 Field[] getCompletePersonFields()
          Method getCompletePersonFields
 Field[] getCompleteQualifierFields()
          Method getCompleteQualifierFields
 Field[] getCurrentAuthorizationFields()
          Method getCurrentAuthorizationFields
 Field[] getCurrentFunctionFields()
          Method getCurrentFunctionFields
 Field[] getCurrentPersonFields()
          Method getCurrentPersonFields
 Field[] getCurrentQualifierFields()
          Method getCurrentQualifierFields
 java.lang.String getDatabaseSymbolicName()
          Method getDatabaseSymbolicName
static java.lang.String[] getDatabaseSymbolicNames()
          Method getDatabaseSymbolicNames
 Field[] getDefaultAuthorizationFields()
          Method getDefaultAuthorizationFields
 Field[] getDefaultFunctionFields()
          Method getDefaultFunctionFields
 Field[] getDefaultPersonFields()
          Method getDefaultPersonFields
 Field[] getDefaultQualifierFields()
          Method getDefaultQualifierFields
static RolesFactory getDefaultRolesFactory(org.okiproject.serviceapi.common.Agent agent)
          Method getDefaultRolesFactory
 FunctionCategory[] getFunctionCategories()
          Method getFunctionCategories
 Functions getFunctionsGeneralForm(FieldValue[] selectionCriteria)
          Method getFunctionsGeneralForm
 Functions getFunctionsInCategory(FunctionCategory functionCategory)
          Method getFunctionsInCategory
 Field[] getMinimumAuthorizationFields()
          Method getMinimumAuthorizationFields
 Field[] getMinimumFunctionFields()
          Method getMinimumFunctionFields
 Field[] getMinimumPersonFields()
          Method getMinimumPersonFields
 Field[] getMinimumQualifierFields()
          Method getMinimumQualifierFields
 org.okiproject.serviceapi.common.Agents getPeopleGeneralForm(FieldValue[] selectionCriteria)
          Method getPeopleGeneralForm
 java.util.Map getProperties()
          Method getProperties
 Qualifiers getQualifierChildren(Qualifier qualifier)
          Method getQualifierChildren
 Qualifiers getQualifiersGeneralForm(FieldValue[] selectionCriteria, int start, int number)
          Method getQualifiersGeneralForm
 QualifierType[] getQualifierTypes()
          Method getQualifierTypes
static RolesFactory getRolesFactory(org.okiproject.serviceapi.common.Agent agent, java.util.Map props)
          Method getRolesFactory
 Qualifier getRootQualifier(QualifierType qualifierType)
          Method getRootQualifier
 org.okiproject.serviceapi.common.Agents getWhoCanDo(Function function, java.lang.Boolean isActiveNow)
          Method getWhoCanDo
 org.okiproject.serviceapi.common.Agents getWhoCanDo(FunctionCategory functionCategory, java.lang.Boolean isActiveNow)
          Method getWhoCanDo
 org.okiproject.serviceapi.common.Agents getWhoCanDo(FunctionCategory functionCategory, Qualifier qualifier, java.lang.Boolean isActiveNow)
          Method getWhoCanDo
 org.okiproject.serviceapi.common.Agents getWhoCanDo(Function function, Qualifier qualifier, java.lang.Boolean isActiveNow)
          Method getWhoCanDo
 org.okiproject.serviceapi.common.Agents getWhoCanDo(Qualifier qualifier, java.lang.Boolean isActiveNow)
          Method getWhoCanDo
 java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person, FunctionCategory functionCategory, Qualifier qualifier)
          Method isAuthorized
 java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person, Function function, Qualifier qualifier)
          Method isAuthorized
 java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person, Qualifier qualifier)
          Method isAuthorized
 java.lang.Boolean isFunctionCategoryFoundInRoles(FunctionCategory functionCategory)
          Method isFunctionCategoryFoundInRoles
 java.lang.Boolean isFunctionFoundInRoles(Function function)
          Method isFunctionFoundInRoles
 java.lang.Boolean isPersonFoundInRoles(org.okiproject.serviceapi.roles.Person person)
          Method isPersonFoundInRoles
 java.lang.Boolean isQualifierFoundInRoles(Qualifier qualifier)
          Method isQualifierFoundInRoles
 java.lang.Boolean isQualifierTypeFoundInRoles(QualifierType qualifierType)
          Method isQualifierTypeFoundInRoles
 Function newFunction(FunctionCategory functionCategory, java.lang.String name)
          Method newFunction
 Function newFunction(java.lang.String functionCategory, java.lang.String name)
          Method newFunction
 FunctionCategory newFunctionCategory(java.lang.String functionCategory)
          Method newFunctionCategory
 GrantPrivilege newGrantPrivilege(java.lang.String grantPrivilege)
          Method newGrantPrivilege
 org.okiproject.serviceapi.roles.Person newPerson(java.lang.Object key)
          Method newPerson
 Qualifier newQualifier(QualifierType qualifierType, java.lang.String qualifierCode)
          Method newQualifier
 Qualifier newQualifier(java.lang.String qualifierType, java.lang.String qualifierCode)
          Method newQualifier
 QualifierType newQualifierType(java.lang.String qualifierType)
          Method newQualifierType
 void refreshFunction(Function function)
          Method refreshFunction
 void refreshFunctionCategory(FunctionCategory functionCategory)
          Method refreshFunctionCategory
 void refreshPerson(org.okiproject.serviceapi.roles.Person person)
          Method refreshPerson
 void refreshQualifier(Qualifier qualifier)
          Method refreshQualifier
 void refreshQualifierType(QualifierType qualifierType)
          Method refreshQualifierType
 void setAgent(org.okiproject.serviceapi.common.Agent agent)
          Method setAgent
 void setCurrentAuthorizationFields(Field[] currentFields)
          Method setCurrentAuthorizationFields
 void setCurrentFunctionFields(Field[] currentFields)
          Method setCurrentFunctionFields
 void setCurrentPersonFields(Field[] currentFields)
          Method setCurrentPersonFields
 void setCurrentQualifierFields(Field[] currentFields)
          Method setCurrentQualifierFields
 void setDatabaseSymbolicName(java.lang.String databaseSymbolicName)
          Method setDatabaseSymbolicName
 void setProperties(java.util.Map properties)
          Method setProperties
 void updateAuthorization(Authorization authorization, org.okiproject.serviceapi.roles.Person person, Function function, Qualifier qualifier, GrantPrivilege grant, java.lang.Boolean doFunction, java.sql.Timestamp effectiveDate, java.sql.Timestamp expirationDate)
          Method updateAuthorization
 void updateFunction(Function function, java.lang.String newName, java.lang.String newDescription, FunctionCategory newFunctionCategory, QualifierType newQualifierType)
          Method updateFunction
 void updateFunctionCategory(FunctionCategory functionCategory, java.lang.String newDescription)
          Method updateFunctionCategory
 void updateQualifier(Qualifier qualifier, java.lang.String newQualifierCode, java.lang.String newDescription)
          Method updateQualifier
 void updateQualifierType(QualifierType qualifierType, java.lang.String newDescription)
          Method updateQualifierType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RolesFactory

public RolesFactory()
Method Detail

getDefaultRolesFactory

public static RolesFactory getDefaultRolesFactory(org.okiproject.serviceapi.common.Agent agent)
                                           throws java.lang.Exception
Method getDefaultRolesFactory
Parameters:
agent -  
Returns:
org.okiproject.serviceapi.roles.RolesFactory
Throws:
java.lang.Exception -  

getRolesFactory

public static RolesFactory getRolesFactory(org.okiproject.serviceapi.common.Agent agent,
                                           java.util.Map props)
                                    throws java.lang.Exception
Method getRolesFactory
Parameters:
agent -  
props -  
Returns:
org.okiproject.serviceapi.roles.RolesFactory
Throws:
java.lang.Exception -  

getAgent

public org.okiproject.serviceapi.common.Agent getAgent()
Method getAgent
Returns:
org.okiproject.serviceapi.common.Agent

setAgent

public void setAgent(org.okiproject.serviceapi.common.Agent agent)
Method setAgent
Parameters:
agent -  

getProperties

public java.util.Map getProperties()
Method getProperties
Returns:
java.util.Map

setProperties

public void setProperties(java.util.Map properties)
Method setProperties
Parameters:
properties -  

getDatabaseSymbolicNames

public static java.lang.String[] getDatabaseSymbolicNames()
                                                   throws java.lang.Exception
Method getDatabaseSymbolicNames
Returns:
String[]
Throws:
java.lang.Exception -  

getDatabaseSymbolicName

public java.lang.String getDatabaseSymbolicName()
                                         throws java.lang.Exception
Method getDatabaseSymbolicName
Returns:
String
Throws:
java.lang.Exception -  

setDatabaseSymbolicName

public void setDatabaseSymbolicName(java.lang.String databaseSymbolicName)
                             throws java.lang.Exception
Method setDatabaseSymbolicName
Parameters:
databaseSymbolicName -  
Throws:
java.lang.Exception -  

createAuthorization

public Authorization createAuthorization(org.okiproject.serviceapi.roles.Person person,
                                         Function function,
                                         Qualifier qualifier,
                                         GrantPrivilege grant,
                                         java.lang.Boolean doFunction,
                                         java.sql.Timestamp effectiveDate,
                                         java.sql.Timestamp expirationDate)
                                  throws java.lang.Exception
Method createAuthorization
Parameters:
person -  
function -  
qualifier -  
grant -  
doFunction -  
effectiveDate -  
expirationDate -  
Returns:
org.okiproject.serviceapi.roles.Authorization
Throws:
java.lang.Exception -  

createAuthorization

public Authorization createAuthorization(org.okiproject.serviceapi.roles.Person person,
                                         Function function,
                                         Qualifier qualifier,
                                         GrantPrivilege grant,
                                         java.lang.Boolean doFunction)
                                  throws java.lang.Exception
Method createAuthorization
Parameters:
person -  
function -  
qualifier -  
grant -  
doFunction -  
Returns:
org.okiproject.serviceapi.roles.Authorization
Throws:
java.lang.Exception -  

deleteAuthorization

public void deleteAuthorization(Authorization authorization)
                         throws java.lang.Exception
Method deleteAuthorization
Parameters:
authorization -  
Throws:
java.lang.Exception -  

updateAuthorization

public void updateAuthorization(Authorization authorization,
                                org.okiproject.serviceapi.roles.Person person,
                                Function function,
                                Qualifier qualifier,
                                GrantPrivilege grant,
                                java.lang.Boolean doFunction,
                                java.sql.Timestamp effectiveDate,
                                java.sql.Timestamp expirationDate)
                         throws java.lang.Exception
Method updateAuthorization
Parameters:
authorization -  
person -  
function -  
qualifier -  
grant -  
doFunction -  
effectiveDate -  
expirationDate -  
Throws:
java.lang.Exception -  

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(Function function,
                                                           Qualifier qualifier,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Method getWhoCanDo
Parameters:
function -  
qualifier -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(Function function,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Method getWhoCanDo
Parameters:
function -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(FunctionCategory functionCategory,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Method getWhoCanDo
Parameters:
functionCategory -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(FunctionCategory functionCategory,
                                                           Qualifier qualifier,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Method getWhoCanDo
Parameters:
functionCategory -  
qualifier -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(Qualifier qualifier,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Method getWhoCanDo
Parameters:
qualifier -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getAuthsForDoingFWithQ

public Authorizations getAuthsForDoingFWithQ(Function function,
                                             Qualifier qualifier,
                                             java.lang.Boolean isActiveNow)
                                      throws java.lang.Exception
Method getAuthsForDoingFWithQ
Parameters:
function -  
qualifier -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsForDoingFWithQ

public Authorizations getAuthsForDoingFWithQ(FunctionCategory functionCategory,
                                             Qualifier qualifier,
                                             java.lang.Boolean isActiveNow)
                                      throws java.lang.Exception
Method getAuthsForDoingFWithQ
Parameters:
functionCategory -  
qualifier -  
isActiveNow -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         Function function,
                                         Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
function -  
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         FunctionCategory functionCategory,
                                         Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
functionCategory -  
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         Function function,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
function -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         FunctionCategory functionCategory,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
functionCategory -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.roles.Person person,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
person -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(Function function,
                                         Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
function -  
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(FunctionCategory functionCategory,
                                         Qualifier qualifier,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
functionCategory -  
qualifier -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsSimpleForm

public Authorizations getAuthsSimpleForm(Function function,
                                         java.lang.Boolean isActiveNow,
                                         java.lang.Boolean expandFunctions,
                                         java.lang.Boolean expandQualifiers)
                                  throws java.lang.Exception
Method getAuthsSimpleForm
Parameters:
function -  
isActiveNow -  
expandFunctions -  
expandQualifiers -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getAuthsGeneralForm

public Authorizations getAuthsGeneralForm(FieldValue[] selectionCriteria)
                                   throws java.lang.Exception
Method getAuthsGeneralForm
Parameters:
selectionCriteria -  
Returns:
org.okiproject.serviceapi.roles.Authorizations
Throws:
java.lang.Exception -  

getMinimumAuthorizationFields

public Field[] getMinimumAuthorizationFields()
                                      throws java.lang.Exception
Method getMinimumAuthorizationFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getDefaultAuthorizationFields

public Field[] getDefaultAuthorizationFields()
                                      throws java.lang.Exception
Method getDefaultAuthorizationFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCompleteAuthorizationFields

public Field[] getCompleteAuthorizationFields()
                                       throws java.lang.Exception
Method getCompleteAuthorizationFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCurrentAuthorizationFields

public Field[] getCurrentAuthorizationFields()
                                      throws java.lang.Exception
Method getCurrentAuthorizationFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

setCurrentAuthorizationFields

public void setCurrentAuthorizationFields(Field[] currentFields)
                                   throws java.lang.Exception
Method setCurrentAuthorizationFields
Parameters:
currentFields -  
Throws:
java.lang.Exception -  

isAuthorized

public java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person,
                                      Function function,
                                      Qualifier qualifier)
                               throws java.lang.Exception
Method isAuthorized
Parameters:
person -  
function -  
qualifier -  
Returns:
Boolean
Throws:
java.lang.Exception -  

isAuthorized

public java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person,
                                      Qualifier qualifier)
                               throws java.lang.Exception
Method isAuthorized
Parameters:
person -  
qualifier -  
Returns:
Boolean
Throws:
java.lang.Exception -  

isAuthorized

public java.lang.Boolean isAuthorized(org.okiproject.serviceapi.roles.Person person,
                                      FunctionCategory functionCategory,
                                      Qualifier qualifier)
                               throws java.lang.Exception
Method isAuthorized
Parameters:
person -  
functionCategory -  
qualifier -  
Returns:
Boolean
Throws:
java.lang.Exception -  

createFunction

public Function createFunction(java.lang.String name,
                               java.lang.String description,
                               FunctionCategory functionCategory,
                               QualifierType qualifierType)
                        throws java.lang.Exception
Method createFunction
Parameters:
name -  
description -  
functionCategory -  
qualifierType -  
Returns:
org.okiproject.serviceapi.roles.Function
Throws:
java.lang.Exception -  

deleteFunction

public void deleteFunction(Function function)
                    throws java.lang.Exception
Method deleteFunction
Parameters:
function -  
Throws:
java.lang.Exception -  

isFunctionFoundInRoles

public java.lang.Boolean isFunctionFoundInRoles(Function function)
                                         throws java.lang.Exception
Method isFunctionFoundInRoles
Parameters:
function -  
Returns:
Boolean
Throws:
java.lang.Exception -  

refreshFunction

public void refreshFunction(Function function)
                     throws java.lang.Exception
Method refreshFunction
Parameters:
function -  
Throws:
java.lang.Exception -  

updateFunction

public void updateFunction(Function function,
                           java.lang.String newName,
                           java.lang.String newDescription,
                           FunctionCategory newFunctionCategory,
                           QualifierType newQualifierType)
                    throws java.lang.Exception
Method updateFunction
Parameters:
function -  
newName -  
newDescription -  
newFunctionCategory -  
newQualifierType -  
Throws:
java.lang.Exception -  

createFunctionCategory

public FunctionCategory createFunctionCategory(java.lang.String category,
                                               java.lang.String description)
                                        throws java.lang.Exception
Method createFunctionCategory
Parameters:
category -  
description -  
Returns:
org.okiproject.serviceapi.roles.FunctionCategory
Throws:
java.lang.Exception -  

deleteFunctionCategory

public void deleteFunctionCategory(FunctionCategory functionCategory)
                            throws java.lang.Exception
Method deleteFunctionCategory
Parameters:
functionCategory -  
Throws:
java.lang.Exception -  

isFunctionCategoryFoundInRoles

public java.lang.Boolean isFunctionCategoryFoundInRoles(FunctionCategory functionCategory)
                                                 throws java.lang.Exception
Method isFunctionCategoryFoundInRoles
Parameters:
functionCategory -  
Returns:
Boolean
Throws:
java.lang.Exception -  

refreshFunctionCategory

public void refreshFunctionCategory(FunctionCategory functionCategory)
                             throws java.lang.Exception
Method refreshFunctionCategory
Parameters:
functionCategory -  
Throws:
java.lang.Exception -  

updateFunctionCategory

public void updateFunctionCategory(FunctionCategory functionCategory,
                                   java.lang.String newDescription)
                            throws java.lang.Exception
Method updateFunctionCategory
Parameters:
functionCategory -  
newDescription -  
Throws:
java.lang.Exception -  

getFunctionCategories

public FunctionCategory[] getFunctionCategories()
                                         throws java.lang.Exception
Method getFunctionCategories
Returns:
org.okiproject.serviceapi.roles.FunctionCategory[]
Throws:
java.lang.Exception -  

getFunctionsInCategory

public Functions getFunctionsInCategory(FunctionCategory functionCategory)
                                 throws java.lang.Exception
Method getFunctionsInCategory
Parameters:
functionCategory -  
Returns:
org.okiproject.serviceapi.roles.Functions
Throws:
java.lang.Exception -  

getFunctionsGeneralForm

public Functions getFunctionsGeneralForm(FieldValue[] selectionCriteria)
                                  throws java.lang.Exception
Method getFunctionsGeneralForm
Parameters:
selectionCriteria -  
Returns:
org.okiproject.serviceapi.roles.Functions
Throws:
java.lang.Exception -  

getMinimumFunctionFields

public Field[] getMinimumFunctionFields()
                                 throws java.lang.Exception
Method getMinimumFunctionFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getDefaultFunctionFields

public Field[] getDefaultFunctionFields()
                                 throws java.lang.Exception
Method getDefaultFunctionFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCompleteFunctionFields

public Field[] getCompleteFunctionFields()
                                  throws java.lang.Exception
Method getCompleteFunctionFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCurrentFunctionFields

public Field[] getCurrentFunctionFields()
                                 throws java.lang.Exception
Method getCurrentFunctionFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

setCurrentFunctionFields

public void setCurrentFunctionFields(Field[] currentFields)
                              throws java.lang.Exception
Method setCurrentFunctionFields
Parameters:
currentFields -  
Throws:
java.lang.Exception -  

newFunction

public Function newFunction(FunctionCategory functionCategory,
                            java.lang.String name)
                     throws java.lang.Exception
Method newFunction
Parameters:
functionCategory -  
name -  
Returns:
org.okiproject.serviceapi.roles.Function
Throws:
java.lang.Exception -  

newFunction

public Function newFunction(java.lang.String functionCategory,
                            java.lang.String name)
                     throws java.lang.Exception
Method newFunction
Parameters:
functionCategory -  
name -  
Returns:
org.okiproject.serviceapi.roles.Function
Throws:
java.lang.Exception -  

newFunctionCategory

public FunctionCategory newFunctionCategory(java.lang.String functionCategory)
                                     throws java.lang.Exception
Method newFunctionCategory
Parameters:
functionCategory -  
Returns:
org.okiproject.serviceapi.roles.FunctionCategory
Throws:
java.lang.Exception -  

newGrantPrivilege

public GrantPrivilege newGrantPrivilege(java.lang.String grantPrivilege)
                                 throws java.lang.Exception
Method newGrantPrivilege
Parameters:
grantPrivilege -  
Returns:
org.okiproject.serviceapi.roles.GrantPrivilege
Throws:
java.lang.Exception -  

getPeopleGeneralForm

public org.okiproject.serviceapi.common.Agents getPeopleGeneralForm(FieldValue[] selectionCriteria)
                                                             throws java.lang.Exception
Method getPeopleGeneralForm
Parameters:
selectionCriteria -  
Returns:
org.okiproject.serviceapi.common.Agents
Throws:
java.lang.Exception -  

getMinimumPersonFields

public Field[] getMinimumPersonFields()
                               throws java.lang.Exception
Method getMinimumPersonFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getDefaultPersonFields

public Field[] getDefaultPersonFields()
                               throws java.lang.Exception
Method getDefaultPersonFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCompletePersonFields

public Field[] getCompletePersonFields()
                                throws java.lang.Exception
Method getCompletePersonFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCurrentPersonFields

public Field[] getCurrentPersonFields()
                               throws java.lang.Exception
Method getCurrentPersonFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

setCurrentPersonFields

public void setCurrentPersonFields(Field[] currentFields)
                            throws java.lang.Exception
Method setCurrentPersonFields
Parameters:
currentFields -  
Throws:
java.lang.Exception -  

newPerson

public org.okiproject.serviceapi.roles.Person newPerson(java.lang.Object key)
                                                 throws java.lang.Exception
Method newPerson
Parameters:
key -  
Returns:
org.okiproject.serviceapi.roles.Person
Throws:
java.lang.Exception -  

isPersonFoundInRoles

public java.lang.Boolean isPersonFoundInRoles(org.okiproject.serviceapi.roles.Person person)
                                       throws java.lang.Exception
Method isPersonFoundInRoles
Parameters:
person -  
Returns:
Boolean
Throws:
java.lang.Exception -  

refreshPerson

public void refreshPerson(org.okiproject.serviceapi.roles.Person person)
                   throws java.lang.Exception
Method refreshPerson
Parameters:
person -  
Throws:
java.lang.Exception -  

createQualifier

public Qualifier createQualifier(QualifierType qualifierType,
                                 java.lang.String qualifierCode,
                                 java.lang.String qualifierDescription,
                                 Qualifier parent)
                          throws java.lang.Exception
Method createQualifier
Parameters:
qualifierType -  
qualifierCode -  
qualifierDescription -  
parent -  
Returns:
org.okiproject.serviceapi.roles.Qualifier
Throws:
java.lang.Exception -  

deleteQualifier

public void deleteQualifier(Qualifier qualifier)
                     throws java.lang.Exception
Method deleteQualifier
Parameters:
qualifier -  
Throws:
java.lang.Exception -  

isQualifierFoundInRoles

public java.lang.Boolean isQualifierFoundInRoles(Qualifier qualifier)
                                          throws java.lang.Exception
Method isQualifierFoundInRoles
Parameters:
qualifier -  
Returns:
Boolean
Throws:
java.lang.Exception -  

refreshQualifier

public void refreshQualifier(Qualifier qualifier)
                      throws java.lang.Exception
Method refreshQualifier
Parameters:
qualifier -  
Throws:
java.lang.Exception -  

updateQualifier

public void updateQualifier(Qualifier qualifier,
                            java.lang.String newQualifierCode,
                            java.lang.String newDescription)
                     throws java.lang.Exception
Method updateQualifier
Parameters:
qualifier -  
newQualifierCode -  
newDescription -  
Throws:
java.lang.Exception -  

createQualifierType

public QualifierType createQualifierType(java.lang.String type,
                                         java.lang.String description)
                                  throws java.lang.Exception
Method createQualifierType
Parameters:
type -  
description -  
Returns:
org.okiproject.serviceapi.roles.QualifierType
Throws:
java.lang.Exception -  

deleteQualifierType

public void deleteQualifierType(QualifierType qualifierType)
                         throws java.lang.Exception
Method deleteQualifierType
Parameters:
qualifierType -  
Throws:
java.lang.Exception -  

isQualifierTypeFoundInRoles

public java.lang.Boolean isQualifierTypeFoundInRoles(QualifierType qualifierType)
                                              throws java.lang.Exception
Method isQualifierTypeFoundInRoles
Parameters:
qualifierType -  
Returns:
Boolean
Throws:
java.lang.Exception -  

refreshQualifierType

public void refreshQualifierType(QualifierType qualifierType)
                          throws java.lang.Exception
Method refreshQualifierType
Parameters:
qualifierType -  
Throws:
java.lang.Exception -  

updateQualifierType

public void updateQualifierType(QualifierType qualifierType,
                                java.lang.String newDescription)
                         throws java.lang.Exception
Method updateQualifierType
Parameters:
qualifierType -  
newDescription -  
Throws:
java.lang.Exception -  

getQualifierTypes

public QualifierType[] getQualifierTypes()
                                  throws java.lang.Exception
Method getQualifierTypes
Returns:
org.okiproject.serviceapi.roles.QualifierType[]
Throws:
java.lang.Exception -  

getRootQualifier

public Qualifier getRootQualifier(QualifierType qualifierType)
                           throws java.lang.Exception
Method getRootQualifier
Parameters:
qualifierType -  
Returns:
org.okiproject.serviceapi.roles.Qualifier
Throws:
java.lang.Exception -  

getQualifierChildren

public Qualifiers getQualifierChildren(Qualifier qualifier)
                                throws java.lang.Exception
Method getQualifierChildren
Parameters:
qualifier -  
Returns:
org.okiproject.serviceapi.roles.Qualifiers
Throws:
java.lang.Exception -  

getQualifiersGeneralForm

public Qualifiers getQualifiersGeneralForm(FieldValue[] selectionCriteria,
                                           int start,
                                           int number)
                                    throws java.lang.Exception
Method getQualifiersGeneralForm
Parameters:
selectionCriteria -  
start -  
number -  
Returns:
org.okiproject.serviceapi.roles.Qualifiers
Throws:
java.lang.Exception -  

getMinimumQualifierFields

public Field[] getMinimumQualifierFields()
                                  throws java.lang.Exception
Method getMinimumQualifierFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getDefaultQualifierFields

public Field[] getDefaultQualifierFields()
                                  throws java.lang.Exception
Method getDefaultQualifierFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCompleteQualifierFields

public Field[] getCompleteQualifierFields()
                                   throws java.lang.Exception
Method getCompleteQualifierFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

getCurrentQualifierFields

public Field[] getCurrentQualifierFields()
                                  throws java.lang.Exception
Method getCurrentQualifierFields
Returns:
org.okiproject.serviceapi.roles.Field[]
Throws:
java.lang.Exception -  

setCurrentQualifierFields

public void setCurrentQualifierFields(Field[] currentFields)
                               throws java.lang.Exception
Method setCurrentQualifierFields
Parameters:
currentFields -  
Throws:
java.lang.Exception -  

newQualifier

public Qualifier newQualifier(QualifierType qualifierType,
                              java.lang.String qualifierCode)
                       throws java.lang.Exception
Method newQualifier
Parameters:
qualifierType -  
qualifierCode -  
Returns:
org.okiproject.serviceapi.roles.Qualifier
Throws:
java.lang.Exception -  

newQualifier

public Qualifier newQualifier(java.lang.String qualifierType,
                              java.lang.String qualifierCode)
                       throws java.lang.Exception
Method newQualifier
Parameters:
qualifierType -  
qualifierCode -  
Returns:
org.okiproject.serviceapi.roles.Qualifier
Throws:
java.lang.Exception -  

newQualifierType

public QualifierType newQualifierType(java.lang.String qualifierType)
                               throws java.lang.Exception
Method newQualifierType
Parameters:
qualifierType -  
Returns:
org.okiproject.serviceapi.roles.QualifierType
Throws:
java.lang.Exception -