|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityListable
This interface defines the listEntities()
method that list all
entities in an entity repository (commonly a Directory
).
This interface extends Iterable<EntityView>
. See
DirectoryView
for more information on that.
Objects implementing this interface can be used with some of the utility
methods of Entities
and
Directories
.
Method Summary | |
---|---|
boolean |
isEmpty()
Is the listable empty? If a directory view is empty, the viewed directory may still contain entities that are hidden by the view's filter. |
Set<EntityView> |
listEntities()
Return all entities that are visible in this directory. |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Methods inherited from interface org.entityfs.lock.ReadLockable |
---|
getReadLock, isReadLockedByCurrentThread, lockForReading |
Method Detail |
---|
Set<EntityView> listEntities() throws IllegalStateException, ReadLockRequiredException, AccessDeniedException
If this is called on a directory view, all returned ViewCapable
entities inherit the view's filters.
Set
of entity views. If this is called on a directory
entity object, a set of entity objects (not views) are returned. The set
may be empty, but never null
.
IllegalStateException
- If the view is disconnected
ReadLockRequiredException
- If the client does not have a read lock
for the directory.
AccessDeniedException
- If the client does not have execute access
to the directory.boolean isEmpty() throws IllegalStateException, ReadLockRequiredException, AccessDeniedException
true
if the directory view is empty.
IllegalStateException
- If the view is disconnected.
ReadLockRequiredException
- If the client does not have a read lock
for the directory.
AccessDeniedException
- If the client does not have execute access
to the directory.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |