Package DE_EPAGES::Search::API::Object::SearchTerm
object interface for SearchTerm.
Base |
DE_EPAGES::Object::API::Object::BaseObject |
Functions
delete
Deletes this object, therefore the hook 'OBJ_DeleteSearchTerm' is triggered.
Syntax |
$SearchTerm->delete; |
Hook |
|
deleteSelf
Deletes the object at database tables.
Syntax |
$SearchTerm->deleteSelf; |
exists
Returns true if the object exists in the database.
Syntax |
$Exists = $SearchTerm->exists; |
Return |
|
exportableAttributes
Returns all attribute values that have an existing (not-null) value. Unlike $Object->_attributes this function returns localized attribute values as hash reference (language id => value).
Syntax |
$hValues = $Object->exportableAttributes |
Example |
$Description = $Object->exportableAttributes; |
Return |
|
get
Returns one or more attribute values.
Syntax |
$Value = $SearchTerm->get( $Name ); $hValues = $SearchTerm->get( $aNames ); |
Example |
$Password = $SearchTerm->get( 'Password' ); $Password = $SearchTerm->get( ['Login', 'Password'] )->{'Password'}; |
Input |
|
Return |
|
insert
Insert this info as object, afterwards the hook 'OBJ_InsertSearchTerm' is triggered.
Syntax |
$SearchTerm = DE_EPAGES::Search::API::Object::SearchTerm->insert($hInfo); |
Example |
my $Class = LoadClassByAlias('SearchTerm'); my $SearchTerm = $Class->insertObject($hInfo); |
Input |
|
Return |
|
Hook |
|
load
Loads an existing object.
Syntax |
$SearchTerm = $Package->load( $ObjectID ); |
Input |
|
Return |
|
set
This function triggers hooks 'OBJ_BeforeUpdateSearchTerm' and 'OBJ_AfterUpdateSearchTerm'.
Syntax |
$SearchTerm->set($hValues, $LanguageID); |
Hook |
|