Class WcfRepositoryClient

Provides a WCF client used to access Colectica Repository.

Inheritance

System.Object

WcfRepositoryClient

Inherited Members

RepositoryClientBase.ConnectionInfoChanged

Algenta.Colectica.Model.Repository.RepositoryClientBase.UpdateDeprecatedState(Collection<>, System.Boolean, System.Boolean)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetPermissions(Collection<>, Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.RemovePermissions(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetTypedRelationships(Collection<>, Algenta.Colectica.Model.Repository.RelationshipFacet)

RepositoryClientBase.GetTypedRelationships(IdentifierTriple)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetTypedRelationships(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetRelationships(Collection<>, Algenta.Colectica.Model.Repository.RelationshipFacet)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetRelationships(Collection<>)

RepositoryClientBase.GetRelationships(IdentifierTriple, RelationshipFacet)

RepositoryClientBase.GetRelationships(IdentifierTriple)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetCommentsCollection(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetRepositoryItems(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetLatestRepositoryItems(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.RegisterItems(Collection<>, Algenta.Colectica.Model.Repository.CommitOptions)

RepositoryClientBase.CreateTag(IdentifierTriple, String)

RepositoryClientBase.RemoveTag(IdentifierTriple, String)

RepositoryClientBase.GetTags(IdentifierTriple)

Algenta.Colectica.Model.Repository.RepositoryClientBase.BatchRegisterItems(Collection<>, Algenta.Colectica.Model.Repository.CommitOptions)

Algenta.Colectica.Model.Repository.RepositoryClientBase.BatchGetRepositoryItems(Collection<>)

RepositoryClientBase.ProgressChanged

RepositoryClientBase.GetRepresentation(IVersionable, Guid)

RepositoryClientBase.RegisterItem(IVersionable, CommitOptions)

Algenta.Colectica.Model.Repository.RepositoryClientBase.RegisterItems(IEnumerable<>, Algenta.Colectica.Model.Repository.CommitOptions)

RepositoryClientBase.DeserializeRepositoryItem(RepositoryItem, ChildReferenceProcessing, ItemCache)

RepositoryClientBase.GetSchemeItems(IdentifierTriple, Int32, Int32)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetItems(Collection<>, Algenta.Colectica.Model.Repository.ChildReferenceProcessing)

RepositoryClientBase.GetItem(IdentifierTriple, ChildReferenceProcessing)

RepositoryClientBase.GetItem(IdentifierTriple)

RepositoryClientBase.GetItem(Guid, String, Int64)

RepositoryClientBase.GetItem(Guid, String, Int64, Boolean, ChildReferenceProcessing)

RepositoryClientBase.GetItem(Guid, String, Int64, ChildReferenceProcessing)

RepositoryClientBase.GetLatestItem(Guid, String)

RepositoryClientBase.GetLatestItem(Guid, String, ChildReferenceProcessing)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetLatestVersionNumbers(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetRepositoryItemDescriptions(Collection<>)

Algenta.Colectica.Model.Repository.RepositoryClientBase.GetTransactionsAsync(Collection<>)

RepositoryClientBase.PopulateItem(IVersionable)

RepositoryClientBase.PopulateItem(IVersionable, Boolean)

RepositoryClientBase.PopulateItem(IVersionable, Boolean, ChildReferenceProcessing)

RepositoryClientBase.PopulateItem(IVersionable, Boolean, ItemCache, ChildReferenceProcessing)

RepositoryClientBase.Dispose()

Namespace: Algenta.Colectica.Repository.Client

Assembly: Algenta.Colectica.Repository.Client.dll

Syntax

public class WcfRepositoryClient : RepositoryClientBase

Examples

// The WcfRepositoryClient takes a configation object // detailing how to connect to the Repository. var connectionInfo = new RepositoryConnectionInfo() { // TODO Replace this with the hostname of your Colectica Repository Url = "localhost", AuthenticationMethod = RepositoryAuthenticationMethod.Windows, TransportMethod = RepositoryTransportMethod.NetTcp, };

// Create the client object, passing in the connection information. var client = new WcfRepositoryClient(connectionInfo); var info = client.GetRepositoryInfo();

Constructors

WcfRepositoryClient(RepositoryConnectionInfo)

Initializes a new instance of the WcfRepositoryClient class.

Declaration

public WcfRepositoryClient(RepositoryConnectionInfo connectionInfo)

Parameters

Type	Name	Description
RepositoryConnectionInfo	connectionInfo	The connection information.

Properties

ClientType

Gets the type of the client. For this class, the client will always be Remote.

Declaration

public override ClientType ClientType { get; }

Property Value

Type	Description
ClientType

Overrides

RepositoryClientBase.ClientType

Name

Gets the name of the repository.

Declaration

public override string Name { get; }

Property Value

Type	Description
System.String

Overrides

RepositoryClientBase.Name

Methods

AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest)

Add items to a transaction to be registered

Declaration

public override Task<RepositoryTransaction> AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest request)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request	transaction identifier and repository items

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Overrides

RepositoryClientBase.AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest)

AddPermissions(RepositorySecurityContext)

Adds the specified permissions to the repository.

Declaration

public override void AddPermissions(RepositorySecurityContext context)

Parameters

Type	Name	Description
RepositorySecurityContext	context	The context defining the permissions.

Overrides

RepositoryClientBase.AddPermissions(RepositorySecurityContext)

CancelTransactionAsync(RepositoryTransactionCancelOptions)

Cancel a transaction

Declaration

public override Task<RepositoryTransaction> CancelTransactionAsync(RepositoryTransactionCancelOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options	Transaction cancelation options

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Overrides

RepositoryClientBase.CancelTransactionAsync(RepositoryTransactionCancelOptions)

CommitTransactionAsync(RepositoryTransactionCommitOptions)

Declaration

public override Task<RepositoryTransaction> CommitTransactionAsync(RepositoryTransactionCommitOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options	Specify version updating and progagation rules

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Overrides

RepositoryClientBase.CommitTransactionAsync(RepositoryTransactionCommitOptions)

CreateComment(Guid, String, Int64, String)

Adds a comment to the specified item.

Declaration

public override void CreateComment(Guid identifier, string agency, long version, string comment)

Parameters

Type	Name	Description
Guid	identifier	The identifier of the item to which the comment will be added.
System.String	agency	The agency of the item to which the comment will be added.
System.Int64	version	The version of the item to which the comment will be added.
System.String	comment	The comment.

CreateRepository(String, String)

Marks the repository as authoritative for the specified agency.

Declaration

public override void CreateRepository(string agency, string name)

Parameters

Type	Name	Description
System.String	agency	The agency for which the repository will be marked as authoritative.
System.String	name	The name of the agency.

CreateTag(Guid, String, Int64, String)

Applies a tag to an item in the repository.

Declaration

public override void CreateTag(Guid id, string agency, long version, string name)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to which the tag will be applied.
System.String	agency	The agency of the item to which the tag will be applied.
System.Int64	version	The version of the item to which the tag will be applied.
System.String	name	The tag to be applied.

CreateTransactionAsync()

Create a new Repository transaction

Declaration

public override Task<RepositoryTransaction> CreateTransactionAsync()

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Overrides

RepositoryClientBase.CreateTransactionAsync()

DeprecateAllItemVersions(Guid, String)

Deprecates all versions of an item.

Declaration

public override void DeprecateAllItemVersions(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to deprecate.
System.String	agency	The agency of the item to deprecate.

DeprecateItem(Guid, String, Int64)

Deprecates the specified item.

Declaration

public override void DeprecateItem(Guid id, string agency, long version)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to deprecate.
System.String	agency	The agency of the item to deprectate.
System.Int64	version	The version of the item to deprecate.

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	`true` to release both managed and unmanaged resources; `false` to release only unmanaged resources.

GetComments(Guid, String)

Gets the comments for all versions of an item.

Declaration

public override Collection<UserComment> GetComments(Guid identifier, string agency)

Parameters

Type	Name	Description
Guid	identifier	The identifier of the item for which to retrieve comments.
System.String	agency	The agency of the item for which to retrieve comments.

Returns

Type	Description
Collection<UserComment>	All comments about the item.

GetCommentsCollection(Collection<IdentifierTriple>)

Gets the comments for all versions of a set of items.

Declaration

public override Collection<UserComment> GetCommentsCollection(Collection<IdentifierTriple> ids)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	ids	The identifiers of the items for which to retrieve comments.

Returns

Type	Description
Collection<UserComment>	All comments about the set of items.

GetItemsInTransactionAsync(Int64)

Retrieve the current items in a transaction

Declaration

public override Task<Collection<RepositoryItem>> GetItemsInTransactionAsync(long transactionId)

Parameters

Type	Name	Description
System.Int64	transactionId	transaction identifier

Returns

Type	Description
Task<Collection<RepositoryItem>>	Items to be registered in the transaction

GetLatestRepositoryItem(Guid, String)

Gets the latest version of an undeserialized item from the repository. To retrieve a deserialized IVersionable object, use the GetLatestItem method.

Declaration

public override RepositoryItem GetLatestRepositoryItem(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to retrieve.
System.String	agency	The agency of the item to retrieve.

Returns

Type	Description
RepositoryItem

GetLatestRepositoryItems(Collection<IdentifierTriple>)

Gets a list of the latest versions of undeserialized items from the repository. To retrieve deserialized IVersionable objects, use the GetLatestItems method.

Declaration

public override Collection<RepositoryItem> GetLatestRepositoryItems(Collection<IdentifierTriple> identifiers)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	identifiers	The identifiers of the items to retrieve.

Returns

Type	Description
Collection<RepositoryItem>	A list of undeserialized repository items.

GetLatestSet(IdentifierTriple)

Gets the set of items defined by the specified root. Each item in the set will have the latest version number for that item.

Declaration

public override Collection<IdentifierTriple> GetLatestSet(IdentifierTriple rootItem)

Parameters

Type	Name	Description
IdentifierTriple	rootItem	The root item that defines the set.

Returns

Type	Description
Collection<IdentifierTriple>	A list of identifiers of all items in the set.

Overrides

RepositoryClientBase.GetLatestSet(IdentifierTriple)

GetLatestVersionNumber(Guid, String)

Gets the latest version number of a repository item.

Declaration

public override long GetLatestVersionNumber(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item.
System.String	agency	The agency of the item.

Returns

Type	Description
System.Int64	The latest version number of the item.

GetLatestVersionNumberOfTag(Guid, String, String)

Gets the latest version number of the specified repository item that has the specified tag.

Declaration

public override long GetLatestVersionNumberOfTag(Guid id, string agency, string tag)

Parameters

Type	Name	Description
Guid	id	The identifier of the item.
System.String	agency	The agency of the item.
System.String	tag	The tag.

Returns

Type	Description
System.Int64	The latest version number of the repository item with the tag.

GetLatestVersionNumbers(Collection<IdentifierTriple>)

Gets the latest version numbers of multiple items.

Declaration

public override Collection<IdentifierTriple> GetLatestVersionNumbers(Collection<IdentifierTriple> identifiers)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	identifiers	The identifiers of the items.

Returns

Type	Description
Collection<IdentifierTriple>	A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

GetPermissions(Collection<IdentifierTriple>, Collection<Guid>)

Gets all permissions that apply to the specified items and item types.

Declaration

public override RepositorySecurityContext GetPermissions(Collection<IdentifierTriple> identifiers, Collection<Guid> itemTypes)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	identifiers	The identifiers of the items for which permissions are retrieved.
Collection<Guid>	itemTypes	The item types for which permissions are retrieved.

Returns

Type	Description
RepositorySecurityContext	The permissions that apply to the requested items and types.

GetRelationshipByObject(GraphSearchFacet)

Gets a list of items that reference the specified item, according to the provided search options.

Declaration

public override Collection<TypedIdTriple> GetRelationshipByObject(GraphSearchFacet facet)

Parameters

Type	Name	Description
GraphSearchFacet	facet	The parameters for the relationship search.

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Overrides

RepositoryClientBase.GetRelationshipByObject(GraphSearchFacet)

GetRelationshipBySubject(GraphSearchFacet)

Gets a list of items referenced by the specified item, according to the provided search options.

Declaration

public override Collection<TypedIdTriple> GetRelationshipBySubject(GraphSearchFacet facet)

Parameters

Type	Name	Description
GraphSearchFacet	facet	The parameters for the relationship search.

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Overrides

RepositoryClientBase.GetRelationshipBySubject(GraphSearchFacet)

GetRelationships(Collection<IdentifierTriple>, RelationshipFacet)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public override AdjacencyMatrix GetRelationships(Collection<IdentifierTriple> rootItems, RelationshipFacet facet)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	rootItems	The root items that define the set.
RelationshipFacet	facet	The facet describing how the search should be performed.

Returns

Type	Description
AdjacencyMatrix	A matrix representing all items in the set and the relationships among those items.

GetRepositoryInfo()

Gets the inforation about the repository and the items it contains.

Declaration

public override RepositoryInfo GetRepositoryInfo()

Returns

Type	Description
RepositoryInfo	An object containing information about the repository and the items it contains.

Overrides

RepositoryClientBase.GetRepositoryInfo()

GetRepositoryItem(Guid, String, Int64)

Gets an undeserialized item from the repository. To retrieve a deserialized IVersionable object, use the GetItem method.

Declaration

public override RepositoryItem GetRepositoryItem(Guid id, string agency, long version)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to retrieve.
System.String	agency	The agency of the item to retrieve.
System.Int64	version	The version of the item to retrieve.

Returns

Type	Description
RepositoryItem	The repository item.

GetRepositoryItemDescription(Guid, String, Int64)

Gets a description of a repository item. The RepositoryItemMetadata description contains identification, naming, and summary information, but not the entire contents of the item.

Declaration

public override RepositoryItemMetadata GetRepositoryItemDescription(Guid id, string agency, long version)

Parameters

Type	Name	Description
Guid	id	The identifier of the item for which a description will be retrieved.
System.String	agency	The agency of the item for which a description will be retrieved.
System.Int64	version	The version of the item for which a description will be retrieved.

Returns

Type	Description
RepositoryItemMetadata	A description of the repository item.

Examples

// Search for all VariableStatistics related to the PhysicalInstance. var facet = new GraphSearchFacet(); facet.TargetItem = physicalInstanceIdentifier; facet.UseDistinctTargetItem = true; facet.UseDistinctResultItem = true; facet.ItemTypes.Add(DdiItemType.VariableStatistic);

// Perform the search. var results = client.GetRepositoryItemDescriptionsBySubject(facet);

// Write a line for each result. foreach (var result in results) { Console.WriteLine(result.Label["en-US"]); }

GetRepositoryItemDescriptions(Collection<IdentifierTriple>)

Gets descriptions of multiple repository items. The RepositoryItemMetadata descriptions contain identification, naming, and summary information, but not the entire contents of the item.

Declaration

public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptions(Collection<IdentifierTriple> identifiers)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	identifiers	The identifiers for which descriptions will be retrieved.

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items.

GetRepositoryItemDescriptionsByObject(GraphSearchFacet)

Gets the repository item descriptions for items that match the specified relationship search parameters. The search will query for items that reference the target item specified in the search facet.

Declaration

public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptionsByObject(GraphSearchFacet facet)

Parameters

Type	Name	Description
GraphSearchFacet	facet	The relationship search parameters.

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items that match the search parameters.

Overrides

RepositoryClientBase.GetRepositoryItemDescriptionsByObject(GraphSearchFacet)

GetRepositoryItemDescriptionsBySubject(GraphSearchFacet)

Gets the repository item descriptions for items that match the specified relationship search parameters. The search will query for items referenced by the target item specified in the search facet.

Declaration

public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptionsBySubject(GraphSearchFacet facet)

Parameters

Type	Name	Description
GraphSearchFacet	facet	The relationship search parameters.

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items that match the search parameters.

Overrides

RepositoryClientBase.GetRepositoryItemDescriptionsBySubject(GraphSearchFacet)

GetRepositoryItems(Collection<IdentifierTriple>)

Gets a list of undeserialized items from the repository. To retrieve deserialized IVersionable objects, use the GetItems method.

Declaration

public override Collection<RepositoryItem> GetRepositoryItems(Collection<IdentifierTriple> identifiers)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	identifiers	The identifiers to retrieve.

Returns

Type	Description
Collection<RepositoryItem>	A list of repository items

GetRepositorySetting(String)

Gets the repository setting with the specified name.

Declaration

public override RepositorySetting GetRepositorySetting(string settingName)

Parameters

Type	Name	Description
System.String	settingName	The name of the repository setting.

Returns

Type	Description
RepositorySetting	The repository setting.

GetRepositorySettings()

Gets all the repository settings.

Declaration

public override Collection<RepositorySetting> GetRepositorySettings()

Returns

Type	Description
Collection<RepositorySetting>	A list of all repository settings.

Overrides

RepositoryClientBase.GetRepositorySettings()

GetSet(IdentifierTriple)

Gets the set of all items under the specified root.

Declaration

public override Collection<IdentifierTriple> GetSet(IdentifierTriple rootItem)

Parameters

Type	Name	Description
IdentifierTriple	rootItem	The root item.

Returns

Type	Description
Collection<IdentifierTriple>	The set of all items under the specified root.

Overrides

RepositoryClientBase.GetSet(IdentifierTriple)

GetTags(Guid, String, Int64)

Gets the tags applied to the specified item in the repository.

Declaration

public override Collection<string> GetTags(Guid id, string agency, long version)

Parameters

Type	Name	Description
Guid	id	The identifier of the item for which tags will be retrieved.
System.String	agency	The agency of the item for which tags will be retrieved.
System.Int64	version	The version of the item for which tags will be retrieved.

Returns

Type	Description
Collection<System.String>	A list of tags applied to the item in the repository.

GetTransactionsAsync(Collection<Int64>)

Get Transaction metadata

Declaration

public override Task<Collection<RepositoryTransaction>> GetTransactionsAsync(Collection<long> transactionIds)

Parameters

Type	Name	Description
Collection<System.Int64>	transactionIds	Transactions to request

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata

GetTypedRelationships(Collection<IdentifierTriple>, RelationshipFacet)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public override TypedAdjacencyMatrix GetTypedRelationships(Collection<IdentifierTriple> rootItems, RelationshipFacet facet)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	rootItems	The root items that defines the set.
RelationshipFacet	facet	The facet describing how the search should be performed.

Returns

Type	Description
TypedAdjacencyMatrix	A matrix representing all items in the set and the relationships among those items.

GetVersionHistory(Guid, String)

Gets the version history of an item.

Declaration

public override Collection<RepositoryItemMetadata> GetVersionHistory(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item for which version history will be retrieved.
System.String	agency	The agency of the item for which version history will be retrieved.

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection containing a description for each version of a repository item.

GetVersions(Guid, String)

Gets a list of all versions of the specified item.

Declaration

public override Collection<IdentifierTriple> GetVersions(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item for which version history will be returned.
System.String	agency	The agency of the item for which version history will be returned.

Returns

Type	Description
Collection<IdentifierTriple>	A list of all versions of the specified item.

ListTransactionsAsync(RepositoryTransactionListOptions)

Get a list of current transactions

Declaration

public override Task<Collection<RepositoryTransaction>> ListTransactionsAsync(RepositoryTransactionListOptions options)

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options	Transaction listing options

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	A collection of Transaction metadata

Overrides

RepositoryClientBase.ListTransactionsAsync(RepositoryTransactionListOptions)

LogEvent(LoggedEvent)

Log an event

Declaration

public override void LogEvent(LoggedEvent loggedEvent)

Parameters

Type	Name	Description
LoggedEvent	loggedEvent

Overrides

RepositoryClientBase.LogEvent(LoggedEvent)

RegisterItem(RepositoryItem, CommitOptions)

Registers the item in the repository.

Declaration

public override void RegisterItem(RepositoryItem item, CommitOptions options)

Parameters

Type	Name	Description
RepositoryItem	item	The item to register.
CommitOptions	options	The options to pass to the repository.

Overrides

RepositoryClientBase.RegisterItem(RepositoryItem, CommitOptions)

RegisterItems(Collection<RepositoryItem>, CommitOptions)

Registers the items in the repository.

Declaration

public override Collection<RepositoryConflict> RegisterItems(Collection<RepositoryItem> items, CommitOptions options)

Parameters

Type	Name	Description
Collection<RepositoryItem>	items	The items to register.
CommitOptions	options	The options to pass to the repository.

Returns

Type	Description
Collection<RepositoryConflict>

RemovePermissions(Collection<Int64>)

Removes the specified permissions from the repository.

Declaration

public override void RemovePermissions(Collection<long> permissionIds)

Parameters

Type	Name	Description
Collection<System.Int64>	permissionIds	The identifiers of the permissions to remove.

RemoveRepository(String)

Marks the repository as no longer authoritative for the specified agency.

Declaration

public override void RemoveRepository(string agency)

Parameters

Type	Name	Description
System.String	agency	The agency for which the repository will no longer be marked as authoritative.

RemoveRepositorySetting(String)

Removes the repository setting with the specified name.

Declaration

public override void RemoveRepositorySetting(string settingName)

Parameters

Type	Name	Description
System.String	settingName	Name of the setting.

RemoveTag(Guid, String, Int64, String)

Removes a tag from an item in the repository

Declaration

public override void RemoveTag(Guid id, string agency, long version, string name)

Parameters

Type	Name	Description
Guid	id	The identifier of the item from which the tag will be removed.
System.String	agency	The agency of the item from which the tag will be removed.
System.Int64	version	The version of the item from which the tag will be removed.
System.String	name	The tag to be removed.

RestoreAllItemVersions(Guid, String)

Makes all versions of a item no longer deprecated.

Declaration

public override void RestoreAllItemVersions(Guid id, string agency)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to restore.
System.String	agency	The agency of the item to restore.

RestoreItem(Guid, String, Int64)

Makes an item no longer deprecated.

Declaration

public override void RestoreItem(Guid id, string agency, long version)

Parameters

Type	Name	Description
Guid	id	The identifier of the item to restore.
System.String	agency	The agency of the item to restore.
System.Int64	version	The version of the item to restore.

Search(SearchFacet)

Searches the specified the repository for items, according to the provided search options.

Declaration

public override SearchResponse Search(SearchFacet facet)

Parameters

Type	Name	Description
SearchFacet	facet	The parameters for the search.

Returns

Type	Description
SearchResponse	A search response, which includes the matching results and summary information.

Overrides

RepositoryClientBase.Search(SearchFacet)

Examples

// Search the entire repository for all variables with the word // "age". var facet = new SearchFacet(); facet.ItemTypes.Add(DdiItemType.Variable); facet.SearchTerms.Add("age");

// Perform the search. var response = client.Search(facet);

// Show a summary of the search results. How many items were found // and how long the search took. Console.WriteLine(string.Format( "Displaying {0} of {1} results. Search took {2}.", response.ReturnedResults, response.TotalResults, response.RepositoryTime));

// Write a line for each result. foreach (var result in response.Results) { Console.WriteLine(result.Label["en-US"]); }

SearchTypedSet(IdentifierTriple, SetSearchFacet)

Searches the specified set of items according to the provided search options.

Declaration

public override Collection<TypedIdTriple> SearchTypedSet(IdentifierTriple rootItem, SetSearchFacet facet)

Parameters

Type	Name	Description
IdentifierTriple	rootItem	The root item that defines the set to search.
SetSearchFacet	facet	The parameters for the set search.

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Overrides

RepositoryClientBase.SearchTypedSet(IdentifierTriple, SetSearchFacet)

Examples

// Search for all Categories in the DataRelationship's set. var facet = new SetSearchFacet(); facet.ItemTypes.Add(DdiItemType.Category);

var resultIdentifiers = client.SearchTypedSet( dataRelationshipIdentifier, facet);

// The set search only returns the identifiers of items. // Request the description of each result here. var results = client.GetRepositoryItemDescriptions( resultIdentifiers.ToIdentifierCollection());

// Write a line for each result. foreach (var result in results) { Console.WriteLine(result.Label["en-US"]); }

SetRepositorySetting(RepositorySetting)

Adds or updates a repository setting.

Declaration

public override void SetRepositorySetting(RepositorySetting setting)

Parameters

Type	Name	Description
RepositorySetting	setting	The setting to add or update.

Overrides

RepositoryClientBase.SetRepositorySetting(RepositorySetting)

UpdateDeprecatedState(Collection<IdentifierTriple>, Boolean, Boolean)

Updates the Deprecated State of a set of items

Declaration

public override void UpdateDeprecatedState(Collection<IdentifierTriple> ids, bool deprecatedState, bool applyToAllVersions)

Parameters

Type	Name	Description
Collection<IdentifierTriple>	ids	Set of identifiers to update
System.Boolean	deprecatedState	The deprecation state to set
System.Boolean	applyToAllVersions	Apply the state to all versions of the items

Extension Methods

Extensions.Yield<T>(T)