Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-04


oracle.webcenter.tagging.model
Interface TaggingService


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.

Since:
11.1.1.0.0

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.
 Resource lookupResource(java.lang.String serviceId, java.lang.String resourceId)
          Looks up a resource given a service ID and the resource ID.
 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.
 void updateResourceName(Resource resource, java.lang.String resourceName)
          Updates a Resource Name
 void upgradeResources()
           

 

Method Detail

findFilteredPersonalResources

java.util.List<Resource> findFilteredPersonalResources(Order order,
                                                       java.lang.String userId,
                                                       java.lang.String nameFilter)
                                                       throws TaggingException
Finds a list of resources whose name contains the specified substring filter and have been tagged by the current userId. The results are sorted based on the specified Order; the number of Resources in the result list is specified by the passed in count.

no scalar value associated for Resources returned from this method

Parameters:
order - the order of how the results are going to be sorted by
userId - the current userId
nameFilter - a substring filter used to search the resource's name
Returns:
a list of Resource objects; these Resource objects should not be modified.
Throws:
TaggingException

findFilteredPersonalResources

java.util.List<Resource> findFilteredPersonalResources(Order order,
                                                       java.lang.String userId,
                                                       java.lang.String nameFilter,
                                                       java.lang.String serviceId)
                                                       throws TaggingException
Finds a list of resources whose name contains the specified substring filter and have been tagged by the current userId. The results are sorted based on the specified Order; the number of Resources in the result list is specified by the passed in count.

no scalar value associated for Resources returned from this method

Parameters:
order - the order of how the results are going to be sorted by
userId - the current userId
nameFilter - a substring filter used to search the resource's name
serviceId - a service ID filter which is used to prune the results
Returns:
a list of Resource objects; these Resource objects should not be modified.
Throws:
TaggingException

findSystemResources

java.util.List<Resource> findSystemResources(Order order,
                                             java.lang.String userId,
                                             java.util.List<java.lang.String> userFilters,
                                             java.lang.String tagFilters)
                                             throws TaggingException
Finds a list of Resources in the system that have been tagged with the specified keywords. Results are returned based on the relevancy.

no scalar value defined for Resources returned from this method.

Parameters:
order - the order of how the results to be returned
userId - the current authenticated userId
userFilters - the list of refining userId
tagFilters - a list of tag words to use during filtering
Returns:
a list of Resources object; these Resource object could not be modified.
Throws:
TaggingException

findPersonalResources

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
Finds a list of resources that have been tagged by the specified current user and with the specified keywords. Results are returned based on the relevancy.

no scalar value associated for the Resources returned from this method.

Parameters:
order - the order of how the results to be returned
userId - the current userId
userFilters - the list of refining userId
tagFilters - a list of tag words to use during filtering
includePrivate - whether to show private resources also
Returns:
a list of Resources object; these Resource objects should not be modified.
Throws:
TaggingException

findRelatedSystemResources

java.util.List<Resource> findRelatedSystemResources(java.lang.String serviceId,
                                                    java.lang.String resourceId)
                                                    throws TaggingException
Finds a list of resources that are related to the current resource.

scalar value is the resource's number of common tags with the specified resource

Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource
Returns:
a list of Resource objects; these Resource objects shhould not be modified.
Throws:
TaggingException

findUpdatedResources

java.util.List<Resource> findUpdatedResources(java.lang.String serviceId,
                                              java.util.Calendar date)
                                              throws TaggingException
Return resources whose serviceId matches the specified serviceId and which have been updated after the the specified date.
Parameters:
serviceId - the serviceId of the resources to find
date - the date after which we want to find resources which has been updated
Returns:
a list of resources
Throws:
TaggingException

findPopularTags

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
Finds popular tags
Parameters:
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 results
order - the ordring of the return results. Null is invalid value.
Returns:
a list of popular tags
Throws:
TaggingException

findPopularTags

java.util.List<Tag> findPopularTags(java.lang.String userFilter,
                                    java.lang.String tagFilter,
                                    boolean substringMatch,
                                    int size,
                                    Order order)
                                    throws TaggingException
Finds popular tags
Parameters:
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 results
order - the ordring of the return results. Null is invalid value.
Returns:
a list of popular tags
Throws:
TaggingException

findPopularTagsCommon

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
Finds popular tags
Parameters:
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 results
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 results
order - the ordring of the return results. Null is invalid value.
Returns:
a list of popular tags
Throws:
TaggingException

findPopularTags

java.util.List<Tag> findPopularTags(java.lang.String serviceId,
                                    java.lang.String resourceId,
                                    int size)
                                    throws TaggingException
Find popular tags on a given resource
Parameters:
serviceId - the resource's service id
resourceId - the resource's id
size - the number of popular tags we want to show
Returns:
a list of popular tags on a given resource
Throws:
TaggingException

findFilteredPersonalTags

@Deprecated
java.util.List<Tag> findFilteredPersonalTags(Order order,
                                                        java.lang.String userId,
                                                        java.lang.String filter)
                                             throws TaggingException
Deprecated. 
Finds a list of tags that contains the specified substring filter and have been tagged by the current userId. The results are sorted based on the specified Order; the number of Tags in the result list is specified by the passed in count.

scalar value is the number of resources that the user has tagged with the tag (which is the same as the popularity ranking in this case)

Parameters:
order - the order of how the results are going to be sorted by
userId - the current userId
filter - a substring filter used to search the tag's name
Returns:
a list of Tag objects; these Tag objects should not be modified.
Throws:
TaggingException

findTopFilteredSystemTags

@Deprecated
java.util.List<Tag> findTopFilteredSystemTags(Order order,
                                                         java.lang.String userId,
                                                         java.lang.String filter,
                                                         int count)
                                              throws TaggingException
Deprecated. 
Finds a list of top tags in the system. The results are sorted based on the specified Order; the number of Tags in the result list is specified by the passed in count.

there are two scalar values corresponding to the each Tag: 1. resourceCount is the number of resources that the user has tagged or others have publicly tagged with the tag (used for Tag List). 2. bookmarkCount is the the number of public bookmarks or the user's bookmarks which contain the tag (used for Tag Cloud)

Parameters:
order - the order of how the results are going to be sorted by
filter - a substring filter used to search the tag's name
count - the number of Tag objects that are returned in the list
Returns:
a list of Tag object; these Tag objects should not be modified.
Throws:
TaggingException

findTopFilteredPersonalTags

@Deprecated
java.util.List<Tag> findTopFilteredPersonalTags(Order order,
                                                           java.lang.String userId,
                                                           java.lang.String filter,
                                                           int count,
                                                           boolean includePrivate)
                                                throws TaggingException
Deprecated. 
Finds top personal tags. The results are sorted based on the specified Order; the number of Tags in the result list is specified by the passed in count.

there are 2 scalar values related for each Tag returned, and each scalar value still depend on the boolean includePrivate.

when includePrivate is true, resourceCount is the number of resources that the user have tagged with the tag, and bookmarkCount is the number of public bookmarks or the user's bookmarks which contain the tag

when includePrivate is false, resourceCount is the number of resources that the other user has publicly tagged with the tag, and bookmarkCount is the number of resources that the user has publicly tagged with the tag.

Parameters:
order - the order of how the results are going to be sorted by
userId - the currently authenticated user
filter - a substring filter used to search the tag's name
count - the number of Tag objects that are returned in the list
includePrivate - whether or not private tags should be returned
Returns:
a list of Tag object; these Tag objects should not be modified.
Throws:
TaggingException

findAllTopFilteredSystemTags

@Deprecated
java.util.List<Tag> findAllTopFilteredSystemTags(Order order,
                                                            java.lang.String userId,
                                                            java.lang.String filter)
                                                 throws TaggingException
Deprecated. 
Returns all system tags

Scalar value has the same meaning as that in findTopFilteredSystemTags

Parameters:
order - the order of how the results are returned
userId - the currently authenticated user
filter - a substring filter used to search the tag's name
Returns:
a list of all system tags; these Tag objects should not be modified.
Throws:
TaggingException

findAllTopFilteredPersonalTags

@Deprecated
java.util.List<Tag> findAllTopFilteredPersonalTags(Order order,
                                                              java.lang.String userId,
                                                              java.lang.String filter,
                                                              boolean includePrivate)
                                                   throws TaggingException
Deprecated. 
Returns all personal tags

Scalar value has the same meaning as that in findTopFilteredPersonalTags

Parameters:
order - the order of how the results are returned
userId - the user whom we want to find the tags from
filter - a substring filter used to search the tag's name
includePrivate - whether to also return the user's private tags
Returns:
a list of personal tags; these Tag objects should not be modified.
Throws:
TaggingException

findSystemTags

@Deprecated
java.util.List<Tag> findSystemTags(java.lang.String userId,
                                              java.lang.String keywords,
                                              boolean useWildcard)
                                   throws TaggingException
Deprecated. 
Finds a list of Tags in the system that have been tagged with the specified keywords. Results are returned based on the relevancy.

No scalar value associated with the Tags returned from this method.

Parameters:
keywords - keywords used to search using
Returns:
a list of Resources object; these Resource objects should not be modified.
Throws:
TaggingException

findRelatedTags

java.util.List<Tag> findRelatedTags(java.lang.String serviceId,
                                    java.lang.String resourceId)
                                    throws TaggingException
Finds a list of tags that are related to the current resource.

scalar value is the tag's number of bookmarks

Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource
Returns:
a list of Tag objects; these Tag objects should not be modified.
Throws:
TaggingException

findRelatedSystemTagsByTag

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
Finds a list of tags in the system that are related to the specified tag word. Results are sorted based on the specified Order; the number of Tags in the results is specified by the passed in count.

scalar value is the number of resources that the user has tagged or others have publicly tagged with the selected tags and the related tag.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find other tags related to it
resourceScope - if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.
Returns:
a list of Tag objects; these Tag objects should not be modified
Throws:
TaggingException

findUpdatedRelatedSystemTagsByTag

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
Finds a list of tags in the system that are related to the specified tag word. Results are sorted based on the specified Order; the number of Tags in the results is specified by the passed in count. The difference between this method and the findRelatedSystemTagsByTag is that this method is used for incremental update; we need to get the actual Tag objects first initially using the original findRelatedSystemTagsByTag, and as the refinements change, we use this method to get the updated scalar value.

scalar value is the number of resources that the user has tagged or others have publicly tagged with the selected tags and the related tag.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find other tags related to it
resourceScope - if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.
Returns:
a Map containing tag's name as a key and the tag's resource count as the value
Throws:
TaggingException

findUpdatedRelatedSystemTagsByTag

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
Finds a list of tags in the system that are related to the specified tag word. Results are sorted based on the specified Order; the number of Tags in the results is specified by the passed in count. The difference between this method and the findRelatedSystemTagsByTag is that this method is used for incremental update; we need to get the actual Tag objects first initially using the original findRelatedSystemTagsByTag, and as the refinements change, we use this method to get the updated scalar value.

scalar value is the number of resources that the user has tagged or others have publicly tagged with the selected tags and the related tag.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find other tags related to it
Returns:
a Map containing tag's name as a key and the tag's resource count as the value
Throws:
TaggingException

findRecommendedTags

java.util.List<Tag> findRecommendedTags(java.lang.String serviceId,
                                        java.lang.String resourceId,
                                        java.lang.String userId,
                                        int count)
                                        throws TaggingException
Finds a list of recommended tags related to the current resource being tagged.

No scalar value associated with the Tags returned by this method

Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource being tagged
userId - the currently logged in user
count - the number of recommended tags to be found
Returns:
a List of Tags signifying the recommended tags
Throws:
TaggingException

findRelatedUsers

java.util.List<User> findRelatedUsers(java.lang.String serviceId,
                                      java.lang.String resourceId)
                                      throws TaggingException
Finds a list of users that are related to the current resource.

no scalar value associated with the tags returned by this method

Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource
Returns:
a list of String representing user names
Throws:
TaggingException

findRelatedUsersByTag

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
Finds a list of users that are related to the specified tag word. Results are sorted based on the specified Order; the number of user name in the results is specified by the passed in count. Passing in Order by Recency will return the same results as ordering by Alpha.

The scalar value is the number resources that the user has publicly tag with the selected tags.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find users related to it
resourceScope - if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.
Returns:
a list of String representing user names
Throws:
TaggingException

findRelatedUsersByTag

java.util.List<User> findRelatedUsersByTag(Order order,
                                           java.lang.String userId,
                                           java.lang.String tagWords,
                                           java.util.List<java.lang.String> userFilters)
                                           throws TaggingException
Finds a list of users that are related to the specified tag word. Results are sorted based on the specified Order; the number of user name in the results is specified by the passed in count. Passing in Order by Recency will return the same results as ordering by Alpha.

The scalar value is the number resources that the user has publicly tag with the selected tags.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find users related to it
Returns:
a list of String representing user names
Throws:
TaggingException

findUpdatedRelatedUsersByTag

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
Finds a list of users that are related to the specified tag word. Results are sorted based on the specified Order; the number of user name in the results is specified by the passed in count. Passing in Order by Recency will return the same results as ordering by Alpha. The difference between this method and the findRelatedUsersByTag is that this method is used for incremental update; we need to get the actual User objects first initially using the original findRelatedUsersByTag, and as the refinements change, we use this method to get the updated scalar value.

The scalar value is the number resources that the user has publicly tag with the selected tags.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find users related to it
resourceScope - if specified, limits the tags those used on resources in the scope. Null or empty string means all tags.
Returns:
a Map containing the user id as a key and the user's scalar value as the value.
Throws:
TaggingException

findUpdatedRelatedUsersByTag

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
Finds a list of users that are related to the specified tag word. Results are sorted based on the specified Order; the number of user name in the results is specified by the passed in count. Passing in Order by Recency will return the same results as ordering by Alpha. The difference between this method and the findRelatedUsersByTag is that this method is used for incremental update; we need to get the actual User objects first initially using the original findRelatedUsersByTag, and as the refinements change, we use this method to get the updated scalar value.

The scalar value is the number resources that the user has publicly tag with the selected tags.

Parameters:
order - the order of how the results are going to be sorted by
tagWords - a space-delimited tag words used to find users related to it
Returns:
a Map containing the user id as a key and the user's scalar value as the value.
Throws:
TaggingException

lookupBookmark

Bookmark lookupBookmark(java.lang.String serviceId,
                        java.lang.String resourceId,
                        java.lang.String userId)
                        throws TaggingException
Looks up a bookmark given a service ID and the resource ID for the currently authenticated user. There are fields used to do the lookup that are filled in implicitly. They include the creator of the bookmark. The mentality is that each user can only create one single bookmark on the same resource once.
Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource being tagged
userId - the currently logged in user
Returns:
a Bookmark looked up and null if not found; this bookmark is ok to be modified/updated.
Throws:
TaggingException

lookupResource

Resource lookupResource(java.lang.String serviceId,
                        java.lang.String resourceId)
                        throws TaggingException
Looks up a resource given a service ID and the resource ID.
Parameters:
serviceId - the unique ID of the service whose resource is being tagged
resourceId - the unique ID of the resource being tagged
Returns:
a Resource looked up and null if not found
Throws:
TaggingException

createBookmark

Bookmark createBookmark(java.lang.String serviceId,
                        java.lang.String resourceId,
                        java.lang.String resourceScope,
                        java.lang.String resourceName,
                        java.lang.String userId)
                        throws TaggingException
Creates a new Bookmark with all its constituents. In addition to the passed in fields, the creation date is also kept within the bookmark.
Parameters:
serviceId - the unique ID of the service whose resource is being bookmarked
resourceId - the unique ID of the resource being bookmarked
resourceScope - the scope containing the resource
resourceName - the name or description of the bookmark being created
userId - the creator of this bookmark
Returns:
a new Bookmark that may be registered with the data back-end; this bookmark is ok to be modified/updated.
Throws:
TaggingException

saveBookmark

void saveBookmark(Bookmark bookmark)
                  throws TaggingException
Saves a bookmark with a list of tags applied to it.
Parameters:
bookmark - the Bookmark to be saved, i.e. created or edited
Throws:
TaggingException

deleteBookmark

void deleteBookmark(Bookmark bookmark)
                    throws TaggingException
Deletes the passed in bookmark.
Parameters:
bookmark - the Bookmark to be deleted
Throws:
TaggingException

deletePersonalTag

boolean deletePersonalTag(java.lang.String userId,
                          java.lang.String tagWord)
                          throws TaggingException
Delete the specified tags on all the bookmark owned by the specified userId
Parameters:
userId - the owner of the bookmark
tagWord - the tag to be deleted
Returns:
whether any tags actually get deleted
Throws:
TaggingException

renamePersonalTag

boolean renamePersonalTag(java.lang.String userId,
                          java.lang.String oldTagWord,
                          java.lang.String newTagWord)
                          throws TaggingException
Rename the specified tag on all the bookmarks owned by the specified userId to a new name
Parameters:
userId - the owner of the bookmark
oldTagWord - old tag name to be renamed
newTagWord - new tag name
Returns:
whether any tags actually get renamed
Throws:
TaggingException

deleteResource

void deleteResource(java.lang.String serviceId,
                    java.lang.String resourceId)
                    throws TaggingException
Delete a resource
Parameters:
serviceId - the serviceId of the resource to be deleted
resourceId - the resourceId of the resource to be deleted
Throws:
TaggingException

getTopTags

java.lang.String getTopTags(java.lang.String serviceId,
                            java.lang.String resourceId,
                            int limit)
                            throws TaggingException
Return the tags on the specified resource
Parameters:
serviceId - the service id of the resource which we want to find the tags from
resourceId - the resource id of the resource which we want to find the tags from
limit - the maximum number of unique tags; it is ignored if it is less than or equal to 0
Returns:
String a list of tags whose occurrences denotes the weight or importance of the tag
Throws:
TaggingException

upgradeResources

void upgradeResources()
                      throws TaggingException
Throws:
TaggingException

updateResourceName

void updateResourceName(Resource resource,
                        java.lang.String resourceName)
                        throws TaggingException
Updates a Resource Name
Parameters:
resource - the Resource to be edited
resourceName - the new resource Name
Throws:
TaggingException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-04


Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved.