com.ibm.portal.cp.tagging
Interface TagLocator<T extends Tag>

All Superinterfaces:

Constants, Locator<T>, ResourceLocator<T>

All Known Subinterfaces:

TagModelLocator<T,S>

public interface TagLocator<T extends Tag>
extends ResourceLocator<T>, Constants

The interface to find Tags using different criteria

Since:

7.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.cp.Constants

Constants.Order, Constants.OrderMetric, Constants.SearchPattern

Field Summary

Fields inherited from interface com.ibm.portal.cp.Constants

ALL, BEGIN, COLON, DEFAULT_ORDER, DEFAULT_ORDERMETRIC

Method Summary

CountableIterablePagedListModel<T>	findByOwner(ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given owner.
CountableIterablePagedListModel<T>	findByResourceID(ObjectID resourceID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given Resource ObjectID.
CountableIterablePagedListModel<T>	findByResourceIDAndOwner(ObjectID resourceID, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given Resource ObjectID and owner.
CountableIterablePagedListModel<T>	findByResourceIDs(java.util.Collection<ObjectID> resourceIDs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a list of given Resource ObjectIDs.
CountableIterablePagedListModel<T>	findByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a list of given Resource ObjectIDs and owner.
CountableIterablePagedListModel<T>	findByResourceURI(java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given Resource URI.
CountableIterablePagedListModel<T>	findByResourceURIAndOwner(java.net.URI resourceURI, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given Resource URI and owner.
CountableIterablePagedListModel<T>	findByResourceURIs(java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a list of given Resource URIs.
CountableIterablePagedListModel<T>	findByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a list of given Resource URIs and owner.
CountableIterablePagedListModel<T>	findByTagName(Constants.SearchPattern searchPattern, java.lang.String tagName, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name.
CountableIterablePagedListModel<T>	findByTagNameAndOwner(Constants.SearchPattern searchPattern, java.lang.String tagName, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name and owner.
CountableIterablePagedListModel<T>	findByTagNameAndResourceID(Constants.SearchPattern searchPattern, java.lang.String tagName, ObjectID resourceID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name and Resource ObjectID.
CountableIterablePagedListModel<T>	findByTagNameAndResourceIDAndOwner(Constants.SearchPattern searchPattern, java.lang.String tagName, ObjectID resourceID, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name, owner and Resource ObjectID.
CountableIterablePagedListModel<T>	findByTagNameAndResourceIDs(Constants.SearchPattern searchPattern, java.lang.String tagName, java.util.Collection<ObjectID> resourceIDs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name and Resource ObjectIDs.
CountableIterablePagedListModel<T>	findByTagNameAndResourceURI(Constants.SearchPattern searchPattern, java.lang.String tagName, java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name and Resource URI.
CountableIterablePagedListModel<T>	findByTagNameAndResourceURIAndOwner(Constants.SearchPattern searchPattern, java.lang.String tagName, java.net.URI resourceURI, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name, owner and Resource URI.
CountableIterablePagedListModel<T>	findByTagNameAndResourceURIs(Constants.SearchPattern searchPattern, java.lang.String tagName, java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects by a given (tag) name and Resource URIs.
CountableIterablePagedListModel<T>	findTags(java.util.Collection<java.util.Locale> locales) Returns a list of Tag objects.

Methods inherited from interface com.ibm.portal.cp.ResourceLocator

findByResourceID, findByResourceIDs

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

findTags

CountableIterablePagedListModel<T> findTags(java.util.Collection<java.util.Locale> locales)
                                                        throws ModelException

Returns a list of Tag objects. Similar to calling #iterator but is locale sensitive.

Parameters:

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

See Also:

#iterator

findByOwner

CountableIterablePagedListModel<T> findByOwner(ObjectID ownerID,
                                               Constants.OrderMetric orderMetric,
                                               Constants.Order order,
                                               java.util.Collection<java.util.Locale> locales)
                                                           throws ModelException

Returns a list of Tag objects by a given owner.

Parameters:

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagName

CountableIterablePagedListModel<T> findByTagName(Constants.SearchPattern searchPattern,
                                                 java.lang.String tagName,
                                                 Constants.OrderMetric orderMetric,
                                                 Constants.Order order,
                                                 java.util.Collection<java.util.Locale> locales)
                                                             throws ModelException

Returns a list of Tag objects by a given (tag) name.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndOwner

CountableIterablePagedListModel<T> findByTagNameAndOwner(Constants.SearchPattern searchPattern,
                                                         java.lang.String tagName,
                                                         ObjectID ownerID,
                                                         Constants.OrderMetric orderMetric,
                                                         Constants.Order order,
                                                         java.util.Collection<java.util.Locale> locales)
                                                                     throws ModelException

Returns a list of Tag objects by a given (tag) name and owner.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceIDAndOwner

CountableIterablePagedListModel<T> findByTagNameAndResourceIDAndOwner(Constants.SearchPattern searchPattern,
                                                                      java.lang.String tagName,
                                                                      ObjectID resourceID,
                                                                      ObjectID ownerID,
                                                                      Constants.OrderMetric orderMetric,
                                                                      Constants.Order order,
                                                                      java.util.Collection<java.util.Locale> locales)
                                                                                  throws ModelException

Returns a list of Tag objects by a given (tag) name, owner and Resource ObjectID.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceID - The Resource ObjectID to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceURIAndOwner

CountableIterablePagedListModel<T> findByTagNameAndResourceURIAndOwner(Constants.SearchPattern searchPattern,
                                                                       java.lang.String tagName,
                                                                       java.net.URI resourceURI,
                                                                       ObjectID ownerID,
                                                                       Constants.OrderMetric orderMetric,
                                                                       Constants.Order order,
                                                                       java.util.Collection<java.util.Locale> locales)
                                                                                   throws ModelException

Returns a list of Tag objects by a given (tag) name, owner and Resource URI.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceURI - The Resource URI to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceIDs

CountableIterablePagedListModel<T> findByTagNameAndResourceIDs(Constants.SearchPattern searchPattern,
                                                               java.lang.String tagName,
                                                               java.util.Collection<ObjectID> resourceIDs,
                                                               Constants.OrderMetric orderMetric,
                                                               Constants.Order order,
                                                               java.util.Collection<java.util.Locale> locales)
                                                                           throws ModelException

Returns a list of Tag objects by a given (tag) name and Resource ObjectIDs.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceIDs - The Resource ObjectIDs to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceURIs

CountableIterablePagedListModel<T> findByTagNameAndResourceURIs(Constants.SearchPattern searchPattern,
                                                                java.lang.String tagName,
                                                                java.util.Collection<java.net.URI> resourceURIs,
                                                                Constants.OrderMetric orderMetric,
                                                                Constants.Order order,
                                                                java.util.Collection<java.util.Locale> locales)
                                                                            throws ModelException

Returns a list of Tag objects by a given (tag) name and Resource URIs.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceURIs - The Resource URIs to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceID

CountableIterablePagedListModel<T> findByTagNameAndResourceID(Constants.SearchPattern searchPattern,
                                                              java.lang.String tagName,
                                                              ObjectID resourceID,
                                                              Constants.OrderMetric orderMetric,
                                                              Constants.Order order,
                                                              java.util.Collection<java.util.Locale> locales)
                                                                          throws ModelException

Returns a list of Tag objects by a given (tag) name and Resource ObjectID.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceID - The Resource ObjectID to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByTagNameAndResourceURI

CountableIterablePagedListModel<T> findByTagNameAndResourceURI(Constants.SearchPattern searchPattern,
                                                               java.lang.String tagName,
                                                               java.net.URI resourceURI,
                                                               Constants.OrderMetric orderMetric,
                                                               Constants.Order order,
                                                               java.util.Collection<java.util.Locale> locales)
                                                                           throws ModelException

Returns a list of Tag objects by a given (tag) name and Resource URI.

Parameters:

searchPattern - The search pattern for the tag to be searched for.

tagName - The (tag) name to search for.

resourceURI - The Resource URI to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceIDs

CountableIterablePagedListModel<T> findByResourceIDs(java.util.Collection<ObjectID> resourceIDs,
                                                     Constants.OrderMetric orderMetric,
                                                     Constants.Order order,
                                                     java.util.Collection<java.util.Locale> locales)
                                                                 throws ModelException

Returns a list of Tag objects by a list of given Resource ObjectIDs.

Parameters:

resourceIDs - The Collection of Resources ObjectID s to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceID

CountableIterablePagedListModel<T> findByResourceID(ObjectID resourceID,
                                                    Constants.OrderMetric orderMetric,
                                                    Constants.Order order,
                                                    java.util.Collection<java.util.Locale> locales)
                                                                throws ModelException

Returns a list of Tag objects by a given Resource ObjectID.

Parameters:

resourceID - The Resource ObjectID to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceURIs

CountableIterablePagedListModel<T> findByResourceURIs(java.util.Collection<java.net.URI> resourceURIs,
                                                      Constants.OrderMetric orderMetric,
                                                      Constants.Order order,
                                                      java.util.Collection<java.util.Locale> locales)
                                                                  throws ModelException

Returns a list of Tag objects by a list of given Resource URIs.

Parameters:

resourceURIs - The Collection of Resources' URIs to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceURI

CountableIterablePagedListModel<T> findByResourceURI(java.net.URI resourceURI,
                                                     Constants.OrderMetric orderMetric,
                                                     Constants.Order order,
                                                     java.util.Collection<java.util.Locale> locales)
                                                                 throws ModelException

Returns a list of Tag objects by a given Resource URI.

Parameters:

resourceURI - The Resource URI to search for.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceIDsAndOwner

CountableIterablePagedListModel<T> findByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs,
                                                             ObjectID ownerID,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order,
                                                             java.util.Collection<java.util.Locale> locales)
                                                                         throws ModelException

Returns a list of Tag objects by a list of given Resource ObjectIDs and owner.

Parameters:

resourceIDs - The Collection of Resources' ObjectIDs to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceIDAndOwner

CountableIterablePagedListModel<T> findByResourceIDAndOwner(ObjectID resourceID,
                                                            ObjectID ownerID,
                                                            Constants.OrderMetric orderMetric,
                                                            Constants.Order order,
                                                            java.util.Collection<java.util.Locale> locales)
                                                                        throws ModelException

Returns a list of Tag objects by a given Resource ObjectID and owner.

Parameters:

resourceID - The Resource ObjectID to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceURIsAndOwner

CountableIterablePagedListModel<T> findByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs,
                                                              ObjectID ownerID,
                                                              Constants.OrderMetric orderMetric,
                                                              Constants.Order order,
                                                              java.util.Collection<java.util.Locale> locales)
                                                                          throws ModelException

Returns a list of Tag objects by a list of given Resource URIs and owner.

Parameters:

resourceURIs - The Collection of Resources' URIs to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException

findByResourceURIAndOwner

CountableIterablePagedListModel<T> findByResourceURIAndOwner(java.net.URI resourceURI,
                                                             ObjectID ownerID,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order,
                                                             java.util.Collection<java.util.Locale> locales)
                                                                         throws ModelException

Returns a list of Tag objects by a given Resource URI and owner.

Parameters:

resourceURI - The Resource URI to search for.

ownerID - The ObjectID identifiying the owner.

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.Order) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tags to find should be searched. May be null - in this case the returned Tags are of any locale.

Returns:

A list of Tag objects.

Throws:

ModelException