Show / Hide Table of Contents

Class NSBlobEntity

Carrier object for BlobEntity.

Syntax

Constructors

NSBlobEntity()

Initializes a new instance of the NSBlobEntity class.

Declaration
NSBlobEntity

Methods

GetBlobId()

Carrier object for BlobEntity.

Declaration
Integer GetBlobId()
Returns
Type Description
Integer

Primary key.

Examples
NSBlobEntity thing;
Integer blobId = thing.GetBlobId();

GetBlobSize()

Carrier object for BlobEntity.

Declaration
Integer GetBlobSize()
Returns
Type Description
Integer

The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself!

Examples
NSBlobEntity thing;
Integer blobSize = thing.GetBlobSize();

GetConceptualType()

Carrier object for BlobEntity.

Declaration
String GetConceptualType()
Returns
Type Description
String

The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is.

Examples
NSBlobEntity thing;
String conceptualType = thing.GetConceptualType();

GetCreatedBy()

Carrier object for BlobEntity.

Declaration
NSAssociate GetCreatedBy()
Returns
Type Description
NSAssociate

The person that first created the document. The property is read-only.

Examples
NSBlobEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCreatedDate()

Carrier object for BlobEntity.

Declaration
DateTime GetCreatedDate()
Returns
Type Description
DateTime

Registered when.

Examples
NSBlobEntity thing;
DateTime createdDate = thing.GetCreatedDate();

GetDescription()

Carrier object for BlobEntity.

Declaration
String GetDescription()
Returns
Type Description
String

A description that is entered by the user, and visible to the user.

Examples
NSBlobEntity thing;
String description = thing.GetDescription();

GetExtraInfo()

Carrier object for BlobEntity.

Declaration
String GetExtraInfo()
Returns
Type Description
String

Extra information, spare field, can be used for anything that makes sense.

Remarks

Should not refer to any particular context, that is something for the BinaryObjectLInk

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

GetIsEncrypted()

Carrier object for BlobEntity.

Declaration
Bool GetIsEncrypted()
Returns
Type Description
Bool

Has the data been encrypted?

Examples
NSBlobEntity thing;
Bool isEncrypted = thing.GetIsEncrypted();

GetIsZipped()

Carrier object for BlobEntity.

Declaration
Bool GetIsZipped()
Returns
Type Description
Bool

Has the data been zipped?

Examples
NSBlobEntity thing;
Bool isZipped = thing.GetIsZipped();

GetMimeType()

Carrier object for BlobEntity.

Declaration
String GetMimeType()
Returns
Type Description
String

Mime type, describing the technical type (image/jpeg) of the data.

Examples
NSBlobEntity thing;
String mimeType = thing.GetMimeType();

GetOriginalSize()

Carrier object for BlobEntity.

Declaration
Integer GetOriginalSize()
Returns
Type Description
Integer

Original size of the binary data, before encryption and/or zipping.

Remarks

This is what the ultimate client will get

Examples
NSBlobEntity thing;
Integer originalSize = thing.GetOriginalSize();

GetUpdatedBy()

Carrier object for BlobEntity.

Declaration
NSAssociate GetUpdatedBy()
Returns
Type Description
NSAssociate

The person that last updated the appointment.

Examples
NSBlobEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

Carrier object for BlobEntity.

Declaration
DateTime GetUpdatedDate()
Returns
Type Description
DateTime

Last updated when.

Examples
NSBlobEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

SetBlobId(Integer)

Carrier object for BlobEntity.

Declaration
Void SetBlobId(Integer blobId)
Parameters
Type Name Description
Integer blobId

Primary key.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
Integer blobId;
thing.SetBlobId(blobId);

SetBlobSize(Integer)

Carrier object for BlobEntity.

Declaration
Void SetBlobSize(Integer blobSize)
Parameters
Type Name Description
Integer blobSize

The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself!

Returns
Type Description
Void
Examples
NSBlobEntity thing;
Integer blobSize;
thing.SetBlobSize(blobSize);

SetConceptualType(String)

Carrier object for BlobEntity.

Declaration
Void SetConceptualType(String conceptualType)
Parameters
Type Name Description
String conceptualType

The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
String conceptualType;
thing.SetConceptualType(conceptualType);

SetCreatedBy(NSAssociate)

Carrier object for BlobEntity.

Declaration
Void SetCreatedBy(NSAssociate createdBy)
Parameters
Type Name Description
NSAssociate createdBy

The person that first created the document. The property is read-only.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

Carrier object for BlobEntity.

Declaration
Void SetCreatedDate(DateTime createdDate)
Parameters
Type Name Description
DateTime createdDate

Registered when.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

SetDescription(String)

Carrier object for BlobEntity.

Declaration
Void SetDescription(String description)
Parameters
Type Name Description
String description

A description that is entered by the user, and visible to the user.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
String description;
thing.SetDescription(description);

SetExtraInfo(String)

Carrier object for BlobEntity.

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

Extra information, spare field, can be used for anything that makes sense. Should not refer to any particular context, that is something for the BinaryObjectLInk.

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

SetIsEncrypted(Bool)

Carrier object for BlobEntity.

Declaration
Void SetIsEncrypted(Bool isEncrypted)
Parameters
Type Name Description
Bool isEncrypted

Has the data been encrypted?

Returns
Type Description
Void
Examples
NSBlobEntity thing;
Bool isEncrypted;
thing.SetIsEncrypted(isEncrypted);

SetIsZipped(Bool)

Carrier object for BlobEntity.

Declaration
Void SetIsZipped(Bool isZipped)
Parameters
Type Name Description
Bool isZipped

Has the data been zipped?

Returns
Type Description
Void
Examples
NSBlobEntity thing;
Bool isZipped;
thing.SetIsZipped(isZipped);

SetMimeType(String)

Carrier object for BlobEntity.

Declaration
Void SetMimeType(String mimeType)
Parameters
Type Name Description
String mimeType

Mime type, describing the technical type (image/jpeg) of the data.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
String mimeType;
thing.SetMimeType(mimeType);

SetOriginalSize(Integer)

Carrier object for BlobEntity.

Declaration
Void SetOriginalSize(Integer originalSize)
Parameters
Type Name Description
Integer originalSize

Original size of the binary data, before encryption and/or zipping. This is what the ultimate client will get.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
Integer originalSize;
thing.SetOriginalSize(originalSize);

SetUpdatedBy(NSAssociate)

Carrier object for BlobEntity.

Declaration
Void SetUpdatedBy(NSAssociate updatedBy)
Parameters
Type Name Description
NSAssociate updatedBy

The person that last updated the appointment.

Returns
Type Description
Void
Examples
NSBlobEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

Carrier object for BlobEntity.

Declaration
Void SetUpdatedDate(DateTime updatedDate)
Parameters
Type Name Description
DateTime updatedDate

Last updated when.

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