|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
AciResponse |
addDocumentToProfile(User user,
java.lang.String sDocumentRef)
Add a given document to a user's profile. |
AciResponse |
deleteAllUserProfiles(User user)
Remove all the profile assosciated with a user. |
AciResponse |
deleteProfile(Profile profile)
Remove the given user profile. |
Profile |
getProfile(java.lang.String sProfileID)
Reads the details of a user agent from IDOL. |
java.util.ArrayList |
getProfileList(User user)
Read the details of a user's profiles from IDOL. |
ResultList |
getProfileResults(Profile profile,
java.util.ArrayList alProfileGetResultsParams)
Retrieve the documents that currently match the user's profile. |
Method Detail |
public AciResponse addDocumentToProfile(User user, java.lang.String sDocumentRef) throws AciException, UserNotFoundException
user
- the user whose profile should be updated.sDocumentRef
- the reference of the document to add to the user's profile.
AciException
- if there was an error when making the request.
UserNotFoundException
- if the user does not exist on IDOL.public Profile getProfile(java.lang.String sProfileID) throws AciException, ProfileNotFoundException, UserNotFoundException
sProfileID
- the unique ID of the profile whose details are required.
Profile
object representing the required profile.
AciException
- if there was an error when making the request.
ProfileNotFoundException
- if the specified profile does not exist on IDOL.
UserNotFoundException
- if the specified user does not exist on IDOL.public ResultList getProfileResults(Profile profile, java.util.ArrayList alProfileGetResultsParams) throws AciException, UserNotFoundException, DataStoreNotFoundException
profile
- the profile whose results are required.alProfileGetResultsParams
- extra parameters to send when retrieving profile results. Parameters
set here will override any parameters set by the profile. Can be null
.
ResultList
containing the documents matching the user's profile.
AciException
- if there was an error when making the request.
UserNotFoundException
- if the specified user does not exist on IDOL.
DataStoreNotFoundException
- if the content Suir was not available to retrieve results from.public AciResponse deleteProfile(Profile profile) throws AciException, ProfileNotFoundException
profile
- the profile to delete.
ProfileNotFoundException
AciException
- if there was an error when making the request.public AciResponse deleteAllUserProfiles(User user) throws AciException
user
- the owner of the profiles to remove.
AciException
- if there was an error when making the request.public java.util.ArrayList getProfileList(User user) throws AciException, UserNotFoundException
user
- the user whose profile should be deleted.
ArrayList
of Profile
objects representing the profiles the user
has stored on IDOL.
AciException
- if there was an error when making the request.
UserNotFoundException
- if the specified user does not exist on IDOL.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |