Class CheckOutService

Namespace

Dynamicweb.Content.Versioning

Assembly

Dynamicweb.dll

The CheckOutService class provides usecase specific operations for interacting with the CheckOutRepository functionality

public class CheckOutService : ICacheStorage<string, CheckOutObject>, ICacheStorage<string>, ICacheStorage

Inheritance

object

CheckOutService

Implements

ICacheStorage<string, CheckOutObject>

ICacheStorage<string>

ICacheStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CanCheckOut(CheckOutObject)

Returns a value indicating if the specified object can be checked out

public bool CanCheckOut(CheckOutObject checkOutObject)

Parameters

checkOutObject CheckOutObject

The object to check out

Returns

bool

True if the object can be checked out, otherwise false

CheckIn(CheckOutObject)

Checks in the specified object

public void CheckIn(CheckOutObject checkedOutObject)

Parameters

checkedOutObject CheckOutObject

The lock information instance indicating the object to lock

Exceptions

ArgumentNullException

CheckOut(CheckOutObject)

Checks out the specified object

public void CheckOut(CheckOutObject checkOutObject)

Parameters

checkOutObject CheckOutObject

The object to check out

Exceptions

ArgumentNullException

InvalidOperationException

Thrown if the objects is already checkout by other user

ClearCache()

Resets all keys to the default value for objects stored in the object cache

public void ClearCache()

ClearCache(IEnumerable<string>)

Resets the specified keys to the default value for objects stored in the object cache

public void ClearCache(IEnumerable<string> keys)

Parameters

keys IEnumerable<string>

Keys to reset

ClearCache(string)

Resets the specified key to the default value for objects stored in the object cache

public void ClearCache(string key)

Parameters

key string

Key to reset

GetCache(IEnumerable<string>)

public IEnumerable<CheckOutObject> GetCache(IEnumerable<string> keys)

Parameters

keys IEnumerable<string>

Returns

IEnumerable<CheckOutObject>