|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Source
Source to find and get Subjects and their attributes. You should probably extend BaseSourceAdapter instead of implement this interface
Method Summary | |
---|---|
void |
checkConfig()
make sure the config is ok, and log descriptive errors if not |
String |
getId()
Returns the ID of this source. |
String |
getInitParam(String name1)
get the init param e.g. |
Properties |
getInitParams()
get the init params e.g. |
String |
getName()
Returns the name of this source. |
Subject |
getSubject(String id)
Deprecated. use the overload instead |
Subject |
getSubject(String id,
boolean exceptionIfNull)
Gets a Subject by its ID. |
Subject |
getSubjectByIdentifier(String id)
Deprecated. use the overload instead |
Subject |
getSubjectByIdentifier(String id,
boolean exceptionIfNull)
Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID. |
Subject |
getSubjectByIdOrIdentifier(String idOrIdentifier,
boolean exceptionIfNull)
find by id or identifier. |
Map<String,Subject> |
getSubjectsByIdentifiers(Collection<String> identifiers)
Get subjects by identifiers. |
Map<String,Subject> |
getSubjectsByIds(Collection<String> ids)
Get subjects by ids. |
Map<String,Subject> |
getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Get subjects by ids or identifiers. |
Set<SubjectType> |
getSubjectTypes()
Gets the SubjectTypes supported by this source. |
void |
init()
Called by SourceManager when it loads this source. |
String |
printConfig()
in the startup on this i2mi app, print helpful and brief info about this source |
Set<Subject> |
search(String searchValue)
Unstructured search for Subjects. |
void |
setId(String id)
Sets the ID of this source. |
void |
setName(String name)
Sets the name of this source. |
Method Detail |
---|
String getId()
void setId(String id)
id
- String getName()
void setName(String name)
name
- Set<SubjectType> getSubjectTypes()
@Deprecated Subject getSubject(String id) throws SubjectNotFoundException, SubjectNotUniqueException
id
-
SubjectNotFoundException
SubjectNotUniqueException
@Deprecated Subject getSubjectByIdentifier(String id) throws SubjectNotFoundException, SubjectNotUniqueException
id
-
SubjectNotFoundException
SubjectNotUniqueException
Subject getSubject(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
id
- exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returned
SubjectNotFoundException
SubjectNotUniqueException
Map<String,Subject> getSubjectsByIds(Collection<String> ids)
ids
-
Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)
identifiers
-
Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
idsOrIdentifiers
- each string could be a subject id or identifier
Subject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
idOrIdentifier
- exceptionIfNull
- if SubjectNotFoundException or null
SubjectNotFoundException
SubjectNotUniqueException
Subject getSubjectByIdentifier(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
id
- exceptionIfNull
-
SubjectNotFoundException
SubjectNotUniqueException
Set<Subject> search(String searchValue)
searchValue
-
void init() throws SourceUnavailableException
SourceUnavailableException
void checkConfig()
String printConfig()
String getInitParam(String name1)
name1
-
Properties getInitParams()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |