ILIAS\OrgUnit\Webservices\SOAP\PositionTitle Class Reference

Class PositionTitle. More...

Inheritance diagram for ILIAS\OrgUnit\Webservices\SOAP\PositionTitle:

Collaboration diagram for ILIAS\OrgUnit\Webservices\SOAP\PositionTitle:

Public Member Functions
	getName ()
	getOutputParams ()
	Get the output parameters in the same format as the input parameters. More...
	getDocumentation ()
	Get the documentation of this method. More...
Public Member Functions inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
	getServiceStyle ()
	Get the service style, e.g. More...
	getServiceUse ()
	Get the service use, e.g. More...
	getServiceNamespace ()
	Get the namespace of the service where this method belongs to. More...
	getInputParams ()
	Get the input parameters. More...
	execute (array $params)
	Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name). More...
	addError (string $message)
Public Member Functions inherited from ilSoapAdministration
	__construct (bool $use_nusoap=true)
	getMessage ()
	appendMessage (string $a_str)
	setMessageCode (string $a_code)
	getMessageCode ()
	reInitUser ()
	isFault ($object)
	getInstallationInfoXML ()
	getClientInfoXML (string $clientid)
	getName ()
	Get the name of the method. More...
	getInputParams ()
	Get the input parameters. More...
	getOutputParams ()
	Get the output parameters in the same format as the input parameters. More...
	getServiceNamespace ()
	Get the namespace of the service where this method belongs to. More...
	getServiceStyle ()
	Get the service style, e.g. More...
	getServiceUse ()
	Get the service use, e.g. More...
	getDocumentation ()
	Get the documentation of this method. More...
	execute (array $params)
	Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name). More...

Data Fields
const	POSITION_ID = 'position_id'
Data Fields inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
const	TYPE_INT_ARRAY = 'tns:intArray'
const	TYPE_STRING = 'xsd:string'
const	TYPE_INT = 'xsd:int'
const	TYPE_DOUBLE_ARRAY = 'tns:doubleArray'
const	SID = 'sid'
const	ORGU_REF_ID = 'orgu_ref_id'
const	POSITION_ID = 'position_id'
const	USR_IDS = 'usr_ids'
const	USR_ID = 'usr_id'
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...

Protected Member Functions
	run (array $params)
	getAdditionalInputParams ()
Protected Member Functions inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
	initIliasAndCheckSession (string $session_id)
	Use this method at the beginning of your execute() method to check if the provided session ID is valid. More...
	checkParameters (array $params)
	Check that all input parameters are present when executing the soap method. More...
	getAdditionalInputParams ()
	run (array $params)
Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)
	explodeSid (string $sid)
	setMessage (string $a_str)
	initAuth (string $sid)
	initIlias ()
	initAuthenticationObject ()
	raiseError (string $a_message, $a_code)
	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
ilOrgUnitPositionDBRepository	$positionRepo
ilOrgUnitUserAssignmentDBRepository	$assignmentRepo
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

Class PositionTitle.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 27 of file PositionTitle.php.

Member Function Documentation

getAdditionalInputParams()

ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::getAdditionalInputParams ( )

protected

Reimplemented from ILIAS\OrgUnit\Webservices\SOAP\Base.

Definition at line 54 of file PositionTitle.php.

                                                 : array
    {
        return array(self::POSITION_ID => Base::TYPE_INT);
    }

References ILIAS\OrgUnit\Webservices\SOAP\Base\TYPE_INT.

getDocumentation()

ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::getDocumentation

(

)

Get the documentation of this method.

Returns

string

Implements ilSoapMethod.

Definition at line 64 of file PositionTitle.php.

                                      : string
    {
        return "Returns the title of a position for a given position id";
    }

getName()

ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::getName

(

)

Returns

string

Implements ilSoapMethod.

Definition at line 49 of file PositionTitle.php.

                             : string
    {
        return "getPositionTitle";
    }

getOutputParams()

ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::getOutputParams

(

)

Get the output parameters in the same format as the input parameters.

Returns

array

Implements ilSoapMethod.

Definition at line 59 of file PositionTitle.php.

                                     : array
    {
        return array('title' => Base::TYPE_STRING);
    }

References ILIAS\OrgUnit\Webservices\SOAP\Base\TYPE_STRING.

run()

ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::run ( array  $params )

protected

Exceptions

SoapFault

Reimplemented from ILIAS\OrgUnit\Webservices\SOAP\Base.

Definition at line 34 of file PositionTitle.php.

                                         : string
    {
        $position_id = $params[self::POSITION_ID];
 
        $record = $this->positionRepo->getSingle($position_id, 'id');
        if ($record instanceof ilOrgUnitPosition) {
            return $record->getTitle();
        } else {
            $this->addError("Position with id {$position_id} not found");
        }
    }

References $params, ILIAS\OrgUnit\Webservices\SOAP\Base\addError(), and ILIAS\OrgUnit\Webservices\SOAP\PositionTitle\POSITION_ID.

Here is the call graph for this function:

Field Documentation

POSITION_ID

const ILIAS\OrgUnit\Webservices\SOAP\PositionTitle::POSITION_ID = 'position_id'

Definition at line 29 of file PositionTitle.php.

Referenced by ILIAS\OrgUnit\Webservices\SOAP\PositionTitle\run().

---

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

• components/ILIAS/OrgUnit/classes/Webservices/SOAP/PositionTitle.php