SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T > Interface Template Reference
+ Inheritance diagram for erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T >:
+ Collaboration diagram for erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T >:

Public Member Functions

new IIndexedRDList< TK, T > Refreshed ()
 
void WaitFor (Func< IIndexedRDList< TK, T >, bool > predicate, TimeSpan maxWait, TimeSpan retryEverySecond)
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IIndexedCachedList< in TK, T >
bool ContainsKey (TK key)
 Check wether the index contains a specific key. If you want to get an element, if it is available, use TryGet as it is faster than a call to ContainsKey and a Get afterwards.
 
Get (TK key)
 Get an entry with a specific key value. Throws an exception if entry could not be found.
 
new IIndexedCachedList< TK, T > Refreshed ()
 
bool TryGet (TK name, out T obj)
 Try to get an entry with a specific key value, returns false, if entry could not be found.
 
void WaitFor (Predicate< IIndexedCachedList< TK, T >> predicate, TimeSpan maxWait, TimeSpan retryPeriod)
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.ICachedList< out T >
GetByPosition (int pos)
 Get an element of the list at a specific position.
 
ICachedList< T > Refreshed ()
 Calls Refresh() and returns this.
 
void WaitFor (Predicate< ICachedList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
 Waits until a predicate on itself becomes true. Every retry period Refresh() is called and the predicate evaluated again, until the predicate evaluates to true, or the wait timespan is exhausted.
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.ICached
void InvalidateCache ()
 Clear the cache and refresh it on the next access.
 
void Refresh ()
 Updates the cache immediatly.
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IRDList< T >
new IRDList< T > Refreshed ()
 
void WaitFor (Predicate< IRDList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
 Same as WaitFor in ICachedList{T} but with an IRDList as predicate input. Provided for convenience.
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IRDEnumerable< T >
bool Contains (T element)
 
bool ContainsGuid (Guid guid)
 
bool ContainsName (string name)
 
GetByGuid (Guid guid)
 
GetByName (string name)
 Get the first element with Name == name
 
bool TryGetByGuid (Guid guid, out T output)
 
bool TryGetByName (string name, out T output)
 Try to get the first element with Name == name
 

Additional Inherited Members

- Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IIndexedCachedList< in TK, T >
this[TK key] [get]
 Same as GetByName only as indexer.
 
- Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IRDList< T >
new int Count [get]
 

Detailed Description

Type Constraints
T :class 
T :IRedDotObject 

Definition at line 23 of file IndexedRDList.cs.

Member Function Documentation

new IIndexedRDList<TK, T> erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T >.Refreshed ( )
void erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T >.WaitFor ( Func< IIndexedRDList< TK, T >, bool >  predicate,
TimeSpan  maxWait,
TimeSpan  retryEverySecond 
)

The documentation for this interface was generated from the following file: