Class NSCheckoutInfo

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Syntax

Constructors

NSCheckoutInfo()

Initializes a new instance of the NSCheckoutInfo class.

Declaration

NSCheckoutInfo

Methods

GetAssociateId()

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	ID of associate who has currently checked out the document; 0 if it is not checked out, or is checked out by someone who is not a SuperOffice user.

Examples

NSCheckoutInfo thing;
Integer associateId = thing.GetAssociateId();

GetName()

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

String GetName()

Returns

Type	Description
String	Name of person who has currently checked out the document; blank if it is not checked out.

Remarks

This property may also be blank if the AssociateId is nonzero; NetServer will retrieve the associates' name as needed.

Examples

NSCheckoutInfo thing;
String name = thing.GetName();

GetState()

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

Integer GetState()

Returns

Type	Description
Integer	The checkout state. See CheckoutState

Examples

NSCheckoutInfo thing;
Integer state = thing.GetState();

SetAssociateId(Integer)

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	ID of associate who has currently checked out the document; 0 if it is not checked out, or is checked out by someone who is not a SuperOffice user.

Returns

Type	Description
Void

Examples

NSCheckoutInfo thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetName(String)

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Name of person who has currently checked out the document; blank if it is not checked out.

Returns

Type	Description
Void

Remarks

This property may also be blank if the AssociateId is nonzero; NetServer will retrieve the associates' name as needed.

Examples

NSCheckoutInfo thing;
String name;
thing.SetName(name);

SetState(Integer)

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

Declaration

Void SetState(Integer state)

Parameters

Type	Name	Description
Integer	state	Checkout state. See CheckoutState.

Returns

Type	Description
Void

Examples

NSCheckoutInfo thing;
Integer state;
thing.SetState(state);