Class: iHRIS Position: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_List | I2CE_List]].
*Extends the class: [[Class: I2CE_List | I2CE_List]].
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.1-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php modules/ManagePersonPosition/lib/iHRIS_Position.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php#L35 modules/ManagePersonPosition/lib/iHRIS_Position.php] on line 35
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v1.0.0
*Since: v1.0.0
Line 50: Line 50:
===closePosition()===
===closePosition()===
Mark this position as closed and remove it from any applications. The person being assigned the position will have all application positions removed.
Mark this position as closed and remove it from any applications. The person being assigned the position will have all application positions removed.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php#L68 manage/modules/ManagePersonPosition/lib/iHRIS_Position.php] on line 68
*Signature: public function closePosition($user,$person_id)
*Signature: public function closePosition($user,$person_id)
*Parameters:
*Parameters:
Line 56: Line 57:
===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.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php#L90 manage/modules/ManagePersonPosition/lib/iHRIS_Position.php] on line 90
*Signature: public function getSupervised()
*Signature: public function getSupervised()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===setStatus()===
===setStatus()===
Update the status for this position.
Update the status for this position.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php#L57 manage/modules/ManagePersonPosition/lib/iHRIS_Position.php] on line 57
*Signature: public function setStatus($status)
*Signature: public function setStatus($status)
*Parameters:
*Parameters:
Line 65: Line 68:
===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.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Position.php#L49 manage/modules/ManagePersonPosition/lib/iHRIS_Position.php] on line 49
*Signature: public function statusOnly()
*Signature: public function statusOnly()
==Inherited Methods==
==Inherited Methods==

Revision as of 09:22, 10 November 2009

This article describes the class iHRIS_Position.

@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with positions.

Form Fields

This class is a form class and provides the following form fields

code

The form field code is implemented by STRING_LINE

job

The form field job is implemented by MAP

title

The form field title is implemented by STRING_LINE

description

The form field description is implemented by STRING_MLINE

proposed_salary

The form field proposed_salary is implemented by CURRENCY

source

The form field source is implemented by MAP_MULT

supervisor

The form field supervisor is implemented by MAP

facility

The form field facility is implemented by MAP

department

The form field department is implemented by MAP

pos_type

The form field pos_type is implemented by MAP

proposed_end_date

The form field proposed_end_date is implemented by DATE_YMD

proposed_hiring_date

The form field proposed_hiring_date is implemented by DATE_YMD

posted_date

The form field posted_date is implemented by DATE_YMD

status

The form field status is implemented by MAP

comments

The form field comments is implemented by STRING_TEXT

interview_comments

The form field interview_comments is implemented by STRING_TEXT

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.

getSupervised()

Return the list of record ids that have this position as supervisor.

setStatus()

Update the status for this position.

statusOnly()

Remove all fields except for the status when only dealing with status updates.

Inherited Methods

componentizeQuery()

This public method is inherited from I2CE_List->componentizeQuery()

createDataTree()

This public method is inherited from I2CE_List->createDataTree()

flattenDataTree()

This public method is inherited from I2CE_List->flattenDataTree()

getDisplayFields()

This public method is inherited from I2CE_List->getDisplayFields()

getExtendedDisplay()

This public method is inherited from I2CE_List->getExtendedDisplay()

getHTMLTemplate()

This public method is inherited from I2CE_List->getHTMLTemplate()

getListType()

This public method is inherited from I2CE_List->getListType()

getSortFields()

This public method is inherited from I2CE_List->getSortFields()

listOptions()

This public method is inherited from I2CE_List->listOptions()

lookup()

This public method is inherited from I2CE_List->lookup()

monsterMash()

This public method is inherited from I2CE_List->monsterMash()

name()

This public method is inherited from I2CE_List->name()

setDisplayData()

This public method is inherited from I2CE_List->setDisplayData()

walkupFieldPath()

This public method is inherited from I2CE_List->walkupFieldPath()

_flattenDataTree()

This protected method is inherited from I2CE_List->_flattenDataTree()

_monsterMash()

This protected method is inherited from I2CE_List->_monsterMash()

addCache()

This protected method is inherited from I2CE_List->addCache()

getCache()

This protected method is inherited from I2CE_List->getCache()

isCached()

This protected method is inherited from I2CE_List->isCached()

__construct()

This public method is inherited from I2CE_Form->__construct()

addChildForm()

This public method is inherited from I2CE_Form->addChildForm()

addField()

This public method is inherited from I2CE_Form->addField()

cleanup()

This public method is inherited from I2CE_Form->cleanup()

clearFields()

This public method is inherited from I2CE_Form->clearFields()

current()

This public method is inherited from I2CE_Form->current()

displayField()

This public method is inherited from I2CE_Form->displayField()

form()

This public method is inherited from I2CE_Form->form()

getAllowedParentForms()

This public method is inherited from I2CE_Form->getAllowedParentForms()

getAttribute()

This public method is inherited from I2CE_Form->getAttribute()

getChildForms()

This public method is inherited from I2CE_Form->getChildForms()

getChildFormsByForm()

This public method is inherited from I2CE_Form->getChildFormsByForm()

getChildren()

This public method is inherited from I2CE_Form->getChildren()

getDisplayName()

This public method is inherited from I2CE_Form->getDisplayName()

getField()

This public method is inherited from I2CE_Form->getField()

getFieldNames()

This public method is inherited from I2CE_Form->getFieldNames()

getFormId()

This public method is inherited from I2CE_Form->getFormId()

getHTMLName()

This public method is inherited from I2CE_Form->getHTMLName()

getId()

This public method is inherited from I2CE_Form->getId()

getParent()

This public method is inherited from I2CE_Form->getParent()

getParentForm()

This public method is inherited from I2CE_Form->getParentForm()

getParentID()

This public method is inherited from I2CE_Form->getParentID()

getQueryDisplay()

This public method is inherited from I2CE_Form->getQueryDisplay()

getQueryFields()

This public method is inherited from I2CE_Form->getQueryFields()

getQueryString()

This public method is inherited from I2CE_Form->getQueryString()

hasAttribute()

This public method is inherited from I2CE_Form->hasAttribute()

hasInvalid()

This public method is inherited from I2CE_Form->hasInvalid()

key()

This public method is inherited from I2CE_Form->key()

listFields()

This public method is inherited from I2CE_Form->listFields()

load()

This public method is inherited from I2CE_Form->load()

next()

This public method is inherited from I2CE_Form->next()

processDOM()

This public method is inherited from I2CE_Form->processDOM()

removeField()

This public method is inherited from I2CE_Form->removeField()

reset()

This public method is inherited from I2CE_Form->reset()

rewind()

This public method is inherited from I2CE_Form->rewind()

search()

This public method is inherited from I2CE_Form->search()

setAttribute()

This public method is inherited from I2CE_Form->setAttribute()

setDisplayName()

This public method is inherited from I2CE_Form->setDisplayName()

setForm()

This public method is inherited from I2CE_Form->setForm()

setFromPost()

This public method is inherited from I2CE_Form->setFromPost()

setId()

This public method is inherited from I2CE_Form->setId()

setParent()

This public method is inherited from I2CE_Form->setParent()

valid()

This public method is inherited from I2CE_Form->valid()

validate()

This public method is inherited from I2CE_Form->validate()

__get()

This protected method is inherited from I2CE_Form->__get()

__isset()

This protected method is inherited from I2CE_Form->__isset()

__set()

This protected method is inherited from I2CE_Form->__set()

__unset()

This protected method is inherited from I2CE_Form->__unset()

addFormFields()

This protected method is inherited from I2CE_Form->addFormFields()

getFormFieldsData()

This protected method is inherited from I2CE_Form->getFormFieldsData()

lookupArray()

This protected method is inherited from I2CE_Form->lookupArray()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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()