Class ProjectEntity

The Project Service. The service implements all services working with the Project object

Carrier object for ProjectEntity. Services for the ProjectEntity Carrier is available from the Project Agent.
Inheritance
object
ProjectEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class ProjectEntity : Carrier, IUdefFieldCarrier, IExtraFieldCarrier, IPublishedCarrier
Examples

Get ProjectEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ProjectAgent();
   var projectEntity = agent.GetProjectEntity( 123 );
}

Find all ProjectEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindProject", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ProjectActivity", "...", null, "projectId eq 123", null, 0, 100 );
var guide = archive.GetArchiveListByColumns2("ProjectGuide", "...", null, "projectId eq 123", null, 0, 100 );
var members = archive.GetArchiveListByColumns2("ProjectMember", "...", null, "projectId eq 123", null, 0, 100 );
var contacts = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "projectId eq 123", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceProjectRestrictionId eq 123", null, 0, 100 );

Constructors

ProjectEntity()

Default constructor

Declaration
public ProjectEntity()
See Also

Properties

The number of active erp links

Declaration
[DataMember]
public virtual int ActiveErpLinks { get; set; }
Property Value
Type Description
int

Number of active links to documents, other appointments, and such

Declaration
[DataMember]
public virtual uint ActiveLinks { get; set; }
Property Value
Type Description
uint

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for project

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

Associate

The person that created the project

Use MDO List name "associate" to get list items.

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

Completed

Done (0=false, 1=true). Status implies changes in which fields are shown in GUI, as well as which fields can be updated

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

CreatedBy

The person that created the project

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

CreatedDate

Registered date in UTC.

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

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
[DataMember]
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 
'SuperOffice:1' = '[I:123]'

See Also

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

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

EndDate

Planned end date for project, inhertied from type and later editable

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

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
[DataMember]
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
See Also

HasImage

True if the project has an image. (This is the image that is displayed in the CRM client)

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

ImageDescription

Description of the project image if it exists. (This is the image that is displayed in the CRM client)

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

IsPublished

Publication is published

Declaration
[DataMember]
public bool IsPublished { get; set; }
Property Value
Type Description
bool
See Also

List of all elements linked to the project

Declaration
[DataMember]
public virtual Link[] Links { get; set; }
Property Value
Type Description
Link[]

Name

Project name

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

NextMilestoneDate

Calculated date, reflects date of closest non-complete future milestone activity

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

NmdAppointmentId

ID of appointment that "caused" the nextMilestoneDate, can be 0

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

Postit

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

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

ProjectId

Primary key

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

ProjectMembers

The persons which are members of the project

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

ProjectNumber

Automatically generated number

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

ProjectStatus

Project status is a list defined by the database administrator. Different statuses of a project may be: “In planning”, “Started”, “Finished” and so on

Use MDO List name "projectstatus" to get list items.

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

ProjectType

Project type is a list defined by the database admin. for example: 'Large', 'Small', 'Party'...

Use MDO List name "projecttype" to get list items.

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

PublishEventDate

Publish event date

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

PublishFrom

Publication valid from (inclusive)

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

PublishTo

Publication valid to (inclusive)

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

UpdatedBy

The person that last updated the project

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

UpdatedDate

Last updated date in UTC.

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

Urls

The project's internet adresses

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

UserDefinedFields

Deprecated: Use CustomFields instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Declaration
[DataMember]
public StringDictionary UserDefinedFields { get; set; }
Property Value
Type Description
StringDictionary
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
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.
See Also

Implements

See Also