|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryDao
Stores and retrieves directories. Directories are used for identifying a collection of users, groups and memberships.
Method Summary | |
---|---|
Directory |
add(Directory directory)
Store a new directory in the data store. |
java.util.List<Directory> |
findAll()
Returns the list of all directories in the data store, or empty list if there are no directories. |
Directory |
findById(long directoryId)
Returns the directory with the specified ID, throwing DirectoryNotFoundException if it cannot be found. |
Directory |
findByName(java.lang.String name)
Returns the directory with the specified name, throwing DirectoryNotFoundException if it cannot be found. |
void |
remove(Directory directory)
Removes the specified directory from the data store. |
java.util.List<Directory> |
search(EntityQuery<Directory> entityQuery)
Search for directories matching the specified query. |
Directory |
update(Directory directory)
Persists any changes made to the provided directory. |
Method Detail |
---|
Directory findById(long directoryId) throws DirectoryNotFoundException
DirectoryNotFoundException
if it cannot be found.
directoryId
- the ID of the directory to find
DirectoryNotFoundException
- if there is no directory with the specified IDDirectory findByName(java.lang.String name) throws DirectoryNotFoundException
DirectoryNotFoundException
if it cannot be found.
name
- the name of the directory to find
DirectoryNotFoundException
- if there is no directory with the specified namejava.util.List<Directory> findAll()
Directory add(Directory directory)
directory
- the directory to persist
Directory update(Directory directory) throws DirectoryNotFoundException
directory
- the directory which has changes to persist
DirectoryNotFoundException
- if the directory is not found in the data storevoid remove(Directory directory) throws DirectoryNotFoundException
directory
- the directory to remove
DirectoryNotFoundException
- if the directory does not existjava.util.List<Directory> search(EntityQuery<Directory> entityQuery)
entityQuery
- the search query to run against the directory data store
QueryBuilder.queryFor(java.lang.Class, com.atlassian.crowd.search.EntityDescriptor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |