ePages 6.11.0 - DE_EPAGES/Search/API/Table/SearchParameter.pm

Package DE_EPAGES::Search::API::Table::SearchParameter

interface for table SearchParameter

@EXPORT_OK
InsertSearchParameter
UpdateSearchParameter
DeleteSearchParameter
GetAllPKeySearchParameters
GetAllInfoSearchParameters
GetInfoSearchParameter
ExistsSearchParameter
GetPKeySearchParameterBySearchDefinitionID
GetInfoSearchParameterBySearchDefinitionID
ExistsSearchParameterBySearchDefinitionID
GetPKeySearchParametersBySearchDefinitionID
GetInfoSearchParametersBySearchDefinitionID

Functions

DeleteSearchParameter
ExistsSearchParameter
ExistsSearchParameterBySearchDefinitionID
GetAllInfoSearchParameters
GetAllPKeySearchParameters
GetInfoSearchParameter
GetInfoSearchParameterBySearchDefinitionID
GetInfoSearchParametersBySearchDefinitionID
GetPKeySearchParameterBySearchDefinitionID
GetPKeySearchParametersBySearchDefinitionID
InsertSearchParameter
UpdateSearchParameter

DeleteSearchParameter

Deletes a(n) SearchParameter.

Syntax
DeleteSearchParameter($SearchParameterID);
DeleteSearchParameter($hSearchParameter); # if $hSearchParameter includes SearchParameterID
Input
$SearchParameterID (int)
search parameter id (primary key)

ExistsSearchParameter

Returns true if the SearchParameter exists.

Syntax
$exists = ExistsSearchParameter($SearchParameterID);
Input
$SearchParameterID (int)
search parameter id
Return
$exists (boolean)
1/0 the SearchParameter exists (yes/no)

ExistsSearchParameterBySearchDefinitionID

Returns true if a SearchParameter by alternate keys SearchDefinitionID and Position exists.

Syntax
$SearchParameterID = ExistsSearchParameterBySearchDefinitionID($SearchDefinitionID, $Position);
Input
$SearchDefinitionID (int)
search definition id
$Position (int)
position of where clause
Return
$exists (boolean)
1/0 the u_searchparameter exists (yes/no)

GetAllInfoSearchParameters

Returns all objects of SearchParameter.

Syntax
$ahSearchParameters = GetAllInfoSearchParameters();
Return
$ahSearchParameters (reference to array of hashes)
with following keys:
  • SearchParameterID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text

GetAllPKeySearchParameters

Returns all SearchParameter identifiers.

Syntax
$aSearchParameterIDs = GetAllPKeySearchParameters();
Return
$aSearchParameterIDs (reference to array of int)
search parameter id

GetInfoSearchParameter

Returns the SearchParameter by identifier.

Syntax
$hSearchParameter = GetInfoSearchParameter($SearchParameterID);
Input
$SearchParameterID (int)
search parameter id (primary key)
Return
$hSearchParameter (reference to hash)
with following keys:
  • SearchParameterID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text

GetInfoSearchParameterBySearchDefinitionID

Returns the object of SearchParameter by alternate keys SearchDefinitionID and Position.

Syntax
$hSearchParameter = GetInfoSearchParameterBySearchDefinitionID($SearchDefinitionID, $Position);
Input
$SearchDefinitionID (int)
search definition id
$Position (int)
position of where clause
Return
$hSearchParameter (reference to hash)
with following keys:
  • SearchParameterID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text

GetInfoSearchParametersBySearchDefinitionID

Returns objects of SearchParameter by alternate keys SearchDefinitionID and Position.

Syntax
$ahSearchParameters = GetInfoSearchParametersBySearchDefinitionID($SearchDefinitionID, $Position);
Input
$SearchDefinitionID (int)
search definition id
$Position (int)
position of where clause (optional)
Return
$ahSearchParameters (reference to array of hashes)
with following keys:
  • SearchParameterID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text

GetPKeySearchParameterBySearchDefinitionID

Returns primary key of SearchParameter by alternate keys SearchDefinitionID and Position.

Syntax
$SearchParameterID = GetPKeySearchParameterBySearchDefinitionID($SearchDefinitionID, $Position);
Input
$SearchDefinitionID (int)
search definition id
$Position (int)
position of where clause
Return
$SearchParameterID (int)
search parameter id (primary key)

GetPKeySearchParametersBySearchDefinitionID

Returns primary keys of SearchParameter by alternate keys SearchDefinitionID and Position.

Syntax
$aKeys = GetPKeySearchParametersBySearchDefinitionID($SearchDefinitionID, $Position);
Input
$SearchDefinitionID (int)
search definition id
$Position (int)
position of where clause (optional)
Return
$aKeys (reference to array of int)
search parameter id (primary key)

InsertSearchParameter

Creates an entry of SearchParameter.

Syntax
$SearchParameterID = InsertSearchParameter($hSearchParameter);
Input
$hSearchParameter (reference to hash)
with following keys:
  • SearchParameterID - search parameter id (primary key)(optional)- int
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text
Return
$SearchParameterID (int)
search parameter id (primary key)

UpdateSearchParameter

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

Syntax
UpdateSearchParameter($SearchParameterID, $hSearchParameter);
UpdateSearchParameter($hSearchParameter); # if $hSearchParameter includes SearchParameterID
Input
$SearchParameterID (int)
search parameter id (primary key)
$hSearchParameter (reference to hash)
with following keys:
  • SearchDefinitionID - search definition id - int
  • Position - position of where clause - int
  • Parameter - name of search parameter - varchar(255)
  • ColumnName - column name in table (optional)- varchar(30)
  • DefaultValue - default value (optional)- varchar(255)
  • DefaultOperator - =,like, in ('in' has special replacement) (optional)- varchar(30)
  • WherePart - pre/built where part of parameter line (optional)- text
Return
1 (int)
1