fnd0qualification.h File Reference

#include <unidefs.h>
#include <Fnd0qualification/libfnd0qualification_exports.h>
#include <Fnd0qualification/libfnd0qualification_undef.h>

Go to the source code of this file.

Data Structures
struct	FND0QUALIFICATION_assign_qualification_info_t
struct	FND0QUALIFICATION_manage_qualification_info_t
struct	FND0QUALIFICATION_remove_qualification_info_t

Macros
#define	FND0CREATEQUALIFICATION_CONDITION   "Fnd0CanCreateQualification"
#define	FND0ISEXPIRYDATEREQUIRED_ATTR   "fnd0IsExpiryDateRequired"
#define	FND0LEVELACHIEVED_ATTR   "fnd0LevelAchieved"
#define	FND0LEVELREQD_ATTR   "fnd0LevelReqd"
#define	FND0LEVELS_ATTR   "fnd0Levels"
#define	FND0QUALACHIEVEDDATE_ATTR   "fnd0QualAchievedDate"
#define	FND0QUALEXPIRATIONDATE_ATTR   "fnd0QualExpirationDate"
#define	FND0REQDQUAL_REL   "Fnd0ReqdQual"
#define	FND0USERHASQUAL_REL   "Fnd0UserHasQual"
#define	OBJECTDESCRIPTION_ATTR   "object_desc"
#define	OBJECTNAME_ATTR   "object_name"
#define	PRIMARYOBJECT_ATTR   "primary_object"
#define	RELATIONTYPE_ATTR   "relation_type"
#define	SECONDARYOBJECT_ATTR   "secondary_object"

Functions
FND0QUALIFICATION_API int	FND0QUALIFICATION_append_qualification_level (tag_t qualification_tag, const char *const qualification_level)
FND0QUALIFICATION_API int	FND0QUALIFICATION_assign_user_qualification (const FND0QUALIFICATION_assign_qualification_info_t *assign_user_qualification_info, tag_t *added_user_qualification_relation)
FND0QUALIFICATION_API int	FND0QUALIFICATION_create_qualification (const FND0QUALIFICATION_manage_qualification_info_t *manage_qualification_info, tag_t *created_qualification)
FND0QUALIFICATION_API int	FND0QUALIFICATION_init_module ()
FND0QUALIFICATION_API int	FND0QUALIFICATION_remove_qualification_level (tag_t qualification_tag, const char *const qualification_level)
FND0QUALIFICATION_API int	FND0QUALIFICATION_remove_user_qualification (const FND0QUALIFICATION_remove_qualification_info_t *remove_user_qualification_info, tag_t *removed_user_qualification_relation)
FND0QUALIFICATION_API int	FND0QUALIFICATION_update_qualification (tag_t qualification_tag, const FND0QUALIFICATION_manage_qualification_info_t *qualification_info)

Detailed Description

This header file declares all data types and constants to be used by clients of Fnd0Qualification module.

The ITK fnd0qualification functions include:

• A function to create qualification
• A function to assign qualification to user
• A function to remove qualification from user
• A function to append qualification level
• A function to remove qualification level
• A function to update qualification

To use these functions, include fnd0qualification.h.

Definition in file fnd0qualification.h.

Macro Definition Documentation

#define FND0CREATEQUALIFICATION_CONDITION   "Fnd0CanCreateQualification"

The condition name which is used to validate create access.

Definition at line 73 of file fnd0qualification.h.

#define FND0ISEXPIRYDATEREQUIRED_ATTR   "fnd0IsExpiryDateRequired"

fnd0IsExpiryDateRequired property on Fnd0Qualification. This indicates whenther expiration date needs to be defined while assigning Fnd0Qualification to User

Definition at line 43 of file fnd0qualification.h.

#define FND0LEVELACHIEVED_ATTR   "fnd0LevelAchieved"

fnd0LevelAchieved property on Fnd0UserHasQual.

Definition at line 58 of file fnd0qualification.h.

#define FND0LEVELREQD_ATTR   "fnd0LevelReqd"

fnd0LevelReqd property on Fnd0ReqdQual Relation.

Definition at line 76 of file fnd0qualification.h.

#define FND0LEVELS_ATTR   "fnd0Levels"

fnd0Levels property on Fnd0Qualification. This represents ordered list of levels

Definition at line 46 of file fnd0qualification.h.

#define FND0QUALACHIEVEDDATE_ATTR   "fnd0QualAchievedDate"

fnd0QualAchievedDate property on Fnd0UserHasQual

Definition at line 61 of file fnd0qualification.h.

#define FND0QUALEXPIRATIONDATE_ATTR   "fnd0QualExpirationDate"

fnd0QualExpirationDate property on Fnd0UserHasQual

Definition at line 64 of file fnd0qualification.h.

#define FND0REQDQUAL_REL   "Fnd0ReqdQual"

Relation type name through which Job Activity is related to Fnd0Qualification.

Definition at line 70 of file fnd0qualification.h.

#define FND0USERHASQUAL_REL   "Fnd0UserHasQual"

Relation type name through which User is assigned to Fnd0Qualification.

Definition at line 67 of file fnd0qualification.h.

#define OBJECTDESCRIPTION_ATTR   "object_desc"

object_desc property on Fnd0Qualification

Definition at line 40 of file fnd0qualification.h.

#define OBJECTNAME_ATTR   "object_name"

object_name property on Fnd0Qualification

Definition at line 37 of file fnd0qualification.h.

#define PRIMARYOBJECT_ATTR   "primary_object"

primary_object property on ImanRelation.

Definition at line 49 of file fnd0qualification.h.

#define RELATIONTYPE_ATTR   "relation_type"

secondary_object property on ImanRelation.

Definition at line 55 of file fnd0qualification.h.

#define SECONDARYOBJECT_ATTR   "secondary_object"

secondary_object property on ImanRelation.

Definition at line 52 of file fnd0qualification.h.

Function Documentation

FND0QUALIFICATION_API int FND0QUALIFICATION_append_qualification_level	(	tag_t	qualification_tag,
		const char *const	qualification_level
	)

Appends a level to the qualification object.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_level_already_exists_fail error if same level is already in qualification.

Parameters

qualification_tag	(I) Tag of the Qualification object to append new level
qualification_level	(I) The new level that needs to be appended to the Qualification's list of levels

FND0QUALIFICATION_API int FND0QUALIFICATION_assign_user_qualification	(	const FND0QUALIFICATION_assign_qualification_info_t *	assign_user_qualification_info,
		tag_t *	added_user_qualification_relation
	)

Assigns a qualification to a user with the specified qualification level.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_assign_user_qualfication_permission_fail error if user is not privileged to assign user qualification.
• FND0QUALIFICATION_invalid_effective_or_expiration_date_fail error if invalid expiration or effective date is provided.
• FND0QUALIFICATION_effective_date_greater_fail error if expiration date is less than effective date.
• FND0QUALIFICATION_level_already_exists_fail error if qualification with same level is already assigned to user.

Parameters

assign_user_qualification_info	(I) Information to assign a qualification to a user.
added_user_qualification_relation	(O) Tag of the relation object created on assigning the qualification to the user.

FND0QUALIFICATION_API int FND0QUALIFICATION_create_qualification	(	const FND0QUALIFICATION_manage_qualification_info_t *	manage_qualification_info,
		tag_t *	created_qualification
	)

Creates a Qualification object.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_create_permission_fail error if user is not privileged to create qualification.

Parameters

manage_qualification_info	(I) Information to create a Qualification object.
created_qualification	(O) Tag of the created Qualification object.

FND0QUALIFICATION_API int FND0QUALIFICATION_init_module

(

)

Initializes the Fnd0Qualification module. You must call this function before calling any other FND0QUALIFICATION functions.

FND0QUALIFICATION_API int FND0QUALIFICATION_remove_qualification_level	(	tag_t	qualification_tag,
		const char *const	qualification_level
	)

Removes a level from the qualification object.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_qualification_level_referenced_fail error if level is assigned to users.
• FND0QUALIFICATION_level_not_exist_fail error if qualification level is not present.

Parameters

qualification_tag	(I) Tag of the Qualification object to remove the level
qualification_level	(I) The level that needs to be removed from the Qualification's list of levels

FND0QUALIFICATION_API int FND0QUALIFICATION_remove_user_qualification	(	const FND0QUALIFICATION_remove_qualification_info_t *	remove_user_qualification_info,
		tag_t *	removed_user_qualification_relation
	)

Removes a qualification from the user.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_remove_user_qualfication_privilege_fail error if user is not privileged to remove user qualification.

Parameters

remove_user_qualification_info	(I) Information to remove a qualification from a user
removed_user_qualification_relation	(O) Tag of the deleted relation object on removing the qualification from the user.

FND0QUALIFICATION_API int FND0QUALIFICATION_update_qualification	(	tag_t	qualification_tag,
		const FND0QUALIFICATION_manage_qualification_info_t *	qualification_info
	)

Updates the qualification object based on the given information.

Returns

• ITK_ok on success.
• FND0QUALIFICATION_update_qualification_privilege_fail error if user is not privileged to modify qualification.
• FND0QUALIFICATION_qualification_level_referenced_fail error if level to be removed is assigned to users or tasks.
• FND0QUALIFICATION_cannot_change_exp_date_requirement_fail error if expiration date requirement cannot be changed because the qualification has been assigned to users.

Parameters

qualification_tag	(I) Tag of the Qualification object to update.
qualification_info	(I) Information to update the Qualification object.