Class: iHRIS Position: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: iHRIS Position (4.1.7))
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''iHRIS_Position'''which extends the class [[Class: I2CE_List | I2CE_List]]
#REDIRECT [[Class: iHRIS_Position (4.1.7)]]
It is contained in the module [[iHRIS Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.0-release/files/head:modules/ManagePersonPosition/lib/iHRIS_Position.php modules/ManagePersonPosition/lib/iHRIS_Position.php]
@subpackage Manage
@author Luke Duncan <lduncan@intrahealth.org>
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.
@since v1.0.0
@version v2.0.0
Object for dealing with positions.
 
@package iHRIS
@subpackage Manage
@access public
==Constants==
===iHRIS_Position::MAIN_FIELD===
The main field name used for display a description of a record.
Defined as: "code"
===iHRIS_Position::SEC_FIELD===
The secondary field name used for displaying a description of a record in combination with the MAIN_FIELD.
Defined as: "title"
==Methods==
===closePosition()===
Mark this position as closed and remove it from any applications.
 
The person being assigned the position will have all application positions removed.
*Signature: public function closePosition($user,$person_id)
Parameters:
* [[Class: I2CE_User | I2CE_User]] &$user<br/>The user performing this action.
* integer $person_id<br/>The person being assigned this position.
===getSupervised()===
Return the list of record ids that have this position as supervisor.
*Signature: public function getSupervised()
*Returns: [http://www.php.net/manual/en/language.types.array.php array]
===setStatus()===
Update the status for this position.
*Signature: public function setStatus($status)
Parameters:
* integer $status
===statusOnly()===
Remove all fields except for the status when only dealing with status updates.
*Signature: public function statusOnly()
==Inherited Variables==
===$cache===
Theis protected variable is inherited from [[Class: I2CE_List#$cache | I2CE_List->$cache]]
 
===$children===
Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
 
===$fields===
Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
 
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
 
===$id===
Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
 
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
 
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
==Inherited Fuzzy Methods==
===isNumeric()===
This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]
 
===getLimitStyles()===
This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
 
===checkLimit()===
This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
 
===checkWhereClause()===
This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
 
===createCheckFunction()===
This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
 
===createCheckLimitString()===
This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
 
===generateLimit()===
This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
 
===generateWhereClause()===
This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
 
===processLimit()===
This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
 
===getDisplayedExistingLimit()===
This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
 
===isComponentized()===
This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
 
===addChild()===
This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
 
===getChildIds()===
This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
 
===getStorage()===
This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
 
===isWritable()===
This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
 
===populate()===
This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
 
===populateChild()===
This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
 
===populateChildren()===
This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
 
===populateFirst()===
This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
 
===populateHistory()===
This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
 
===populateLast()===
This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
 
===delete()===
This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
 
===save()===
This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
 
===setChangeType()===
This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:08, 23 August 2013