Class IrbExchangeReference

Exposes IrbExchangeReference entity type instances.

Inheritance

System.Object

Namespace:Portal.IrbExchange

Assembly:Portal.IrbExchange.dll

Syntax

public class IrbExchangeReference : Click.Portal.Entity

Properties

Account

The PoRef of the IrbExchange entity used when creating this entity

Declaration

public string Account { get; set; }

Property Value

Type	Description
System.String

Endpoint

PoRef of the endpoint used when creating this entity

Declaration

public string Endpoint { get; set; }

Property Value

Type	Description
System.String

Extent

Gets the extent of IrbExchangeReference instances.

Declaration

public static IEntityQuery<IrbExchangeReference> Extent { get; }

Property Value

Type	Description
IEntityQuery<IrbExchangeReference>

PoRef

The PoRef of the portal object

Declaration

public string PoRef { get; set; }

Property Value

Type	Description
System.String

Methods

GetEndpoint()

Get the endpoint.

Declaration

public IrbExchangeEndpoint GetEndpoint()

Returns

Type	Description
IrbExchangeEndpoint	IrbExchangeEndpoint the endpoint

GetEndpointName()

Get the name of the endpoint.

Declaration

public string GetEndpointName()

Returns

Type	Description
System.String	string name of the endpoint

GetEntityForExchangeId(String, String)

Finds the IrbExchangeReference entity where the passed in ExchangeId matches the ExchangeId attribute on the entity

Declaration

public static IrbExchangeReference GetEntityForExchangeId(string exchangeId, string irbExchangePoRef)

Parameters

Type	Name	Description
System.String	exchangeId	ExchangeId of the object in Portal
System.String	irbExchangePoRef	OID of the account entity

Returns

Type	Description
IrbExchangeReference	Exchange reference entity matching the ExchangeId

GetEntityForExchangeId(String, String, String)

Finds the IrbExchangeReference entity where the passed in ExchangeId matches the ExchangeId attribute on the entity

Declaration

public static IrbExchangeReference GetEntityForExchangeId(string exchangeId, string irbExchangePoRef, string endpointPoRef)

Parameters

Type	Name	Description
System.String	exchangeId	ExchangeId of the object in Portal
System.String	irbExchangePoRef	OID of the account entity
System.String	endpointPoRef	OID of the endpoint related to this entity

Returns

Type	Description
IrbExchangeReference	Exchange reference entity matching the ExchangeId

GetEntityForPoRef(String, String)

Finds the IrbExchangeReference entity where the passed in poRef matches the poRef attribute on the entity

Declaration

public static IrbExchangeReference GetEntityForPoRef(string poRef, string irbExchangePoRef)

Parameters

Type	Name	Description
System.String	poRef	OID of the object in Portal
System.String	irbExchangePoRef	OID of the object in Portal

Returns

Type	Description
IrbExchangeReference	Exchange reference entity matching the poRef

GetEntityForPoRef(String, String, String)

Finds the IrbExchangeReference entity where the passed in poRef matches the poRef attribute on the entity

Declaration

public static IrbExchangeReference GetEntityForPoRef(string poRef, string irbExchangePoRef, string endpointPoRef)

Parameters

Type	Name	Description
System.String	poRef	OID of the object in Portal
System.String	irbExchangePoRef
System.String	endpointPoRef

Returns

Type	Description
IrbExchangeReference	Exchange reference entity matching the poRef

GetEntityType()

Gets the runtime EntityType of this instance.

Declaration

public IrbExchangeReference.EntityType GetEntityType()

Returns

Type	Description
IrbExchangeReference.EntityType

GetExchangeId(String, String, String)

Gets the exchangeId for the given poRef

Declaration

public static string GetExchangeId(string entityPoRef, string irbExchangePoRef, string endpointPoRef)

Parameters

Type	Name	Description
System.String	entityPoRef	Oid of the object in Portal
System.String	irbExchangePoRef	OID of the account entity
System.String	endpointPoRef	OID of the endpoint related to this entity

Returns

Type	Description
System.String	string exchangeId

GetIrbExchange()

Get the account.

Declaration

public IrbExchange GetIrbExchange()

Returns

Type	Description
IrbExchange	IrbExchange the account

GetIrbExchangeAccountName()

Get the account name.

Declaration

public string GetIrbExchangeAccountName()

Returns

Type	Description
System.String	string account name

GetPoRef(String, String, String)

Gets the PoRef/Oid for the given exchangeId

Declaration

public static string GetPoRef(string exchangeId, string irbExchangePoRef, string endpointPoRef)

Parameters

Type	Name	Description
System.String	exchangeId	Id of the item in Exchange
System.String	irbExchangePoRef	OID of the account entity
System.String	endpointPoRef	OiD of the endpoint related to this entity

Returns

Type	Description
System.String	string Oid/PoRef

LinkExchangeIdToPoRef(String, String, String, String, Boolean, Boolean, Boolean, Boolean)

Exists specifically for linking an exchangeId to a Portal entity. Like linking an Exchange organization to a Portal company

Declaration

public static string LinkExchangeIdToPoRef(string exchangeId, string entityPoRef, string irbExchangePoRef, string endpointPoRef, bool throwExceptions = true, bool allowUnlink = false, bool allowReasignmentOrphaning = false, bool allowNullIrbExchangePoRef = false)

Parameters

Type	Name	Description
System.String	exchangeId	The ID of the object on the Exchange
System.String	entityPoRef	The OID of the object on this Portal store
System.String	irbExchangePoRef	The OID of the IrbExchange entity used to create this entity
System.String	endpointPoRef	The OID of the IrbExchangeEndpoint entity that points to the exchange server where the exchangeID can be found. - If allowNullIrbExchangePoRef == true, this param must not be null. Else the param will be ignored and the value obtained via IrbExchange.GetEndpoint() will be used.
System.Boolean	throwExceptions	Flag used to indicate if exceptions should be thrown. If false, the error message will be returned instead of thrown.
System.Boolean	allowUnlink	Flag used to indicate if entities can be unlinked from an exchangeId
System.Boolean	allowReasignmentOrphaning	Flag used to indicate if the system should allow the unlinking of an entity from an exchangeId, which will orphan that record leaving it no longer associated with an account so that the account can be assigned to the passed in entity.
System.Boolean	allowNullIrbExchangePoRef	Flag used to indicate if irbExchangepoRef can be null

Returns

Type	Description
System.String	null if no issues were found with link up. Or a string containing details about the issue if throwExceptions is set to false