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.RDList< T > Class Template Reference
+ Inheritance diagram for erminas.SmartAPI.Utils.CachedCollections.RDList< T >:
+ Collaboration diagram for erminas.SmartAPI.Utils.CachedCollections.RDList< T >:

Public Member Functions

 RDList (Func< List< T >> retrieveFunc, Caching caching)
 
bool Contains (T element)
 
bool ContainsGuid (Guid guid)
 
bool ContainsName (string name)
 
GetByGuid (Guid guid)
 
GetByName (string name)
 
new IRDList< T > Refreshed ()
 
bool TryGetByGuid (Guid guid, out T output)
 
bool TryGetByName (string name, out T output)
 
void WaitFor (Predicate< IRDList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
 
- Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.CachedList< T >
 CachedList (Func< List< T >> retrieveFunc, Caching caching)
 
GetByPosition (int pos)
 
IEnumerator< T > GetEnumerator ()
 
virtual void InvalidateCache ()
 
void Refresh ()
 
ICachedList< T > Refreshed ()
 
void WaitFor (Predicate< ICachedList< T >> predicate, TimeSpan wait, 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
 

Protected Member Functions

 RDList (Caching caching)
 
- Protected Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.CachedList< T >
 CachedList (Caching caching)
 
void EnsureListIsLoaded ()
 

Additional Inherited Members

- Properties inherited from erminas.SmartAPI.Utils.CachedCollections.CachedList< T >
int Count [get]
 
virtual bool IsCachingEnabled [get, set]
 
virtual List< T > List [get, set]
 
Func< List< T > > RetrieveFunc [get, set]
 
- 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 RDList.cs.

Constructor & Destructor Documentation

erminas.SmartAPI.Utils.CachedCollections.RDList< T >.RDList ( Func< List< T >>  retrieveFunc,
Caching  caching 
)

Definition at line 25 of file RDList.cs.

erminas.SmartAPI.Utils.CachedCollections.RDList< T >.RDList ( Caching  caching)
protected

Definition at line 29 of file RDList.cs.

Member Function Documentation

bool erminas.SmartAPI.Utils.CachedCollections.RDList< T >.Contains ( element)

Definition at line 33 of file RDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.RDList< T >.ContainsGuid ( Guid  guid)

Definition at line 38 of file RDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.RDList< T >.ContainsName ( string  name)

Definition at line 44 of file RDList.cs.

T erminas.SmartAPI.Utils.CachedCollections.RDList< T >.GetByGuid ( Guid  guid)

Definition at line 50 of file RDList.cs.

T erminas.SmartAPI.Utils.CachedCollections.RDList< T >.GetByName ( string  name)

Definition at line 56 of file RDList.cs.

new IRDList<T> erminas.SmartAPI.Utils.CachedCollections.RDList< T >.Refreshed ( )

Definition at line 62 of file RDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.RDList< T >.TryGetByGuid ( Guid  guid,
out T  output 
)

Definition at line 68 of file RDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.RDList< T >.TryGetByName ( string  name,
out T  output 
)

Definition at line 75 of file RDList.cs.

void erminas.SmartAPI.Utils.CachedCollections.RDList< T >.WaitFor ( Predicate< IRDList< T >>  predicate,
TimeSpan  wait,
TimeSpan  retryPeriod 
)

Definition at line 82 of file RDList.cs.


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