com.ibm.portal.cp.rating
Interface RatingLocator<R extends Rating>

All Superinterfaces:
Locator<R>, ResourceLocator<R>
All Known Subinterfaces:
RatingModelLocator<R,S>

public interface RatingLocator<R extends Rating>
extends ResourceLocator<R>

The interface to find Ratings using different criteria

Since:
7.0.0

Method Summary
 CountableIterablePagedListModel<R> findByOwner(ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a given owner.
 CountableIterablePagedListModel<R> findByResourceIDAndOwner(ObjectID resource, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a given Resource ObjectID and owner.
 CountableIterablePagedListModel<R> findByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a list of given Resource ObjectIDs and owner.
 CountableIterablePagedListModel<R> findByResourceURI(java.net.URI resourceURI, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a given Resource URI.
 CountableIterablePagedListModel<R> findByResourceURIAndOwner(java.net.URI resourceURI, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a given Resource URI and owner.
 CountableIterablePagedListModel<R> findByResourceURIs(java.util.Collection<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a list of given Resource URIs.
 CountableIterablePagedListModel<R> findByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs, ObjectID ownerID, Constants.OrderMetric orderMetric, Constants.Order order)
          Returns a list of Rating objects by a list of given Resource URIs and owner.
 
Methods inherited from interface com.ibm.portal.cp.ResourceLocator
findByResourceID, findByResourceIDs
 
Methods inherited from interface com.ibm.portal.Locator
findByID, findByUniqueName
 

Method Detail

findByOwner

CountableIterablePagedListModel<R> findByOwner(ObjectID ownerID,
                                               Constants.OrderMetric orderMetric,
                                               Constants.Order order)
                                                              throws ModelException
Returns a list of Rating objects by a given owner.

Parameters:
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 Rating objects.
Throws:
ModelException

findByResourceIDsAndOwner

CountableIterablePagedListModel<R> findByResourceIDsAndOwner(java.util.Collection<ObjectID> resourceIDs,
                                                             ObjectID ownerID,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order)
                                                                            throws ModelException
Returns a list of Rating objects by a list of given Resource ObjectIDs and owner.

Parameters:
resourceIDs - The ObjectIDs of 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 Rating objects.
Throws:
ModelException

findByResourceIDAndOwner

CountableIterablePagedListModel<R> findByResourceIDAndOwner(ObjectID resource,
                                                            ObjectID ownerID,
                                                            Constants.OrderMetric orderMetric,
                                                            Constants.Order order)
                                                                           throws ModelException
Returns a list of Rating 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 Rating objects.
Throws:
ModelException

findByResourceURIs

CountableIterablePagedListModel<R> findByResourceURIs(java.util.Collection<java.net.URI> resourceURIs,
                                                      Constants.OrderMetric orderMetric,
                                                      Constants.Order order)
                                                                     throws ModelException
Returns a list of Rating objects by a list of given Resource URIs.

Parameters:
resourceURIs - The URIs of 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 Rating objects.
Throws:
ModelException

findByResourceURI

CountableIterablePagedListModel<R> findByResourceURI(java.net.URI resourceURI,
                                                     Constants.OrderMetric orderMetric,
                                                     Constants.Order order)
                                                                    throws ModelException
Returns a list of Rating objects by a given Resource URI.

Parameters:
resourceURI - The URI of a 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 Rating objects.
Throws:
ModelException

findByResourceURIsAndOwner

CountableIterablePagedListModel<R> findByResourceURIsAndOwner(java.util.Collection<java.net.URI> resourceURIs,
                                                              ObjectID ownerID,
                                                              Constants.OrderMetric orderMetric,
                                                              Constants.Order order)
                                                                             throws ModelException
Returns a list of Rating objects by a list of given Resource URIs and owner.

Parameters:
resourceURIs - The URIs of 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 Rating objects.
Throws:
ModelException

findByResourceURIAndOwner

CountableIterablePagedListModel<R> findByResourceURIAndOwner(java.net.URI resourceURI,
                                                             ObjectID ownerID,
                                                             Constants.OrderMetric orderMetric,
                                                             Constants.Order order)
                                                                            throws ModelException
Returns a list of Rating objects by a given Resource URI and owner.

Parameters:
resourceURI - The URI of a 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 Rating objects.
Throws:
ModelException