Version:

RaftRepository Class

A repository for a raft.

Inheritance Hierarchy

object
- Inedo.Otter.Extensibility.RaftRepositories.RaftRepository
  - Inedo.Otter.Extensions.RaftRepositories.DatabaseRaftRepository
  - Inedo.Otter.Extensions.RaftRepositories.DirectoryRaftRepository

Syntax

public class RaftRepository : System.IDisposable

Constructors

	Name	Description
	RaftRepository	Initializes a new instance of the RaftRepository class.

Properties

	Name	Description
	DefaultName	Gets the name of the default raft.
	IsReadOnly	Gets a value indicating whether the items in the raft are read only.
	RaftName	Gets the name of the raft as defined by the user

Methods

	Name	Description
	Commit(Inedo.Otter.Extensibility.UserDirectories.IUserDirectoryUser user)	Closes any external connections and commits any changes made that were not immediately saved.
	DeleteRaftItem(RaftItemType type, string name)	Deletes the raft item.
	DeleteVariable(Inedo.ExecutionEngine.RuntimeVariableName name)	Deletes the specified variable if it exists.
	Dispose	Releases resources used by the raft repository.
	Dispose(bool disposing)	Releases resources used by the raft repository.
	GetDefaultRaftId	Gets the id of the default raft, or null (Nothing in Visual Basic) if there is no default raft
	GetDescription	Gets a description of the raft's configuration.
	GetRaftItem(RaftItemType type, string name)	Returns the specified item in a raft.
	GetRaftItems	Returns all of the items contained in the raft.
	GetRaftItems(RaftItemType type)	Returns all of the items of the specified type contained in the raft.
	GetVariables	Returns a dictionary containing all of the variables and their values in the raft.
	IsDefaultRaft(string raftName)	Performs a case-insensitive search against DefaultName
	IsDefaultRaft(Inedo.Otter.Data.Tables.Rafts raftData)
	OpenRaft(int raftId)	Opens the raft.
	OpenRaft(string raftName)	Opens the raft.
	OpenRaftItem(RaftItemType type, string name, System.IO.FileMode fileMode, System.IO.FileAccess fileAccess)	Opens an item contained in the raft.
	SaveToZip(System.IO.Stream stream)	Saves a copy of the raft to the specified System.IO.Stream in zip format.
	SetVariable(Inedo.ExecutionEngine.RuntimeVariableName name, string value)	Sets the value of the specified variable.
	TestConfiguration	Attempts to test the validating of the raft's configuration.
	WriteStandardVariableData(System.Collections.Generic.IReadOnlyDictionary<Inedo.ExecutionEngine.RuntimeVariableName, string> variables, System.IO.TextWriter textWriter)	Writes a dictionary of variasbles values to the specified System.IO.TextWriter.