A Sandcastle Documented Class Library

# IDataCubeService ModifyDataCubeJoin Method (Guid, Guid, JoinOperation, IList String , IList String , EntitySaveOptions)

Allows the user to change the keys for a specified join operation within a DataCube.

Namespace: Dundas.BI.Entities.DataCubes
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    bool ModifyDataCubeJoin(
    	Guid dataCubeId,
    	Guid joinTransformId,
    	JoinOperation joinType,
    	IList<string> inputKeys,
    	IList<string> referencedKeys,
    	EntitySaveOptions entitySaveOptions
    )

    Function ModifyDataCubeJoin (
    	dataCubeId As Guid,
    	joinTransformId As Guid,
    	joinType As JoinOperation,
    	inputKeys As IList(Of String),
    	referencedKeys As IList(Of String),
    	entitySaveOptions As EntitySaveOptions
    ) As Boolean

    bool ModifyDataCubeJoin(
    	Guid dataCubeId,
    	Guid joinTransformId,
    	JoinOperation joinType,
    	IList<String^>^ inputKeys,
    	IList<String^>^ referencedKeys,
    	EntitySaveOptions^ entitySaveOptions
    )

    abstract ModifyDataCubeJoin :
            dataCubeId : Guid *
            joinTransformId : Guid *
            joinType : JoinOperation *
            inputKeys : IList<string> *
            referencedKeys : IList<string> *
            entitySaveOptions : EntitySaveOptions -> bool

#### Parameters

dataCubeId
  Type: System
  Guid
  The data cube ID.
joinTransformId
  Type: System
  Guid
  The join transform ID.
joinType
  Type: Dundas.BI.Data.DataProviders.Relational
  JoinOperation
  The join type.
inputKeys
  Type: System.Collections.Generic
  IList
  String
  The input keys for the join operation.
referencedKeys
  Type: System.Collections.Generic
  IList
  String
  The referenced keys for the join operation.
entitySaveOptions
  Type: Dundas.BI.Entities
  EntitySaveOptions
  The entity save options.

#### Return Value

Type: Boolean
if the operation was successful, otherwise
.
Exceptions

Exception | Condition
--- | ---
ArgumentNullException | inputKeys or referencedKeys is .
ArgumentException | dataCubeId or joinTransformId is Empty or joinType is not a valid JoinOperation value or inputKeys is empty or referencedKeys is empty or the number of inputKeys is different than the number of referencedKeys.
NoPrivilegeException | Caller does not have access to the specified data cube.
InvalidSessionException | The caller context is not associated with a valid session.
NotFoundException | The data cube with the specified ID does not exist.
NotFoundException | One or more of the specified keys do not exist.

See Also

#### Reference

IDataCubeService Interface
ModifyDataCubeJoin Overload
Dundas.BI.Entities.DataCubes Namespace