dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_recruitmentcandidature_standard Class Reference

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

Inheritance diagram for mod_recruitmentcandidature_standard:
Inheritance graph
[legend]
Collaboration diagram for mod_recruitmentcandidature_standard:
Collaboration graph
[legend]

Public Member Functions

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

Detailed Description

Class to manage the Standard numbering rule for Job application.

Definition at line 33 of file mod_recruitmentcandidature_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_recruitmentcandidature_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_recruitmentcandidature_standard.php.

◆ getExample()

mod_recruitmentcandidature_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 71 of file mod_recruitmentcandidature_standard.php.

◆ getNextValue()

mod_recruitmentcandidature_standard::getNextValue (   $object)

Return next free value.

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

Definition at line 124 of file mod_recruitmentcandidature_standard.php.

◆ info()

mod_recruitmentcandidature_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_recruitmentcandidature_standard.php.


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