ePages 6.10 - DE_EPAGES/WebInterfacePoolDB/API/Table/Store.pm

Package DE_EPAGES::WebInterfacePoolDB::API::Table::Store

interface for table Store

@EXPORT_OK
InsertStore
UpdateStore
DeleteStore
GetAllPKeyStores
GetAllInfoStores
GetInfoStore
ExistsStore
GetPKeyStoreByName
GetInfoStoreByName
ExistsStoreByName
GetPKeyStoresByName
GetInfoStoresByName
GetPKeyStoresByPoolID
GetInfoStoresByPoolID

Functions

DeleteStore
ExistsStore
ExistsStoreByName
GetAllInfoStores
GetAllPKeyStores
GetInfoStore
GetInfoStoreByName
GetInfoStoresByName
GetInfoStoresByPoolID
GetPKeyStoreByName
GetPKeyStoresByName
GetPKeyStoresByPoolID
InsertStore
UpdateStore

DeleteStore

Deletes a(n) Store.

Syntax
DeleteStore($StoreID);
DeleteStore($hStore); # if $hStore includes StoreID
Input
$StoreID (int)
store database id (primary key)

ExistsStore

Returns true if the Store exists.

Syntax
$exists = ExistsStore($StoreID);
Input
$StoreID (int)
store database id
Return
$exists (boolean)
1/0 the Store exists (yes/no)

ExistsStoreByName

Returns true if a Store by alternate key Name exists.

Syntax
$StoreID = ExistsStoreByName($Name);
Input
$Name (varchar(255))
store database alias
Return
$exists (boolean)
1/0 the u_store_name exists (yes/no)

GetAllInfoStores

Returns all objects of Store.

Syntax
$ahStores = GetAllInfoStores();
Return
$ahStores (reference to array of hashes)
with following keys:
  • StoreID - store database id (primary key)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)

GetAllPKeyStores

Returns all Store identifiers.

Syntax
$aStoreIDs = GetAllPKeyStores();
Return
$aStoreIDs (reference to array of int)
store database id

GetInfoStore

Returns the Store by identifier.

Syntax
$hStore = GetInfoStore($StoreID);
Input
$StoreID (int)
store database id (primary key)
Return
$hStore (reference to hash)
with following keys:
  • StoreID - store database id (primary key)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)

GetInfoStoreByName

Returns the object of Store by alternate key Name.

Syntax
$hStore = GetInfoStoreByName($Name);
Input
$Name (varchar(255))
store database alias
Return
$hStore (reference to hash)
with following keys:
  • StoreID - store database id (primary key)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)

GetInfoStoresByName

Returns objects of Store by alternate key Name.

Syntax
$ahStores = GetInfoStoresByName($Name);
Input
$Name (varchar(255))
store database alias
Return
$ahStores (reference to array of hashes)
with following keys:
  • StoreID - store database id (primary key)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)

GetInfoStoresByPoolID

Returns objects of Store by alternate key PoolID.

Syntax
$ahStores = GetInfoStoresByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$ahStores (reference to array of hashes)
with following keys:
  • StoreID - store database id (primary key)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)

GetPKeyStoreByName

Returns primary key of Store by alternate key Name.

Syntax
$StoreID = GetPKeyStoreByName($Name);
Input
$Name (varchar(255))
store database alias
Return
$StoreID (int)
store database id (primary key)

GetPKeyStoresByName

Returns primary keys of Store by alternate key Name.

Syntax
$aKeys = GetPKeyStoresByName($Name);
Input
$Name (varchar(255))
store database alias
Return
$aKeys (reference to array of int)
store database id (primary key)

GetPKeyStoresByPoolID

Returns primary keys of Store by alternate key PoolID.

Syntax
$aKeys = GetPKeyStoresByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$aKeys (reference to array of int)
store database id (primary key)

InsertStore

Creates an entry of Store.

Syntax
$StoreID = InsertStore($hStore);
Input
$hStore (reference to hash)
with following keys:
  • StoreID - store database id (primary key)(optional)- int
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)
Return
$StoreID (int)
store database id (primary key)

UpdateStore

Updates a(n) Store if any element was changed.

Syntax
UpdateStore($StoreID, $hStore);
UpdateStore($hStore); # if $hStore includes StoreID
Input
$StoreID (int)
store database id (primary key)
$hStore (reference to hash)
with following keys:
  • PoolID - pool id - int
  • Name - store database alias - varchar(255)