PrebuildSubGroupHandler

This class contains the functions to manage Prebuild SubSubGroups

api
package simPROAPI
subpackage Materials
author Nathan Muir
version 2011-07-18

 Methods

PrebuildSubGroupInsert

Insert(int $CompanyID, int $PrebuildGroupID, string $SubGroupName) : int
Static

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PrebuildGroupID

int

the group to add the subgroup to

$SubGroupName

string

the subgroup to add

Returns

int

PrebuildSubGroupRetrieve

Retrieve(int $CompanyID, int $PrebuildSubGroupID) : array
Static

This function retrieves details for a specific details id

uses \PrebuildSubGroupHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PrebuildSubGroupID

int

the Prebuild SubGroup id to retrieve details for

Returns

array

PrebuildSubGroupRetrieveList

RetrieveList(int $CompanyID, array $PrebuildSubGroupIDs) : array
Static

This function retrieves details on the provided list of Prebuild SubGroup ids

used_by \PrebuildSubGroupHandler::Search()
used_by \PrebuildSubGroupHandler::Retrieve()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PrebuildSubGroupIDs

array

the Prebuild SubGroup ids to retrieve details for

Returns

array

PrebuildSubGroupUpdate

Update(int $CompanyID, int $PrebuildSubGroupID, string $SubGroupName) : bool
Static

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PrebuildSubGroupID

int

the prebuild subgroup id to update

$SubGroupName

string

the new subgroup name

Returns

bool