CatalogGroupHandler

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

 Methods

CatalogGroupInsert

Insert(int $CompanyID, string $GroupName) : int
Static

This function creates a new Catalog Group

Parameters

$CompanyID

int

the company id

$GroupName

string

the group to add

Returns

int

CatalogGroupRetrieve

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

This function retrieves details for a specific details id

uses \CatalogGroupHandler::RetrieveList()

Parameters

$CompanyID

int

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

$CatalogGroupID

int

the Catalog Group id to retrieve details for

Returns

array

CatalogGroupRetrieveList

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

This function retrieves details on the provided list of Catalog Group ids

used_by \CatalogGroupHandler::Search()
used_by \CatalogGroupHandler::Retrieve()

Parameters

$CompanyID

int

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

$CatalogGroupIDs

array

the Catalog Group ids to retrieve details for

Returns

array

CatalogGroupUpdate

Update(int $CompanyID, int $CatalogGroupID, string $GroupName) : bool
Static

Parameters

$CompanyID

int

the company id

$CatalogGroupID

int

the catalog group id to update

$GroupName

string

the new group name

Returns

bool