|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceModelLocator<R extends Resource>
Locator for looking up Resource
s using different criteria.
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<R> |
findByCategories(java.util.Collection<java.lang.String> categoryNames,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by given categories. |
CountableIterablePagedListModel<R> |
findByCategoriesAndRating(java.util.Collection<java.lang.String> categoryNames,
int fromRating,
int tillRating,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by given categories and
rating interval. |
CountableIterablePagedListModel<R> |
findByCategoriesAndTagNames(java.util.Collection<java.lang.String> categoryNames,
java.util.Collection<java.lang.String> tagNames,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by the given categories
and (tag) names. |
CountableIterablePagedListModel<R> |
findByCategory(java.lang.String categoryName,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by a given category. |
CountableIterablePagedListModel<R> |
findByCategoryAndRating(java.lang.String categoryName,
int fromRating,
int tillRating,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by a given category and
rating interval. |
CountableIterablePagedListModel<R> |
findByCategoryAndTagName(java.lang.String categoryName,
java.lang.String tagName,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by a given category and
tag name (exact match). |
CountableIterablePagedListModel<R> |
findByIDs(java.util.List<ObjectID> anObjectIDs)
Returns a list of Resource objects by the given
ObjectID s |
CountableIterablePagedListModel<R> |
findByRating(int fromRating,
int tillRating,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by a given rating
interval. |
CountableIterablePagedListModel<R> |
findByTagName(java.lang.String tagName,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by a given (tag) name
(exact match). |
CountableIterablePagedListModel<R> |
findByTagNames(java.util.Collection<java.lang.String> tagNames,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by given tag names. |
CountableIterablePagedListModel<R> |
findByTypeSchema(java.lang.String typeSchema,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by a given (resource)
type schema (exact match). |
CountableIterablePagedListModel<R> |
findByTypeSchemaAndRating(java.lang.String typeSchema,
int fromRating,
int tillRating,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by a given
Resource type (schema) and rating interval. |
CountableIterablePagedListModel<R> |
findByTypeSchemaAndTagName(java.lang.String typeSchema,
java.lang.String tagName,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by given
Resource type schemas and tag name (both with exact match) |
CountableIterablePagedListModel<R> |
findByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by given resource type
schemas (exact match). |
CountableIterablePagedListModel<R> |
findByTypeSchemasAndRating(java.util.Collection<java.lang.String> typeSchemas,
int fromRating,
int tillRating,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a list of Resource objects by given
Resource type schemas and rating interval. |
CountableIterablePagedListModel<R> |
findByTypeSchemasAndTagNames(java.util.Collection<java.lang.String> typeSchemas,
java.util.Collection<java.lang.String> tagNames,
Constants.OrderMetric orderMetric,
Constants.Order order,
java.util.Collection<java.util.Locale> locales)
Returns a list of Resource objects by given
Resource types (schemas) and (tags) names. |
R |
findByURI(java.net.URI resourceURI)
Returns a Resource object by a given URI . |
CountableIterablePagedListModel<R> |
findByURIs(java.util.List<java.net.URI> resourceURIs,
Constants.OrderMetric orderMetric,
Constants.Order order)
Returns a Resource object by given URI s. |
Methods inherited from interface com.ibm.portal.Locator |
---|
findByID, findByUniqueName |
Method Detail |
---|
CountableIterablePagedListModel<R> findByTypeSchema(java.lang.String typeSchema, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by a given (resource)
type schema (exact match). Typical use case: Find all pages, portlets,
products, photos, etc.
typeSchema
- The (resource) type (schema).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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTypeSchemas(java.util.Collection<java.lang.String> typeSchemas, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by given resource type
schemas (exact match). Typical use case: Find all pages, portlets,
products, photos, etc.
typeSchemas
- The resources type schemas.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
.
Resource
objects.
ModelException
R findByURI(java.net.URI resourceURI) throws ModelException
Resource
object by a given URI
.
resourceURI
- The URI
identifying the resource.
Resource
object or null
if the
resource with the given URI
was not found
ModelException
CountableIterablePagedListModel<R> findByURIs(java.util.List<java.net.URI> resourceURIs, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
object by given URI
s.
resourceURIs
- The URI
s identifying the resources.
Resource
objects, never null
but may be empty
ModelException
CountableIterablePagedListModel<R> findByTagName(java.lang.String tagName, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by a given (tag) name
(exact match).
tagName
- The name of the tag 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 must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTagNames(java.util.Collection<java.lang.String> tagNames, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by given tag names. Only
exact matches are considered.
tagName
- The name of the tag 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 must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTypeSchemaAndTagName(java.lang.String typeSchema, java.lang.String tagName, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by given
Resource
type schemas and tag name (both with exact match)
typeSchema
- The (resource) type (schema).tagName
- The name of the tag 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 must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTypeSchemasAndTagNames(java.util.Collection<java.lang.String> typeSchemas, java.util.Collection<java.lang.String> tagNames, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by given
Resource
types (schemas) and (tags) names. This performs
exact match searches only.
typeSchemas
- The (resource) types.tagNames
- The names 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 tags must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByRating(int fromRating, int tillRating, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by a given rating
interval. The specified values are inclusive.
fromRating
- The start value of the interval.tillRating
- The end value of the interval.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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTypeSchemaAndRating(java.lang.String typeSchema, int fromRating, int tillRating, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by a given
Resource
type (schema) and rating interval. The specified
values are inclusive.
typeSchema
- The (resource) type (schema).fromRating
- The start value of the interval.tillRating
- The end value of the interval.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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByTypeSchemasAndRating(java.util.Collection<java.lang.String> typeSchemas, int fromRating, int tillRating, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by given
Resource
type schemas and rating interval. The specified
values are inclusive.
typeSchemas
- The resource type schemas.fromRating
- The start value of the interval.tillRating
- The end value of the interval.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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategory(java.lang.String categoryName, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by a given category.
Typical use case: Find all pages, portlets, products, photos, etc. being
in a certain category.
categoryName
- The name of the category.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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategories(java.util.Collection<java.lang.String> categoryNames, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by given categories.
Typical use case: Find all pages, portlets, products, photos, etc. being
in a certain category.
categoryNames
- The names of the categoriesorderMetric
- (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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategoryAndTagName(java.lang.String categoryName, java.lang.String tagName, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by a given category and
tag name (exact match).
categoryName
- The name of the category.tagName
- The name of the tag 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 must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategoriesAndTagNames(java.util.Collection<java.lang.String> categoryNames, java.util.Collection<java.lang.String> tagNames, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) throws ModelException
Resource
objects by the given categories
and (tag) names.
categoryNames
- The names of the categories.tagNames
- The names 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 tags must have been
applied. May be null
- in this case the tags may
have been applied in any locale.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByIDs(java.util.List<ObjectID> anObjectIDs) throws ModelException
Resource
objects by the given
ObjectID
s
anObjectIDs
- the ids of the objects to find. Must not be null
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategoryAndRating(java.lang.String categoryName, int fromRating, int tillRating, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by a given category and
rating interval. The specified values are inclusive.
categoryName
- The name of the category.fromRating
- The start value of the interval.tillRating
- The end value of the interval.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
.
Resource
objects.
ModelException
CountableIterablePagedListModel<R> findByCategoriesAndRating(java.util.Collection<java.lang.String> categoryNames, int fromRating, int tillRating, Constants.OrderMetric orderMetric, Constants.Order order) throws ModelException
Resource
objects by given categories and
rating interval. The specified values are inclusive.
categoryNames
- The names of the category.fromRating
- The start value of the interval.tillRating
- The end value of the interval.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
.
Resource
objects.
ModelException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |