edu.internet2.middleware.grouper.internal.dao

Interface AttributeDefNameDAO

All Superinterfaces:

GrouperDAO

All Known Implementing Classes:

Hib3AttributeDefNameDAO

public interface AttributeDefNameDAO
extends GrouperDAO

attribute def name data access methods

Method Summary

Modifier and Type	Method and Description
void	delete(AttributeDefName attributeDefName) delete this attribute def name
Set<AttributeDefName>	findAllAttributeNamesSecure(String scope, boolean splitScope, GrouperSession grouperSession, String attributeDefId, Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType) get all attribute names secure, split the scope by whitespace
Set<AttributeDefName>	findAllAttributeNamesSecure(String scope, boolean splitScope, GrouperSession grouperSession, String attributeDefId, Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, ServiceRole serviceRole, boolean anyServiceRole) get all attribute names secure, split the scope by whitespace
Set<AttributeDefName>	findAllAttributeNamesSecure(String scope, boolean splitScope, GrouperSession grouperSession, String attributeDefId, Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, ServiceRole serviceRole, boolean anyServiceRole, String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName) get all attribute names secure, split the scope by whitespace
Set<AttributeDefName>	findAllAttributeNamesSecure(String scope, boolean splitScope, GrouperSession grouperSession, String attributeDefId, Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, ServiceRole serviceRole, boolean anyServiceRole, String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName, Set<String> idsOfAttributeDefNames) get all attribute names secure, split the scope by whitespace
Set<AttributeDefName>	findAllAttributeNamesSplitScopeSecure(String scope, GrouperSession grouperSession, String attributeDefId, Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType) get all attribute names secure, split the scope by whitespace
Set<AttributeDefName>	findAllSecure(String searchField, Set<String> searchInAttributeDefIds, QueryOptions queryOptions) search for attributeDefName by name, display name, or description.
Set<AttributeDefName>	findByAttributeDef(String id) Find all that have the given attribute def id.
Set<AttributeDefName>	findByAttributeDefLike(String attributeDefId, String likeString) search for all by attribute def id, and like string
AttributeDefName	findById(String id, boolean exceptionIfNotFound)
AttributeDefName	findByIdIndex(Long idIndex, boolean exceptionIfNotFound, QueryOptions queryOptions)
AttributeDefName	findByIdIndexSecure(Long idIndex, boolean exceptionIfNotFound, QueryOptions queryOptions)
AttributeDefName	findByIdSecure(String id, boolean exceptionIfNotFound)
AttributeDefName	findByIdSecure(String id, boolean exceptionIfNotFound, QueryOptions queryOptions)
Set<AttributeDefName>	findByIdsSecure(Collection<String> ids, QueryOptions queryOptions) find by ids secure
AttributeDefName	findByName(String name, boolean exceptionIfNotFound, QueryOptions queryOptions) find an attribute def name by name as root (no security)
AttributeDefName	findByNameSecure(String name, boolean exceptionIfNotFound) find an attribute def name by name
AttributeDefName	findByNameSecure(String name, boolean exceptionIfNotFound, QueryOptions queryOptions) find an attribute def name by name
Set<AttributeDefName>	findByStem(String id) Find all that have the given stem id.
AttributeDefName	findByUuidOrName(String id, String name, boolean exceptionIfNotFound) find a record by uuid or name
AttributeDefName	findByUuidOrName(String id, String name, boolean exceptionIfNotFound, QueryOptions queryOptions) find a record by uuid or name
AttributeDefName	findLegacyAttributeByName(String name, boolean exceptionIfNull) Returns legacy attribute that was either migrated or created in the new attribute framework.
void	saveOrUpdate(AttributeDefName attributeDefName) insert or update an attribute def name object
void	saveUpdateProperties(AttributeDefName attributeDefName) save the update properties which are auto saved when business method is called

Method Detail

saveOrUpdate

void saveOrUpdate(AttributeDefName attributeDefName)

insert or update an attribute def name object

Parameters:

attributeDefName -

findByIdsSecure

Set<AttributeDefName> findByIdsSecure(Collection<String> ids,
                                      QueryOptions queryOptions)

find by ids secure

Parameters:

ids -

queryOptions -

Returns:

the attributeDefNames or null or exception

findByIdSecure

AttributeDefName findByIdSecure(String id,
                                boolean exceptionIfNotFound)

Parameters:

id -

exceptionIfNotFound -

Returns:

the attribute def name or null if not there

findByIdSecure

AttributeDefName findByIdSecure(String id,
                                boolean exceptionIfNotFound,
                                QueryOptions queryOptions)

Parameters:

id -

exceptionIfNotFound -

queryOptions -

Returns:

the attribute def name or null if not there

findById

AttributeDefName findById(String id,
                          boolean exceptionIfNotFound)

Parameters:

id -

exceptionIfNotFound -

Returns:

the attribute def name or null if not there

findByNameSecure

AttributeDefName findByNameSecure(String name,
                                  boolean exceptionIfNotFound)
                           throws GrouperDAOException,
                                  AttributeDefNameNotFoundException

find an attribute def name by name

Parameters:

name -

exceptionIfNotFound -

Returns:

name

Throws:

GrouperDAOException

AttributeDefNameNotFoundException

findByNameSecure

AttributeDefName findByNameSecure(String name,
                                  boolean exceptionIfNotFound,
                                  QueryOptions queryOptions)
                           throws GrouperDAOException,
                                  AttributeDefNameNotFoundException

find an attribute def name by name

Parameters:

name -

exceptionIfNotFound -

queryOptions -

Returns:

name

Throws:

GrouperDAOException

AttributeDefNameNotFoundException

findByName

AttributeDefName findByName(String name,
                            boolean exceptionIfNotFound,
                            QueryOptions queryOptions)
                     throws GrouperDAOException,
                            AttributeDefNameNotFoundException

find an attribute def name by name as root (no security)

Parameters:

name -

exceptionIfNotFound -

queryOptions -

Returns:

name

Throws:

GrouperDAOException

AttributeDefNameNotFoundException

delete

void delete(AttributeDefName attributeDefName)

delete this attribute def name

Parameters:

attributeDefName -

findByStem

Set<AttributeDefName> findByStem(String id)

Find all that have the given stem id.

Parameters:

id -

Returns:

set of attribute def names

findByAttributeDef

Set<AttributeDefName> findByAttributeDef(String id)

Find all that have the given attribute def id.

Parameters:

id -

Returns:

set of attribute def names

findByUuidOrName

AttributeDefName findByUuidOrName(String id,
                                  String name,
                                  boolean exceptionIfNotFound)

find a record by uuid or name

Parameters:

id -

name -

exceptionIfNotFound -

Returns:

the attribute def name

findByUuidOrName

AttributeDefName findByUuidOrName(String id,
                                  String name,
                                  boolean exceptionIfNotFound,
                                  QueryOptions queryOptions)

find a record by uuid or name

Parameters:

id -

name -

exceptionIfNotFound -

queryOptions -

Returns:

the attribute def name

findByIdIndex

AttributeDefName findByIdIndex(Long idIndex,
                               boolean exceptionIfNotFound,
                               QueryOptions queryOptions)
                        throws AttributeDefNameNotFoundException

Parameters:

idIndex -

exceptionIfNotFound -

queryOptions -

Throws:

AttributeDefNameNotFoundException

Since:

2.2

findByIdIndexSecure

AttributeDefName findByIdIndexSecure(Long idIndex,
                                     boolean exceptionIfNotFound,
                                     QueryOptions queryOptions)
                              throws AttributeDefNameNotFoundException

Parameters:

idIndex -

exceptionIfNotFound -

queryOptions -

Throws:

AttributeDefNameNotFoundException

Since:

2.2

saveUpdateProperties

void saveUpdateProperties(AttributeDefName attributeDefName)

save the update properties which are auto saved when business method is called

Parameters:

attributeDefName -

findAllSecure

Set<AttributeDefName> findAllSecure(String searchField,
                                    Set<String> searchInAttributeDefIds,
                                    QueryOptions queryOptions)

search for attributeDefName by name, display name, or description. This is a secure method, a GrouperSession must be open. Note, you should add the % signs before calling this method

Parameters:

searchField - substring to search for

searchInAttributeDefIds - ids to search in or null for all

queryOptions -

Returns:

the attribute def names or empty set

findByAttributeDefLike

Set<AttributeDefName> findByAttributeDefLike(String attributeDefId,
                                             String likeString)

search for all by attribute def id, and like string

Parameters:

attributeDefId -

likeString -

Returns:

the attribute def names or empty set

findAllAttributeNamesSplitScopeSecure

Set<AttributeDefName> findAllAttributeNamesSplitScopeSecure(String scope,
                                                            GrouperSession grouperSession,
                                                            String attributeDefId,
                                                            Subject subject,
                                                            Set<Privilege> privileges,
                                                            QueryOptions queryOptions,
                                                            AttributeAssignType attributeAssignType,
                                                            AttributeDefType attributeDefType)

get all attribute names secure, split the scope by whitespace

Parameters:

scope -

attributeDefId - optional if filtering by names in a certain attribute definition

grouperSession -

subject -

privileges -

queryOptions -

attributeAssignType -

attributeDefType -

Returns:

set of attribute defs

findAllAttributeNamesSecure

Set<AttributeDefName> findAllAttributeNamesSecure(String scope,
                                                  boolean splitScope,
                                                  GrouperSession grouperSession,
                                                  String attributeDefId,
                                                  Subject subject,
                                                  Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  AttributeAssignType attributeAssignType,
                                                  AttributeDefType attributeDefType)

get all attribute names secure, split the scope by whitespace

Parameters:

scope -

splitScope -

attributeDefId - optional if filtering by names in a certain attribute definition

grouperSession -

subject -

privileges -

queryOptions -

attributeAssignType -

attributeDefType -

Returns:

set of attribute defs

findAllAttributeNamesSecure

Set<AttributeDefName> findAllAttributeNamesSecure(String scope,
                                                  boolean splitScope,
                                                  GrouperSession grouperSession,
                                                  String attributeDefId,
                                                  Subject subject,
                                                  Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  AttributeAssignType attributeAssignType,
                                                  AttributeDefType attributeDefType,
                                                  ServiceRole serviceRole,
                                                  boolean anyServiceRole)

get all attribute names secure, split the scope by whitespace

Parameters:

scope -

splitScope -

attributeDefId - optional if filtering by names in a certain attribute definition

grouperSession -

subject -

privileges -

queryOptions -

attributeAssignType -

attributeDefType -

anyServiceRole - will see if the user has any role in a service, and return those services

Returns:

set of attribute defs

findLegacyAttributeByName

AttributeDefName findLegacyAttributeByName(String name,
                                           boolean exceptionIfNull)

Returns legacy attribute that was either migrated or created in the new attribute framework.

Parameters:

name - the name of the legacy attribute (without prefix or path)

exceptionIfNull -

Returns:

attribute def name

findAllAttributeNamesSecure

Set<AttributeDefName> findAllAttributeNamesSecure(String scope,
                                                  boolean splitScope,
                                                  GrouperSession grouperSession,
                                                  String attributeDefId,
                                                  Subject subject,
                                                  Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  AttributeAssignType attributeAssignType,
                                                  AttributeDefType attributeDefType,
                                                  ServiceRole serviceRole,
                                                  boolean anyServiceRole,
                                                  String parentStemId,
                                                  Stem.Scope stemScope,
                                                  boolean findByUuidOrName)

get all attribute names secure, split the scope by whitespace

Parameters:

scope -

splitScope -

attributeDefId - optional if filtering by names in a certain attribute definition

grouperSession -

subject -

privileges -

queryOptions -

attributeAssignType -

attributeDefType -

serviceRole -

anyServiceRole - will see if the user has any role in a service, and return those services

parentStemId - is the id of the parent or ancestor of the object returned

stemScope - is if the stem scope is ONE or SUB

findByUuidOrName - if looking for attribute def names by uuid or name

Returns:

set of attribute defs

Since:

v2.2.0

findAllAttributeNamesSecure

Set<AttributeDefName> findAllAttributeNamesSecure(String scope,
                                                  boolean splitScope,
                                                  GrouperSession grouperSession,
                                                  String attributeDefId,
                                                  Subject subject,
                                                  Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  AttributeAssignType attributeAssignType,
                                                  AttributeDefType attributeDefType,
                                                  ServiceRole serviceRole,
                                                  boolean anyServiceRole,
                                                  String parentStemId,
                                                  Stem.Scope stemScope,
                                                  boolean findByUuidOrName,
                                                  Set<String> idsOfAttributeDefNames)

get all attribute names secure, split the scope by whitespace

Parameters:

scope -

splitScope -

attributeDefId - optional if filtering by names in a certain attribute definition

grouperSession -

subject -

privileges -

queryOptions -

attributeAssignType -

attributeDefType -

serviceRole -

anyServiceRole - will see if the user has any role in a service, and return those services

parentStemId - is the id of the parent or ancestor of the object returned

stemScope - is if the stem scope is ONE or SUB

findByUuidOrName - if looking for attribute def names by uuid or name

idsOfAttributeDefNames - ids of attribute def names to lookup

Returns:

set of attribute defs

Since:

v2.2.1