Show / Hide Table of Contents

Class HierarchyEntity

Folder structures

Carrier object for HierarchyEntity. Services for the HierarchyEntity Carrier is available from the List Agent.
Inheritance
object
HierarchyEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class HierarchyEntity : Carrier
Examples

Get HierarchyEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

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

Constructors

HierarchyEntity()

Default constructor

Declaration
public HierarchyEntity()
See Also
IListAgent

Properties

Children

Sub-items, if any.

Declaration
[DataMember]
public virtual HierarchyEntity[] Children { get; set; }
Property Value
Type Description
HierarchyEntity[]
See Also
IListAgent

Domain

Domain seperating the different hierarchy

Declaration
[DataMember]
public virtual Domain Domain { get; set; }
Property Value
Type Description
Domain
See Also
IListAgent

Fullname

The full name of this category, i.e. Foo/bar/test.

Declaration
[DataMember]
public virtual string Fullname { get; set; }
Property Value
Type Description
string
See Also
IListAgent

HierarchyId

The primary key (auto-incremented)

Declaration
[DataMember]
public virtual int HierarchyId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Name

Name of this hierarchy folder.

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
IListAgent

ParentId

Parent table

Declaration
[DataMember]
public virtual int ParentId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Registered

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
See Also
IListAgent

RegisteredAssociateId

Registered by whom

Declaration
[DataMember]
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Updated

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
See Also
IListAgent

UpdatedAssociateId

Last updated by whom

Declaration
[DataMember]
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IListAgent

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.

See Also
IListAgent

See Also

IListAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top