com.ibm.portal.cp.tagging
Interface TagSpaceLocator<T extends TagSpace>

All Known Subinterfaces:

TagModelLocator<T,S>

public interface TagSpaceLocator<T extends TagSpace>

The interface to find TagSpaces using different criteria

Since:

7.0.0

Method Summary

CountableIterablePagedListModel<T>	findTagSpaces(Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects for all resources
CountableIterablePagedListModel<T>	findTagSpacesByCategories(java.util.Collection<java.lang.String> categoryNames, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given categories.
CountableIterablePagedListModel<T>	findTagSpacesByCategoriesAndOwner(java.util.Collection<java.lang.String> categoryNames, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given categories and owner.
CountableIterablePagedListModel<T>	findTagSpacesByCategory(java.lang.String categoryName, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given category.
CountableIterablePagedListModel<T>	findTagSpacesByCategoryAndOwner(java.lang.String categoryName, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given category and owner.
CountableIterablePagedListModel<T>	findTagSpacesByOwner(ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects for tags applied by the given owner
CountableIterablePagedListModel<T>	findTagSpacesByResourceID(ObjectID resourceID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given Resource ObjectID.
CountableIterablePagedListModel<T>	findTagSpacesByResourceIDAndOwner(ObjectID resourceID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales, ObjectID ownerID) Returns a list of TagSpace objects by a given Resource ObjectID and owner.
CountableIterablePagedListModel<T>	findTagSpacesByResourceIDs(java.util.Collection<ObjectID> resourceIDs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given Resource ObjectIDs.
CountableIterablePagedListModel<T>	findTagSpacesByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales, ObjectID ownerID) Returns a list of TagSpace objects by a list of given Resource ObjectIDs and owner.
CountableIterablePagedListModel<T>	findTagSpacesByResourceURI(java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given Resource URI.
CountableIterablePagedListModel<T>	findTagSpacesByResourceURIAndOwner(java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales, ObjectID ownerID) Returns a list of TagSpace objects by a given Resource URI and owner.
CountableIterablePagedListModel<T>	findTagSpacesByResourceURIs(java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given Resource URIs.
CountableIterablePagedListModel<T>	findTagSpacesByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales, ObjectID ownerID) Returns a list of TagSpace objects by a list of given Resource URIs and owner.
CountableIterablePagedListModel<T>	findTagSpacesByTypeSchema(java.lang.String typeSchema, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given Resource (type) schema.
CountableIterablePagedListModel<T>	findTagSpacesByTypeSchemaAndOwner(java.lang.String typeSchema, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a given Resource (type) schema and owner.
CountableIterablePagedListModel<T>	findTagSpacesByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given Resource (type) schemas.
CountableIterablePagedListModel<T>	findTagSpacesByTypeSchemasAndOwner(java.util.Collection<java.lang.String> typeSchemas, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of TagSpace objects by a list of given Resource (type) schemas and owner.

Method Detail

findTagSpacesByOwner

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

Returns a list of TagSpace objects for tags applied by the 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceIDs

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

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

Parameters:

resourceIDs - The ObjectIDs of the resources 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceID

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

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

Parameters:

resourceID - The ObjectID of the resource 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceURIs

CountableIterablePagedListModel<T> findTagSpacesByResourceURIs(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 TagSpace objects by a list of given Resource URIs.

Parameters:

resourceURIs - The URIs of the resources 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceURI

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

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

Parameters:

resourceURI - The URI of the resource 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceIDsAndOwner

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

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

Parameters:

resourceIDs - The ObjectIDs of the resources 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

ownerID - The ObjectID identifiying the owner.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceIDAndOwner

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

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

Parameters:

resourceID - The ObjectID of the resource 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

ownerID - The ObjectID identifiying the owner.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceURIsAndOwner

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

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

Parameters:

resourceURIs - The URIs of the resources 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

ownerID - The ObjectID identifiying the owner.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByResourceURIAndOwner

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

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

Parameters:

resourceURI - The URI of the resource 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

ownerID - The ObjectID identifiying the owner.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByTypeSchemas

CountableIterablePagedListModel<T> findTagSpacesByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas,
                                                              Constants.OrderMetric orderMetric,
                                                              Constants.Order order,
                                                              java.util.Collection<java.util.Locale> locales)
                                                                               throws ModelException

Returns a list of TagSpace objects by a list of given Resource (type) schemas.

Parameters:

typeSchemas - The Resource (type) schemas 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByTypeSchemasAndOwner

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

Returns a list of TagSpace objects by a list of given Resource (type) schemas and owner.

Parameters:

typeSchemas - The Resource (type) schemas to search for.

ownerID - The owner of the tags 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByTypeSchema

CountableIterablePagedListModel<T> findTagSpacesByTypeSchema(java.lang.String typeSchema,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order,
                                                             java.util.Collection<java.util.Locale> locales)
                                                                              throws ModelException

Returns a list of TagSpace objects by a given Resource (type) schema.

Parameters:

typeSchema - The Resource (type) schema 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByTypeSchemaAndOwner

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

Returns a list of TagSpace objects by a given Resource (type) schema and owner.

Parameters:

typeSchema - The Resource (type) schema to search for.

ownerID - The owner of the tags 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpaces

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

Returns a list of TagSpace objects for all resources

Parameters:

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 in which case the returned TagSpaces are in an arbitrary order.

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

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByCategory

CountableIterablePagedListModel<T> findTagSpacesByCategory(java.lang.String categoryName,
                                                           Constants.OrderMetric orderMetric,
                                                           Constants.Order order,
                                                           java.util.Collection<java.util.Locale> locales)
                                                                            throws ModelException

Returns a list of TagSpace objects by a given category.

Parameters:

categoryName - The name of the category 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByCategoryAndOwner

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

Returns a list of TagSpace objects by a given category and owner.

Parameters:

categoryName - The name of the category to search for.

ownerID - The owner of the tags 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByCategories

CountableIterablePagedListModel<T> findTagSpacesByCategories(java.util.Collection<java.lang.String> categoryNames,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order,
                                                             java.util.Collection<java.util.Locale> locales)
                                                                              throws ModelException

Returns a list of TagSpace objects by a list of given categories.

Parameters:

categoryNames - The names of categories 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException

findTagSpacesByCategoriesAndOwner

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

Returns a list of TagSpace objects by a list of given categories and owner.

Parameters:

categoryNames - The names of categories to search for.

ownerID - The owner of the tags 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 TagSpaces to find should be searched. May be null - in this case the returned TagSpaces are locale independent.

Returns:

A list of TagSpace objects.

Throws:

ModelException