|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface SubjectResolver
Subject resolution interface.
| Method Summary | |
|---|---|
edu.internet2.middleware.subject.Subject |
find(java.lang.String id)
|
edu.internet2.middleware.subject.Subject |
find(java.lang.String id,
java.lang.String source)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
find subjects in a set of sources |
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query,
java.lang.String source)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAllInStem(java.lang.String stemName,
java.lang.String query)
|
edu.internet2.middleware.subject.Subject |
findByIdentifier(java.lang.String id)
|
edu.internet2.middleware.subject.Subject |
findByIdentifier(java.lang.String id,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(java.util.Collection<java.lang.String> identifiers)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(java.util.Collection<java.lang.String> identifiers,
java.lang.String source)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String id)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String id,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIds(java.util.Collection<java.lang.String> ids)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIds(java.util.Collection<java.lang.String> ids,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers,
java.lang.String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
find a page of subjects in a set of sources |
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query,
java.lang.String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPageInStem(java.lang.String stemName,
java.lang.String query)
|
void |
flushCache()
flush the cache (e.g. for testing) |
edu.internet2.middleware.subject.Source |
getSource(java.lang.String id)
|
java.util.Set<edu.internet2.middleware.subject.Source> |
getSources()
|
| Method Detail |
|---|
void flushCache()
edu.internet2.middleware.subject.Subject find(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject id to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
edu.internet2.middleware.subject.Subject find(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject id to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query)
throws java.lang.IllegalArgumentException
query - A source-appropraite query string.
java.lang.IllegalArgumentException - if any parameter is null.
java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
throws java.lang.IllegalArgumentException
query - sources -
java.lang.IllegalArgumentException
edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
throws edu.internet2.middleware.subject.SourceUnavailableException
query - sources -
edu.internet2.middleware.subject.SourceUnavailableException
java.util.Set<edu.internet2.middleware.subject.Subject> findAllInStem(java.lang.String stemName,
java.lang.String query)
throws java.lang.IllegalArgumentException
stemName - name of stem we are queryingquery - A source-appropriate query string.
java.lang.IllegalArgumentException - if any parameter is null.
java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
query - A source-appropriate query string.source - Restrict query to within this source.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.Subject findByIdentifier(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject identifier to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
edu.internet2.middleware.subject.Subject findByIdentifier(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject identifier to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
edu.internet2.middleware.subject.Source getSource(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
id -
java.lang.IllegalArgumentException - if id is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source cannot be returned.java.util.Set<edu.internet2.middleware.subject.Source> getSources()
edu.internet2.middleware.subject.Subject findByIdOrIdentifier(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject identifier to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
edu.internet2.middleware.subject.Subject findByIdOrIdentifier(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
id - Subject identifier to search on.type - Subject type to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query)
throws java.lang.IllegalArgumentException
query - A source-appropraite query string.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
query - A source-appropriate query string.source - Restrict query to within this source.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SearchPageResult findPageInStem(java.lang.String stemName,
java.lang.String query)
throws java.lang.IllegalArgumentException
stemName - name of stem we are queryingquery - A source-appropriate query string.
java.lang.IllegalArgumentException - if any parameter is null.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers)
throws java.lang.IllegalArgumentException
idsOrIdentifiers - Subject identifiers to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
id - Subject identifier to search on.type - Subject type to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIds(java.util.Collection<java.lang.String> ids)
throws java.lang.IllegalArgumentException
ids - Subject id to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIds(java.util.Collection<java.lang.String> ids,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
id - Subject id to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdentifiers(java.util.Collection<java.lang.String> identifiers)
throws java.lang.IllegalArgumentException
id - Subject identifier to search on.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdentifiers(java.util.Collection<java.lang.String> identifiers,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
id - Subject identifier to search on.source - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException - if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException - if more than one matching subject is found.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||