|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaggingService
The TaggingService is the main interface for the tagging functionality within WebCenter. It allows for the creation, updating, and discovery of Bookmarks and Tags in the system, scoped to the user or to the overall system.
Method Summary | |
---|---|
Bookmark |
createBookmark(java.lang.String serviceId, java.lang.String resourceId, java.lang.String resourceScope, java.lang.String resourceName, java.lang.String userId) Creates a new Bookmark with all its constituents. |
void |
deleteBookmark(Bookmark bookmark) Deletes the passed in bookmark. |
boolean |
deletePersonalTag(java.lang.String userId, java.lang.String tagWord) Delete the specified tags on all the bookmark owned by the specified userId |
void |
deleteResource(java.lang.String serviceId, java.lang.String resourceId) Delete a resource |
java.util.List<Tag> |
findAllTopFilteredPersonalTags(Order order, java.lang.String userId, java.lang.String filter, boolean includePrivate) Deprecated. |
java.util.List<Tag> |
findAllTopFilteredSystemTags(Order order, java.lang.String userId, java.lang.String filter) Deprecated. |
java.util.List<Resource> |
findFilteredPersonalResources(Order order, java.lang.String userId, java.lang.String nameFilter) Finds a list of resources whose name contains the specified substring filter and have been tagged by the current userId. |
java.util.List<Resource> |
findFilteredPersonalResources(Order order, java.lang.String userId, java.lang.String nameFilter, java.lang.String serviceId) Finds a list of resources whose name contains the specified substring filter and have been tagged by the current userId. |
java.util.List<Tag> |
findFilteredPersonalTags(Order order, java.lang.String userId, java.lang.String filter) Deprecated. |
java.util.List<Resource> |
findPersonalResources(Order order, java.lang.String userId, java.util.List<java.lang.String> userFilters, java.lang.String tagFilters, boolean includePrivate) Finds a list of resources that have been tagged by the specified current user and with the specified keywords. |
java.util.List<Tag> |
findPopularTags(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, int size, Order order) Finds popular tags |
java.util.List<Tag> |
findPopularTags(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, java.lang.String resourceScope, int size, Order order) Finds popular tags |
java.util.List<Tag> |
findPopularTags(java.lang.String serviceId, java.lang.String resourceId, int size) Find popular tags on a given resource |
java.util.List<Tag> |
findPopularTagsCommon(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, java.lang.String serviceId, int size, Order order) Finds popular tags |
java.util.List<Tag> |
findRecommendedTags(java.lang.String serviceId, java.lang.String resourceId, java.lang.String userId, int count) Finds a list of recommended tags related to the current resource being tagged. |
java.util.List<Resource> |
findRelatedSystemResources(java.lang.String serviceId, java.lang.String resourceId) Finds a list of resources that are related to the current resource. |
java.util.List<Tag> |
findRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) Finds a list of tags in the system that are related to the specified tag word. |
java.util.List<Tag> |
findRelatedTags(java.lang.String serviceId, java.lang.String resourceId) Finds a list of tags that are related to the current resource. |
java.util.List<User> |
findRelatedUsers(java.lang.String serviceId, java.lang.String resourceId) Finds a list of users that are related to the current resource. |
java.util.List<User> |
findRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) Finds a list of users that are related to the specified tag word. |
java.util.List<User> |
findRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) Finds a list of users that are related to the specified tag word. |
java.util.List<Resource> |
findSystemResources(Order order, java.lang.String userId, java.util.List<java.lang.String> userFilters, java.lang.String tagFilters) Finds a list of Resources in the system that have been tagged with the specified keywords. |
java.util.List<Tag> |
findSystemTags(java.lang.String userId, java.lang.String keywords, boolean useWildcard) Deprecated. |
java.util.List<Tag> |
findTopFilteredPersonalTags(Order order, java.lang.String userId, java.lang.String filter, int count, boolean includePrivate) Deprecated. |
java.util.List<Tag> |
findTopFilteredSystemTags(Order order, java.lang.String userId, java.lang.String filter, int count) Deprecated. |
java.util.Map<java.lang.String,java.lang.Integer> |
findUpdatedRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) Finds a list of tags in the system that are related to the specified tag word. |
java.util.Map<java.lang.String,java.lang.Integer> |
findUpdatedRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) Finds a list of tags in the system that are related to the specified tag word. |
java.util.Map<java.lang.String,java.lang.Integer> |
findUpdatedRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) Finds a list of users that are related to the specified tag word. |
java.util.Map<java.lang.String,java.lang.Integer> |
findUpdatedRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) Finds a list of users that are related to the specified tag word. |
java.util.List<Resource> |
findUpdatedResources(java.lang.String serviceId, java.util.Calendar date) Return resources whose serviceId matches the specified serviceId and which have been updated after the the specified date. |
java.lang.String |
getTopTags(java.lang.String serviceId, java.lang.String resourceId, int limit) Return the tags on the specified resource |
Bookmark |
lookupBookmark(java.lang.String serviceId, java.lang.String resourceId, java.lang.String userId) Looks up a bookmark given a service ID and the resource ID for the currently authenticated user. |
boolean |
renamePersonalTag(java.lang.String userId, java.lang.String oldTagWord, java.lang.String newTagWord) Rename the specified tag on all the bookmarks owned by the specified userId to a new name |
void |
saveBookmark(Bookmark bookmark) Saves a bookmark with a list of tags applied to it. |
Method Detail |
---|
java.util.List<Resource> findFilteredPersonalResources(Order order, java.lang.String userId, java.lang.String nameFilter) throws TaggingException
order
- the order of how the results are going to be sorted byuserId
- the current userIdnameFilter
- a substring filter used to search the resource's nameTaggingException
java.util.List<Resource> findFilteredPersonalResources(Order order, java.lang.String userId, java.lang.String nameFilter, java.lang.String serviceId) throws TaggingException
order
- the order of how the results are going to be sorted byuserId
- the current userIdnameFilter
- a substring filter used to search the resource's nameserviceId
- a service ID filter which is used to prune the resultsTaggingException
java.util.List<Resource> findSystemResources(Order order, java.lang.String userId, java.util.List<java.lang.String> userFilters, java.lang.String tagFilters) throws TaggingException
order
- the order of how the results to be returneduserId
- the current authenticated userIduserFilters
- the list of refining userIdtagFilters
- a list of tag words to use during filteringTaggingException
java.util.List<Resource> findPersonalResources(Order order, java.lang.String userId, java.util.List<java.lang.String> userFilters, java.lang.String tagFilters, boolean includePrivate) throws TaggingException
order
- the order of how the results to be returneduserId
- the current userIduserFilters
- the list of refining userIdtagFilters
- a list of tag words to use during filteringincludePrivate
- whether to show private resources alsoTaggingException
java.util.List<Resource> findRelatedSystemResources(java.lang.String serviceId, java.lang.String resourceId) throws TaggingException
serviceId
- the unique ID of the service whose resource is being taggedresourceId
- the unique ID of the resourceTaggingException
java.util.List<Resource> findUpdatedResources(java.lang.String serviceId, java.util.Calendar date) throws TaggingException
serviceId
- the serviceId of the resources to finddate
- the date after which we want to find resources which has been updatedTaggingException
java.util.List<Tag> findPopularTags(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, java.lang.String resourceScope, int size, Order order) throws TaggingException
userFilter
- a user whose tags we are searching from. Null or empty string means no user. the userFilter could be the same as the userId.tagFilter
- a string which we want to limit the results with. Depending on the substringMatch parameter, we will treat this tagFilter as a substring filter or an exact-match filter. Null or empty string means no tag filter.substringMatch
- whether we want to treat the tagFilter parameter as a substring filter or whole-word filter. When tagFilter is null or empty string, this parameter is ignored.resourceScope
- if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.size
- the size of returned results. If the size is less than or equal to 0, this means that all results will be returned. If this size is greater than the size of available results, then we will return only the available resultsorder
- the ordring of the return results. Null is invalid value.TaggingException
java.util.List<Tag> findPopularTags(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, int size, Order order) throws TaggingException
userFilter
- a user whose tags we are searching from. Null or empty string means no user. the userFilter could be the same as the userId.tagFilter
- a string which we want to limit the results with. Depending on the substringMatch parameter, we will treat this tagFilter as a substring filter or an exact-match filter. Null or empty string means no tag filter.substringMatch
- whether we want to treat the tagFilter parameter as a substring filter or whole-word filter. When tagFilter is null or empty string, this parameter is ignored.size
- the size of returned results. If the size is less than or equal to 0, this means that all results will be returned. If this size is greater than the size of available results, then we will return only the available resultsorder
- the ordring of the return results. Null is invalid value.TaggingException
java.util.List<Tag> findPopularTagsCommon(java.lang.String userFilter, java.lang.String tagFilter, boolean substringMatch, java.lang.String serviceId, int size, Order order) throws TaggingException
userFilter
- a user whose tags we are searching from. Null or empty string means no user. the userFilter could be the same as the userId.tagFilter
- a string which we want to limit the results with. Depending on the substringMatch parameter, we will treat this tagFilter as a substring filter or an exact-match filter. Null or empty string means no tag filter.substringMatch
- whether we want to treat the tagFilter parameter as a substring filter or whole-word filter. When tagFilter is null or empty string, this parameter is ignored.serviceId
- service ID which is used to filter the resultssize
- the size of returned results. If the size is less than or equal to 0, this means that all results will be returned. If this size is greater than the size of available results, then we will return only the available resultsorder
- the ordring of the return results. Null is invalid value.TaggingException
java.util.List<Tag> findPopularTags(java.lang.String serviceId, java.lang.String resourceId, int size) throws TaggingException
serviceId
- the resource's service idresourceId
- the resource's idsize
- the number of popular tags we want to showTaggingException
@Deprecated
java.util.List<Tag> findFilteredPersonalTags(Order order,
java.lang.String userId,
java.lang.String filter)
throws TaggingException
order
- the order of how the results are going to be sorted byuserId
- the current userIdfilter
- a substring filter used to search the tag's nameTaggingException
@Deprecated
java.util.List<Tag> findTopFilteredSystemTags(Order order,
java.lang.String userId,
java.lang.String filter,
int count)
throws TaggingException
order
- the order of how the results are going to be sorted byfilter
- a substring filter used to search the tag's namecount
- the number of Tag objects that are returned in the listTaggingException
@Deprecated
java.util.List<Tag> findTopFilteredPersonalTags(Order order,
java.lang.String userId,
java.lang.String filter,
int count,
boolean includePrivate)
throws TaggingException
order
- the order of how the results are going to be sorted byuserId
- the currently authenticated userfilter
- a substring filter used to search the tag's namecount
- the number of Tag objects that are returned in the listincludePrivate
- whether or not private tags should be returnedTaggingException
@Deprecated
java.util.List<Tag> findAllTopFilteredSystemTags(Order order,
java.lang.String userId,
java.lang.String filter)
throws TaggingException
order
- the order of how the results are returneduserId
- the currently authenticated userfilter
- a substring filter used to search the tag's nameTaggingException
@Deprecated
java.util.List<Tag> findAllTopFilteredPersonalTags(Order order,
java.lang.String userId,
java.lang.String filter,
boolean includePrivate)
throws TaggingException
order
- the order of how the results are returneduserId
- the user whom we want to find the tags fromfilter
- a substring filter used to search the tag's nameincludePrivate
- whether to also return the user's private tagsTaggingException
@Deprecated
java.util.List<Tag> findSystemTags(java.lang.String userId,
java.lang.String keywords,
boolean useWildcard)
throws TaggingException
keywords
- keywords used to search usingTaggingException
java.util.List<Tag> findRelatedTags(java.lang.String serviceId, java.lang.String resourceId) throws TaggingException
serviceId
- the unique ID of the service whose resource is being taggedresourceId
- the unique ID of the resourceTaggingException
java.util.List<Tag> findRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find other tags related to itresourceScope
- if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.TaggingException
java.util.Map<java.lang.String,java.lang.Integer> findUpdatedRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find other tags related to itresourceScope
- if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.TaggingException
java.util.Map<java.lang.String,java.lang.Integer> findUpdatedRelatedSystemTagsByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find other tags related to itTaggingException
java.util.List<Tag> findRecommendedTags(java.lang.String serviceId, java.lang.String resourceId, java.lang.String userId, int count) throws TaggingException
serviceId
- the unique ID of the service whose resource is being taggedresourceId
- the unique ID of the resource being taggeduserId
- the currently logged in usercount
- the number of recommended tags to be foundTaggingException
java.util.List<User> findRelatedUsers(java.lang.String serviceId, java.lang.String resourceId) throws TaggingException
serviceId
- the unique ID of the service whose resource is being taggedresourceId
- the unique ID of the resourceTaggingException
java.util.List<User> findRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find users related to itresourceScope
- if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.TaggingException
java.util.List<User> findRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find users related to itTaggingException
java.util.Map<java.lang.String,java.lang.Integer> findUpdatedRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters, java.lang.String resourceScope) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find users related to itresourceScope
- if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.TaggingException
java.util.Map<java.lang.String,java.lang.Integer> findUpdatedRelatedUsersByTag(Order order, java.lang.String userId, java.lang.String tagWords, java.util.List<java.lang.String> userFilters) throws TaggingException
order
- the order of how the results are going to be sorted bytagWords
- a space-delimited tag words used to find users related to itTaggingException
Bookmark lookupBookmark(java.lang.String serviceId, java.lang.String resourceId, java.lang.String userId) throws TaggingException
serviceId
- the unique ID of the service whose resource is being taggedresourceId
- the unique ID of the resource being taggeduserId
- the currently logged in userTaggingException
Bookmark createBookmark(java.lang.String serviceId, java.lang.String resourceId, java.lang.String resourceScope, java.lang.String resourceName, java.lang.String userId) throws TaggingException
serviceId
- the unique ID of the service whose resource is being bookmarkedresourceId
- the unique ID of the resource being bookmarkedresourceScope
- the scope containing the resourceresourceName
- the name or description of the bookmark being createduserId
- the creator of this bookmarkTaggingException
void saveBookmark(Bookmark bookmark) throws TaggingException
bookmark
- the Bookmark to be saved, i.e. created or editedTaggingException
void deleteBookmark(Bookmark bookmark) throws TaggingException
bookmark
- the Bookmark to be deletedTaggingException
boolean deletePersonalTag(java.lang.String userId, java.lang.String tagWord) throws TaggingException
userId
- the owner of the bookmarktagWord
- the tag to be deletedTaggingException
boolean renamePersonalTag(java.lang.String userId, java.lang.String oldTagWord, java.lang.String newTagWord) throws TaggingException
userId
- the owner of the bookmarkoldTagWord
- old tag name to be renamednewTagWord
- new tag nameTaggingException
void deleteResource(java.lang.String serviceId, java.lang.String resourceId) throws TaggingException
serviceId
- the serviceId of the resource to be deletedresourceId
- the resourceId of the resource to be deletedTaggingException
java.lang.String getTopTags(java.lang.String serviceId, java.lang.String resourceId, int limit) throws TaggingException
serviceId
- the service id of the resource which we want to find the tags fromresourceId
- the resource id of the resource which we want to find the tags fromlimit
- the maximum number of unique tags; it is ignored if it is less than or equal to 0TaggingException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |