com.ibm.portal.cp.rating
Interface RatingSpaceLocator<R extends RatingSpace>

All Known Subinterfaces:

RatingModelLocator<R,S>

public interface RatingSpaceLocator<R extends RatingSpace>

The interface to find RatingSpaces using different criteria

Since:

7.0.0

Method Summary

CountableIterablePagedListModel<RatingSpace>	findRatingSpaces(Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects for all resources
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByCategories(java.util.Collection<java.lang.String> categoryNames, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given categories.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByCategoriesAndOwner(java.util.Collection<java.lang.String> categoryNames, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given categories and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByCategory(java.lang.String categoryName, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given category
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByCategoryAndOwner(java.lang.String categoryName, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given category and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByOwner(ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects for ratings applied by the given owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceID(ObjectID resourceID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource ObjectID.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceIDAndOwner(ObjectID resourceID, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource ObjectID and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceIDs(java.util.Collection<ObjectID> resourceIDs, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource ObjectIDs.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource ObjectIDs and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceURI(java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource URI.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceURIAndOwner(java.net.URI resourceURI, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource URI and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceURIs(java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource URIs.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource URIs and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByTypeSchema(java.lang.String typeSchema, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource (type) schema.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByTypeSchemaAndOwner(java.lang.String typeSchema, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a given Resource (type) schema and owner.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource (type) schemas.
CountableIterablePagedListModel<RatingSpace>	findRatingSpacesByTypeSchemasAndOwner(java.util.Collection<java.lang.String> typeSchemas, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order) Returns a list of RatingSpace objects by a list of given Resource (type) schemas and owner.

Method Detail

findRatingSpaces

CountableIterablePagedListModel<RatingSpace> findRatingSpaces(Constants.OrderMetric orderMetric,
                                                              Constants.Order order)
                                                              throws ModelException

Returns a list of RatingSpace 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. The ordering will be performed by the rating value.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByOwner(ObjectID ownerID,
                                                                     Constants.OrderMetric orderMetric,
                                                                     Constants.Order order)
                                                                     throws ModelException

Returns a list of RatingSpace objects for ratings 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByTypeSchema

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByTypeSchema(java.lang.String typeSchema,
                                                                          Constants.OrderMetric orderMetric,
                                                                          Constants.Order order)
                                                                          throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByTypeSchemaAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByTypeSchemaAndOwner(java.lang.String typeSchema,
                                                                                  ObjectID ownerID,
                                                                                  Constants.OrderMetric orderMetric,
                                                                                  Constants.Order order)
                                                                                  throws ModelException

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

Parameters:

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

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByTypeSchemas

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas,
                                                                           Constants.OrderMetric orderMetric,
                                                                           Constants.Order order)
                                                                           throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByTypeSchemasAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByTypeSchemasAndOwner(java.util.Collection<java.lang.String> typeSchemas,
                                                                                   ObjectID ownerID,
                                                                                   Constants.OrderMetric orderMetric,
                                                                                   Constants.Order order)
                                                                                   throws ModelException

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

Parameters:

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

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByCategory

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByCategory(java.lang.String categoryName,
                                                                        Constants.OrderMetric orderMetric,
                                                                        Constants.Order order)
                                                                        throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByCategoryAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByCategoryAndOwner(java.lang.String categoryName,
                                                                                ObjectID ownerID,
                                                                                Constants.OrderMetric orderMetric,
                                                                                Constants.Order order)
                                                                                throws ModelException

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

Parameters:

categoryName - The name of the category to search for.

ownerID - The ObjectID identifying the owner.

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

order -

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByCategories

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByCategories(java.util.Collection<java.lang.String> categoryNames,
                                                                          Constants.OrderMetric orderMetric,
                                                                          Constants.Order order)
                                                                          throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects

Throws:

ModelException

findRatingSpacesByCategoriesAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByCategoriesAndOwner(java.util.Collection<java.lang.String> categoryNames,
                                                                                  ObjectID ownerID,
                                                                                  Constants.OrderMetric orderMetric,
                                                                                  Constants.Order order)
                                                                                  throws ModelException

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

Parameters:

categoryNames - The Objectnames of categories to search for.

ownerID - The ObjectID identifying the owner.

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

order -

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceIDs

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceIDs(java.util.Collection<ObjectID> resourceIDs,
                                                                           Constants.OrderMetric orderMetric,
                                                                           Constants.Order order)
                                                                           throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceID

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceID(ObjectID resourceID,
                                                                          Constants.OrderMetric orderMetric,
                                                                          Constants.Order order)
                                                                          throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceIDsAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs,
                                                                                   ObjectID ownerID,
                                                                                   Constants.OrderMetric orderMetric,
                                                                                   Constants.Order order)
                                                                                   throws ModelException

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

Parameters:

resourceIDs - The ObjectIDs of the resources to search for.

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceIDAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceIDAndOwner(ObjectID resourceID,
                                                                                  ObjectID ownerID,
                                                                                  Constants.OrderMetric orderMetric,
                                                                                  Constants.Order order)
                                                                                  throws ModelException

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

Parameters:

resourceID - The ObjectID of the resource to search for.

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceURIs

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceURIs(java.util.Collection<java.net.URI> resourceURIs,
                                                                            Constants.OrderMetric orderMetric,
                                                                            Constants.Order order)
                                                                            throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceURI

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceURI(java.net.URI resourceURI,
                                                                           Constants.OrderMetric orderMetric,
                                                                           Constants.Order order)
                                                                           throws ModelException

Returns a list of RatingSpace 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceURIsAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs,
                                                                                    ObjectID ownerID,
                                                                                    Constants.OrderMetric orderMetric,
                                                                                    Constants.Order order)
                                                                                    throws ModelException

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

Parameters:

resourceURIs - The URIs of the resources to search for.

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException

findRatingSpacesByResourceURIAndOwner

CountableIterablePagedListModel<RatingSpace> findRatingSpacesByResourceURIAndOwner(java.net.URI resourceURI,
                                                                                   ObjectID ownerID,
                                                                                   Constants.OrderMetric orderMetric,
                                                                                   Constants.Order order)
                                                                                   throws ModelException

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

Parameters:

resourceURI - The URI of the resource to search for.

ownerID - The ObjectID identifying 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.

Returns:

A list of RatingSpace objects.

Throws:

ModelException