Show / Hide Table of Contents

Class NSFavourite

Favourite carrier.

Syntax

Constructors

NSFavourite()

Initializes a new instance of the NSFavourite class.

Declaration
NSFavourite

Methods

GetAssociateId()

Favourite carrier.

Declaration
Integer GetAssociateId()
Returns
Type Description
Integer

ID of the associate this favorite belongs to.

Examples
NSFavourite thing;
Integer associateId = thing.GetAssociateId();

GetExtraInfo()

Favourite carrier.

Declaration
String GetExtraInfo()
Returns
Type Description
String

Extra information for this favorite.

Examples
NSFavourite thing;
String extraInfo = thing.GetExtraInfo();

GetRank()

Favourite carrier.

Declaration
Integer GetRank()
Returns
Type Description
Integer

Rank order.

Examples
NSFavourite thing;
Integer rank = thing.GetRank();

GetRecordId()

Favourite carrier.

Declaration
Integer GetRecordId()
Returns
Type Description
Integer

ID of the record this favorite belongs to.

Examples
NSFavourite thing;
Integer recordId = thing.GetRecordId();

GetTableName()

Favourite carrier.

Declaration
String GetTableName()
Returns
Type Description
String

Name of the table this favorite belongs to.

Examples
NSFavourite thing;
String tableName = thing.GetTableName();

SetAssociateId(Integer)

Favourite carrier.

Declaration
Void SetAssociateId(Integer associateId)
Parameters
Type Name Description
Integer associateId

ID of the associate this favorite belongs to.

Returns
Type Description
Void
Examples
NSFavourite thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetExtraInfo(String)

Favourite carrier.

Declaration
Void SetExtraInfo(String extraInfo)
Parameters
Type Name Description
String extraInfo

Extra information for this favorite.

Returns
Type Description
Void
Examples
NSFavourite thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);

SetRank(Integer)

Favourite carrier.

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

Rank order.

Returns
Type Description
Void
Examples
NSFavourite thing;
Integer rank;
thing.SetRank(rank);

SetRecordId(Integer)

Favourite carrier.

Declaration
Void SetRecordId(Integer recordId)
Parameters
Type Name Description
Integer recordId

ID of the record this favorite belongs to.

Returns
Type Description
Void
Examples
NSFavourite thing;
Integer recordId;
thing.SetRecordId(recordId);

SetTableName(String)

Favourite carrier.

Declaration
Void SetTableName(String tableName)
Parameters
Type Name Description
String tableName

Name of the table this favorite belongs to.

Returns
Type Description
Void
Examples
NSFavourite thing;
String tableName;
thing.SetTableName(tableName);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top