dolibarr 20.0.0
mod_recruitmentjobposition_standard Class Reference

Class to manage the Standard numbering rule for Job positions. More...

Inheritance diagram for mod_recruitmentjobposition_standard:
Collaboration diagram for mod_recruitmentjobposition_standard:

Public Member Functions

 info ($langs)
 Return description of numbering module.
 
 getExample ()
 Return an example of numbering.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getNextValue ($object)
 Return next free value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name.
 
 getName ($langs)
 Return model name.
 
 isEnabled ()
 Return if a module can be used or not.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage the Standard numbering rule for Job positions.

Definition at line 33 of file mod_recruitmentjobposition_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_recruitmentjobposition_standard::canBeActivated ( $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 84 of file mod_recruitmentjobposition_standard.php.

References $object.

◆ getExample()

mod_recruitmentjobposition_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 71 of file mod_recruitmentjobposition_standard.php.

◆ getNextValue()

mod_recruitmentjobposition_standard::getNextValue ( $object)

Return next free value.

Parameters
RecruitmentJobPosition$objectObject we need next value for
Returns
string|-1 Next value if OK, -1 if KO

Definition at line 124 of file mod_recruitmentjobposition_standard.php.

References $object, dol_print_date(), and dol_syslog().

◆ info()

mod_recruitmentjobposition_standard::info ( $langs)

Return description of numbering module.

Parameters
Translate$langsLanguage
Returns
string Text with description

Reimplemented from CommonNumRefGenerator.

Definition at line 60 of file mod_recruitmentjobposition_standard.php.


The documentation for this class was generated from the following file: