com.atlassian.confluence.core.service
Interface EntityLocator

All Known Subinterfaces:

BlogPostLocator, PageLocator, SingleEntityLocator, SpaceLocator

All Known Implementing Classes:

AbstractPageLocator, AbstractSingleEntityLocator, IdBlogPostLocator, IdContentLocator, IdPageLocator, KeySpaceLocator, SinglePageLocator, TitleAndSpaceKeyPageLocator

public interface EntityLocator

Wrapper for a lazy query for model objects. Commonly passed into services so that object lookup can happen inside the service instead of as a separate operation.

Method Summary

List<ConfluenceEntityObject>

getEntities() Get the entities that match the query represented by this locator.

Method Detail

getEntities

List<ConfluenceEntityObject> getEntities()

Get the entities that match the query represented by this locator. If no entities match the query, this method will return an empty list. If the locator will only ever return a single entity, this method should return a single element list.

Whether the ordering of entities in the returned list is significant is dependent on the specific implementation of the locator.

Returns:

the entities found by this EntityLocator, or an empty list if no entities matched the query