Package edu.internet2.middleware.grouper.subj

Interface SubjectResolver

All Known Implementing Classes:

CachingResolver, SourcesXmlResolver, SubjectResolverDecorator, ValidatingResolver

public interface SubjectResolver

Subject resolution interface.

Since:

1.2.1

Version:

$Id: SubjectResolver.java,v 1.5 2008-08-26 21:11:51 mchyzer Exp $

Method Summary

Modifier and Type	Method	Description
Subject	find(String id)
Subject	find(String id, boolean ignoreCachedSubjects)
Subject	find(String id, String source)
Subject	find(String id, String source, boolean ignoreCachedSubjects)
Set<Subject>	findAll(String query)
Set<Subject>	findAll(String query, String source)
Set<Subject>	findAll(String query, Set<Source> sources)	find subjects in a set of sources
Set<Subject>	findAllInStem(String stemName, String query)
Subject	findByIdentifier(String id)
Subject	findByIdentifier(String id, boolean ignoreCachedSubjects)
Subject	findByIdentifier(String id, String source)
Subject	findByIdentifier(String id, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIdentifiers(Collection<String> identifiers)
Map<String,Subject>	findByIdentifiers(Collection<String> identifiers, String source)
Subject	findByIdOrIdentifier(String id)
Subject	findByIdOrIdentifier(String id, boolean ignoreCachedSubjects)
Subject	findByIdOrIdentifier(String id, String source)
Subject	findByIdOrIdentifier(String id, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIds(Collection<String> ids)
Map<String,Subject>	findByIds(Collection<String> ids, String source)
Map<String,Subject>	findByIds(Collection<String> ids, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String source)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, Set<Source> sources)
SearchPageResult	findPage(String query)
SearchPageResult	findPage(String query, String source)
SearchPageResult	findPage(String query, Set<Source> sources)	find a page of subjects in a set of sources
SearchPageResult	findPageInStem(String stemName, String query)
SearchPageResult	findPageInStem(String stemName, String query, Set<Source> sources)
void	flushCache()	flush the cache (e.g. for testing)
Source	getSource(String id)
Set<Source>	getSources()
Set<Source>	getSources(boolean enabledOnly)

Method Details

flushCache

void flushCache()

flush the cache (e.g. for testing)

find

Subject find(String id)
      throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject id to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

find

Subject find(String id,
 boolean ignoreCachedSubjects)
      throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject id to search on.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

find

Subject find(String id,
 String source)
      throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject id to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

find

Subject find(String id,
 String source,
 boolean ignoreCachedSubjects)
      throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject id to search on.

source - Source adapter to search within.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

findAll

Set<Subject> findAll(String query)
              throws IllegalArgumentException

Parameters:

query - A source-appropraite query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

1.2.1

findAll

Set<Subject> findAll(String query,
 Set<Source> sources)
              throws IllegalArgumentException

find subjects in a set of sources

Parameters:

query -

sources -

Returns:

the subjects

Throws:

IllegalArgumentException

findPage

SearchPageResult findPage(String query,
 Set<Source> sources)
                   throws SourceUnavailableException

find a page of subjects in a set of sources

Parameters:

query -

sources -

Returns:

the page of subjects

Throws:

SourceUnavailableException

findAllInStem

Set<Subject> findAllInStem(String stemName,
 String query)
                    throws IllegalArgumentException

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

1.2.1

findAll

Set<Subject> findAll(String query,
 String source)
              throws IllegalArgumentException,
SourceUnavailableException

Parameters:

query - A source-appropriate query string.

source - Restrict query to within this source.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

Since:

1.2.1

findByIdentifier

Subject findByIdentifier(String id)
                  throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

findByIdentifier

Subject findByIdentifier(String id,
 boolean ignoreCachedSubjects)
                  throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

findByIdentifier

Subject findByIdentifier(String id,
 String source)
                  throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

findByIdentifier

Subject findByIdentifier(String id,
 String source,
 boolean ignoreCachedSubjects)
                  throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

getSource

Source getSource(String id)
          throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id -

Returns:

Subject source identified by id.

Throws:

IllegalArgumentException - if id is null.

SourceUnavailableException - if source cannot be returned.

Since:

1.2.1

getSources

Set<Source> getSources()

Returns:

All Subject sources.

Since:

1.2.1

getSources

Set<Source> getSources(boolean enabledOnly)

Parameters:

enabledOnly -

Returns:

All Subject sources.

findByIdOrIdentifier

Subject findByIdOrIdentifier(String id)
                      throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

findByIdOrIdentifier

Subject findByIdOrIdentifier(String id,
 boolean ignoreCachedSubjects)
                      throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

findByIdOrIdentifier

Subject findByIdOrIdentifier(String id,
 String source)
                      throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

findByIdOrIdentifier

Subject findByIdOrIdentifier(String id,
 String source,
 boolean ignoreCachedSubjects)
                      throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

source - Source adapter to search within.

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

findPage

SearchPageResult findPage(String query)
                   throws IllegalArgumentException

Parameters:

query - A source-appropraite query string.

Returns:

Paged subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

2.0.2

findPage

SearchPageResult findPage(String query,
 String source)
                   throws IllegalArgumentException,
SourceUnavailableException

Parameters:

query - A source-appropriate query string.

source - Restrict query to within this source.

Returns:

Page of subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

Since:

2.0.2

findPageInStem

SearchPageResult findPageInStem(String stemName,
 String query)
                         throws IllegalArgumentException

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

2.0.2

findPageInStem

SearchPageResult findPageInStem(String stemName,
 String query,
 Set<Source> sources)
                         throws IllegalArgumentException

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

source -

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

2.0.2

findByIdsOrIdentifiers

Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
                                    throws IllegalArgumentException

Parameters:

idsOrIdentifiers - Subject identifiers to search on.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIdsOrIdentifiers

Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
 String source)
                                    throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIdsOrIdentifiers

Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
 Set<Source> sources)
                                    throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

sources - Source adapters to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIds

Map<String,Subject> findByIds(Collection<String> ids)
                       throws IllegalArgumentException

Parameters:

ids - Subject id to search on.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIds

Map<String,Subject> findByIds(Collection<String> ids,
 String source)
                       throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id - Subject id to search on.

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIds

Map<String,Subject> findByIds(Collection<String> ids,
 String source,
 boolean ignoreCachedSubjects)
                       throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id - Subject id to search on.

source - Source adapter to search within.

ignoreCachedSubjects -

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIdentifiers

Map<String,Subject> findByIdentifiers(Collection<String> identifiers)
                               throws IllegalArgumentException

Parameters:

id - Subject identifier to search on.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2

findByIdentifiers

Map<String,Subject> findByIdentifiers(Collection<String> identifiers,
 String source)
                               throws IllegalArgumentException,
SourceUnavailableException

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

2.0.2