Class: iHRIS Position: Difference between revisions
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
==Methods== | ==Methods== | ||
===closePosition()=== | ===closePosition()=== | ||
Mark this position as closed and remove it from any applications. | Mark this position as closed and remove it from any applications. The person being assigned the position will have all application positions removed. | ||
The person being assigned the position will have all application positions removed. | |||
*Signature: public function closePosition($user,$person_id) | *Signature: public function closePosition($user,$person_id) | ||
Parameters: | *Parameters: | ||
* [[Class: I2CE_User | I2CE_User]] &$user<br/>The user performing this action. | ** [[Class: I2CE_User | I2CE_User]] &$user <br/>The user performing this action. | ||
* integer $person_id<br/>The person being assigned this position. | ** integer $person_id <br/>The person being assigned this position. | ||
===getSupervised()=== | ===getSupervised()=== | ||
Return the list of record ids that have this position as supervisor. | Return the list of record ids that have this position as supervisor. | ||
| Line 29: | Line 27: | ||
Update the status for this position. | Update the status for this position. | ||
*Signature: public function setStatus($status) | *Signature: public function setStatus($status) | ||
Parameters: | *Parameters: | ||
* integer $status | ** integer $status | ||
===statusOnly()=== | ===statusOnly()=== | ||
Remove all fields except for the status when only dealing with status updates. | Remove all fields except for the status when only dealing with status updates. | ||
Revision as of 23:42, 16 October 2009
This article desrcibes the class iHRIS_Position.
- Extends the class: I2CE_List.
- Location: Part of the module ihris-manage-PersonPosition in the package iHRIS Manage
- Source: Defined in the file modules/ManagePersonPosition/lib/iHRIS_Position.php
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v1.0.0
@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with positions.
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:
- I2CE_User &$user
The user performing this action. - integer $person_id
The person being assigned this position.
- I2CE_User &$user
getSupervised()
Return the list of record ids that have this position as supervisor.
- Signature: public function getSupervised()
- Returns: 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 I2CE_List->$cache
$children
Theis public variable is inherited from I2CE_Form->$children
$fields
Theis protected variable is inherited from I2CE_Form->$fields
$parent
Theis protected variable is inherited from I2CE_Form->$parent
$id
Theis protected variable is inherited from I2CE_Form->$id
$attributes
Theis protected variable is inherited from I2CE_Form->$attributes
$parent_forms
Theis protected variable is inherited from I2CE_Form->$parent_forms
Inherited Fuzzy Methods
isNumeric()
This method is inherited from I2CE_Form->isNumeric()
getLimitStyles()
This method is inherited from I2CE_Form->getLimitStyles()
checkLimit()
This method is inherited from I2CE_Form->checkLimit()
checkWhereClause()
This method is inherited from I2CE_Form->checkWhereClause()
createCheckFunction()
This method is inherited from I2CE_Form->createCheckFunction()
createCheckLimitString()
This method is inherited from I2CE_Form->createCheckLimitString()
generateLimit()
This method is inherited from I2CE_Form->generateLimit()
generateWhereClause()
This method is inherited from I2CE_Form->generateWhereClause()
processLimit()
This method is inherited from I2CE_Form->processLimit()
getDisplayedExistingLimit()
This method is inherited from I2CE_Form->getDisplayedExistingLimit()
isComponentized()
This method is inherited from I2CE_Form->isComponentized()
addChild()
This method is inherited from I2CE_Form->addChild()
getChildIds()
This method is inherited from I2CE_Form->getChildIds()
getStorage()
This method is inherited from I2CE_Form->getStorage()
isWritable()
This method is inherited from I2CE_Form->isWritable()
populate()
This method is inherited from I2CE_Form->populate()
populateChild()
This method is inherited from I2CE_Form->populateChild()
populateChildren()
This method is inherited from I2CE_Form->populateChildren()
populateFirst()
This method is inherited from I2CE_Form->populateFirst()
populateHistory()
This method is inherited from I2CE_Form->populateHistory()
populateLast()
This method is inherited from I2CE_Form->populateLast()
delete()
This method is inherited from I2CE_Form->delete()
save()
This method is inherited from I2CE_Form->save()
setChangeType()
This method is inherited from I2CE_Form->setChangeType()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
