Partition Class

This object represents a Partition.

When developing Form scripts (in the various callback methods such as BP_Event), you are automatically given an instance of the “current” Partition with the CurrentPartition variable.

Properties

PROPERTY NAME

 DATA TYPE

DESCRIPTION

PID

 String

The internal Partition ID

Name

 String

The name of this partition

Description

 String

The description of this partition

Methods

Link

This API will create a folder structure in a Partition

Parameters

PathName: The complete path of the folder structure to create.

Returns

Folder: The folder object created.

Example

var NewFolder = CurrentPartition.CreateFolder("/folder1/folder2");

Link

This API will return a list of DataSource objects.

Parameters

none

Returns

List< DataSource>: A list of DataSource objects.

Example

var DataSources = CurrentPartition.GetDataSources();

Link

This API will get a partition from either a name or ID. This is an overloaded method with the following possible declarations:

public static string GetPartitionID(bp BP, string PID)

public static Partition GetPartition(bp BP, string PartitionID)

public static Partition GetPartitionByID(bp BP, string PartitionID)

Parameters

BP: The bp environment.

PartitionID: The Name or ID of the partition to retrieve.

PID: String partition ID of the partition to retrieve.

Returns

Partition: Will return null if partition isn't found.

Example

var oPartition = Partition.GetPartition(bp, "PID");

Link

This API will get a partition object from the specified ID.

Parameters

BP: The bp environment.

PID: The ID of the partition to retrieve.

Returns

Partition: Will return null if partition isn't found.

Example

// Normally not used directly
var oPartition = Partition.GetPartitionByID(bp, "PID");

Link

This API will get a partition object from the specified Partition Name.

Parameters

BP: The bp environment.

PartitionName: The ID of the partition to retrieve.

Returns

Partition: Will return null if partition isn't found.

Example

var oPartition = Partition.GetPartitionByName(bp, "PartitionName");

Link

This API will get a partition ID from the specified Partition Name.

Parameters

BP: The bp environment.

PID: The Name or ID of the partition to retrieve.

Returns

String: The ID of the Partition or “” if not found.

Example

Var oPID = Partition.GetPartitionID(bp, "PartitionName");

Link

This API will return the ContentObject of the root folder for the partition

Parameters

none

Returns

ContentObject: The root folder ContentObject or null if the operation fails.

Example

var RootFolder = CurrentPartition.GetRootFolder();