Class RelationDefinitionEntity

A relation definition entity with source and destination tables

Carrier object for RelationDefinitionEntity. Services for the RelationDefinitionEntity Carrier is available from the IListAgent.
Inheritance
Object
RelationDefinitionEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class RelationDefinitionEntity : Carrier
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }

Constructors

RelationDefinitionEntity()

Default constructor

Declaration
public RelationDefinitionEntity()
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Properties

Deleted

True if deleted

Declaration
public virtual bool Deleted { get; set; }
Property Value
Type Description
Boolean
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Destination

The destination of the relation

Declaration
public virtual RelationTarget Destination { get; set; }
Property Value
Type Description
RelationTarget
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Name

Active text

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

PassiveText

Text used in passive direction

Declaration
public virtual string PassiveText { get; set; }
Property Value
Type Description
String
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Rank

Rank order

Declaration
public virtual short Rank { get; set; }
Property Value
Type Description
Int16
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

ReldefId

Primary key

Declaration
public virtual int ReldefId { get; set; }
Property Value
Type Description
Int32
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Source

The source of the relation

Declaration
public virtual RelationTarget Source { get; set; }
Property Value
Type Description
RelationTarget
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Tooltip

Tooltip or other description

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get RelationDefinitionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var relationDefinitionEntity = agent.GetRelationDefinitionEntity( 123 );
 }
See Also

See Also