Class EndpointSearchBase

Provides parameters for a query and its result that selects service endpoints from the registry.

Inheritance

Object

EndpointSearchBase

EndpointSearchQuery

EndpointSearchResult

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: Nevatech.Vsb.Repository.Entities.Search

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public abstract class EndpointSearchBase

Constructors

EndpointSearchBase()

Declaration

protected EndpointSearchBase()

Properties

BindingKey

Gets or sets the endpoint binding unique identifier.

Declaration

public Guid? BindingKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

BindingPathAndName

Gets or sets the full folder path and binding name that may include wildcards.

Declaration

public string BindingPathAndName { get; set; }

Property Value

Type	Description
String

Examples

"/RootFolder/Folder1/My Node", "/My Node", "/Node"

ContractKey

Gets or sets the contract unique identifier.

Declaration

public Guid? ContractKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

ContractQName

Gets or sets contract name and namespace that must match to the ones defined in the metadata.

Declaration

public XmlQualifiedName ContractQName { get; set; }

Property Value

Type	Description
XmlQualifiedName

EndpointKey

Gets or sets the endpoint unique identifier.

Declaration

public Guid? EndpointKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

EndpointName

Gets or sets the endpoint name that may include wildcards.

Declaration

public string EndpointName { get; set; }

Property Value

Type	Description
String

ErrorMessage

Gets the message indicating the errors found during validation process.

Declaration

public string ErrorMessage { get; protected set; }

Property Value

Type	Description
String

IsHosted

Gets or sets flag indicating that only endpoints that are actively hosted endpoints must be retrieved. If not set, all endpoints are retrieved.

Declaration

public bool? IsHosted { get; set; }

Property Value

Type	Description
Nullable<Boolean>

IsVirtual

Gets or sets flag indicating that only virtual or only physical services must be retrieved. If not set, all services are retrieved.

Declaration

public bool? IsVirtual { get; set; }

Property Value

Type	Description
Nullable<Boolean>

Kind

Gets or sets the endpoint kind (SOAP/REST/OpenData). If not set, all kinds are retrieved.

Declaration

public ServiceKind? Kind { get; set; }

Property Value

Type	Description
Nullable<ServiceKind>

LogicalAddress

Gets or sets the endpoint logical address that may include wildcards.

Declaration

public string LogicalAddress { get; set; }

Property Value

Type	Description
String

NodeKey

Gets or sets the hosting node unique identifier. This property applies to virtual services only.

Declaration

public Guid? NodeKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

NodePathAndName

Gets or sets the full folder path and node name that may include wildcards.

Declaration

public string NodePathAndName { get; set; }

Property Value

Type	Description
String

Examples

"/RootFolder/Folder1/My Node", "/My Node", "/Node"

PhysicalAddress

Gets or sets the endpoint physical address that may include wildcards.

Declaration

public string PhysicalAddress { get; set; }

Property Value

Type	Description
String

ServiceKey

Gets or sets the service unique identifier.

Declaration

public Guid? ServiceKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

ServicePathAndName

Gets or sets the full folder path and service name that may include wildcards.

Declaration

public string ServicePathAndName { get; set; }

Property Value

Type	Description
String

Examples

"/RootFolder/Folder1/My Service", "/My Service", "/Service"

ServiceVersionKey

Gets or sets the service version unique identifier.

Declaration

public Guid? ServiceVersionKey { get; set; }

Property Value

Type	Description
Nullable<Guid>

ServiceVersionQName

Gets or sets service name and namespace that must match to the ones defined in the metadata.

Declaration

public XmlQualifiedName ServiceVersionQName { get; set; }

Property Value

Type	Description
XmlQualifiedName

ServiceVersionStatus

Gets or sets the status of the service version to be returned. If not set, statuses are not checked.

Declaration

public ServiceVersionStatus? ServiceVersionStatus { get; set; }

Property Value

Type	Description
Nullable<ServiceVersionStatus>

VersionNumber

Gets or sets the service version number.

Declaration

public int? VersionNumber { get; set; }

Property Value

Type	Description
Nullable<Int32>

Methods

Append<T>(StringBuilder, String, T)

Appends non-default property value to provided result string.

Declaration

protected static void Append<T>(StringBuilder result, string name, T value)

Parameters

Type	Name	Description
StringBuilder	result	Result string.
String	name	Property name.
T	value	Property value.

Type Parameters

Name	Description
T	Type of the value.

GetHashCode()

Returns the hash code calculated for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	Hash code calculated for this instance.

Overrides

Object.GetHashCode()

ToString()

Returns the non-default query content in readable form.

Declaration

public override string ToString()

Returns

Type	Description
String	Non-default query content in readable form.

Overrides

Object.ToString()

ToStringBuilder()

Returns the non-default query content in readable form.

Declaration

protected StringBuilder ToStringBuilder()

Returns

Type	Description
StringBuilder	Non-default query content in readable form.

Validate()

Evaluates the state of this object.

Declaration

public virtual bool Validate()

Returns

Type	Description
Boolean	True if state is valid; otherwise, false.