Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

ADA_License

Defines

Functions

Define Documentation

#define ADA_group_name_size_c   256

Definition at line 37 of file license.h.

#define ADA_ip_admin_role   "IP Admin"

Definition at line 39 of file license.h.

#define ADA_ip_classifier_role   "IP Classifier"

Definition at line 43 of file license.h.

#define ADA_itar_admin_role   "ITAR Admin"

Definition at line 40 of file license.h.

#define ADA_itar_classifier_role   "ITAR Classifier"

Definition at line 42 of file license.h.

#define ADA_lic_citizenship_size_c   2

Defines the length of citizenship strings.

Definition at line 47 of file license.h.

#define ADA_license_category_size_c   128

Definition at line 44 of file license.h.

#define ADA_license_id_size_c   128

Definition at line 35 of file license.h.

#define ADA_license_InAccrWith_size_c   80

Definition at line 38 of file license.h.

#define ADA_license_reason_size_c   128

Definition at line 36 of file license.h.

#define ADA_site_admin_role   "ADA Site Admin"

Definition at line 41 of file license.h.

Function Documentation

TCCORE_API int ADA_add_license_group ( tag_t  license_tag,
tag_t  group_tag 
)

This function will add a group to ADA License that can access objects with an attached ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
group_tag  (I) Tag of the group to be added to the ADA License

TCCORE_API int ADA_add_license_object ( tag_t  license_tag,
tag_t  object_tag 
)

This function will attach the given ADA License to the specified object.

Parameters:
license_tag  (I) Tag of an ADA License
object_tag  (I) Tag of a workspace object to attach the ADA License to

TCCORE_API int ADA_add_license_object2 ( tag_t  license_tag,
tag_t  object_tag,
char *  ead_paragraph 
)

This function will attach the given ADA License to the specified object along with ead paragragh information. ead_paragraph is applicable only when attaching ITAR Licenses to objects. For other license types like IP License and Exclude license the ead paragraph information will be null.

Parameters:
license_tag  (I) Tag of an ADA License
object_tag  (I) Tag of a workspace object to attach the ADA License to
ead_paragraph  (I) Paragraph authorizing attaching the ADA License to the workspace object. Applicable only for ITAR Licenses.

TCCORE_API int ADA_add_license_user ( tag_t  license_tag,
tag_t  user_tag 
)

This function will add a user to ADA License that can access objects with an attached ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
user_tag  (I) Tag of the user to be added to the ADA License

TCCORE_API int ADA_ask_in_accordance_with ( tag_t  license_tag,
char  in_accordance[ADA_license_InAccrWith_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ADA_ask_in_accordance_with2
This function will get the qualifying Code of Federal Regulations (CFR) information (In Accordance With) specified on ITAR licenses.
Parameters:
license_tag  (I) Tag of an ADA License
in_accordance  (O) Qualifying Code of Federal Regulations (CFR) specified on the ITAR License

TCCORE_API int ADA_ask_in_accordance_with2 ( tag_t  license_tag,
char **  in_accordance 
)

This function will get the qualifying Code of Federal Regulations (CFR) information (In Accordance With) specified on ITAR licenses.

Parameters:
license_tag  (I) Tag of an ADA License
in_accordance  (OF) Qualifying Code of Federal Regulations (CFR) specified on the ITAR License

TCCORE_API int ADA_ask_license_category ( tag_t  license_tag,
char **  category 
)

This function will get the category specified on the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
category  (OF) Category specified on the ADA License

TCCORE_API int ADA_ask_license_citizenships ( tag_t  license_tag,
int *  num,
char ***  citizenships 
)

This function will retrieve citizenships of the ADA License. Error SA_invalid_citizenship will returned if each citizenship is not two-letter string. Error PROP_invalid_object will be returned if license_tag is not valid ADA_License tag.

Parameters:
license_tag  (I) Tag of an ADA License
num  (O) Number of citizenships
citizenships  (OF) num Array of citizenships

TCCORE_API int ADA_ask_license_expiry ( tag_t  license_tag,
date_t *  expiry 
)

This function will get the expiry date specified on the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
expiry  (O) Expiry date specified on the ADA License

TCCORE_API int ADA_ask_license_id ( tag_t  license_tag,
char  id[ADA_license_id_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ADA_ask_license_id2
This function will get the ID of the given ADA License.
Parameters:
license_tag  (I) Tag of an ADA License
id  (O) ID of the ADA License

TCCORE_API int ADA_ask_license_id2 ( tag_t  license_tag,
char **  id 
)

This function will get the ID of the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
id  (OF) ID of the ADA License

TCCORE_API int ADA_ask_license_lock ( tag_t  license_tag,
date_t *  lock_date 
)

This function will get the lock date specified on the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
lock_date  (O) Lock date specified on the ADA License

TCCORE_API int ADA_ask_license_reason ( tag_t  license_tag,
char  reason[ADA_license_reason_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ADA_ask_license_reason2
This function will get the reason specified on the ADA License.
Parameters:
license_tag  (I) Tag of an ADA License
reason  (O) Reason specified on the ADA License

TCCORE_API int ADA_ask_license_reason2 ( tag_t  license_tag,
char **  reason 
)

This function will get the reason specified on the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
reason  (OF) Reason specified on the ADA License

TCCORE_API int ADA_create_license ( const char *  license_id,
const char *  license_type,
tag_t *  license_tag 
)

This function creates a new ADA License of specified type with the identification string.

Parameters:
license_type  < (I) Identifier for the ADA License.
license_tag  < (I) Type of ADA License. A valid type for ADA License is ITAR_License, IP_License, or Exclude_License. < (O) Tag of the created ADA License.

TCCORE_API int ADA_find_license ( const char *  licid,
tag_t *  license 
)

This function will get the tag of the ADA License identified by the given License ID string. License ID is the unique key attribute of the ADA License Class.

Parameters:
licid  (I) ID of an ADA License
license  (O) Tag of ADA License

TCCORE_API int ADA_group_licensed ( tag_t  license_tag,
tag_t  group_tag,
logical *  is_licensed 
)

This function checks if a particular group is listed on the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
group_tag  (I) Tag of the group
is_licensed  (O) True if the group is listed on ADA License, otherwise false.

TCCORE_API int ADA_list_license_groups ( tag_t  license_tag,
int *  group_count,
tag_t **  group_tags 
)

This function lists all the groups associated with the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
group_count  (O) Number of users
group_tags  (O) Tag list of groups specified on the given ADA License

TCCORE_API int ADA_list_license_objects ( tag_t  license_tag,
int *  object_count,
tag_t **  object_tags 
)

This function lists all the objects associated with the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
object_count  (O) Number of objects
object_tags  (O) Tag list of all workspace objects associated with the ADA License.

TCCORE_API int ADA_list_license_users ( tag_t  license_tag,
int *  user_count,
tag_t **  user_tags 
)

This function lists all the users associated with the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
user_count  (O) Number of users
user_tags  (O) Tag list of users specified on the given ADA License

TCCORE_API int ADA_remove_license_group ( tag_t  license_tag,
tag_t  group_tag 
)

This function will remove the group from ADA License that can access objects with an attached ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
group_tag  (I) Tag of the group to be removed from the ADA License

TCCORE_API int ADA_remove_license_object ( tag_t  license_tag,
tag_t  object_tag 
)

This function will detach the given ADA License from the object.

Parameters:
license_tag  (I) Tag of an ADA License
object_tag  (I) Tag of the workspace object to detach the ADA License from

TCCORE_API int ADA_remove_license_user ( tag_t  license_tag,
tag_t  user_tag 
)

This function will remove the user from ADA License that can access objects with an attached ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
user_tag  (I) Tag of the user to be removed from the ADA License

TCCORE_API int ADA_set_in_accordance_with ( tag_t  license_tag,
const char *  in_accordance 
)

This function will add the qualifying Code of Federal Regulations (CFR) information (In Accordance With) on ITAR licenses.

Parameters:
license_tag  (I) Tag of an ADA License
in_accordance  (I) Qualifying Code of Federal Regulations (CFR) to be set on the ITAR License

TCCORE_API int ADA_set_license_category ( tag_t  license_tag,
const char *  category 
)

This function will set the category for the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
category  (I) Category to be set for the ADA License

TCCORE_API int ADA_set_license_citizenships ( tag_t  license_tag,
int  num,
const char **  citizenships 
)

This function will set citizenships to the ADA License. Error SA_invalid_citizenship will returned if each citizenship is not two-letter string. Error PROP_invalid_object will be returned if license_tag is not valid ADA_License tag.

Parameters:
license_tag  (I) Tag of an ADA License
num  (I) Number of citizenships
citizenships  (I) Array of citizenships. Each citizenship is a string of length defined by ADA_lic_citizenship_size_c

TCCORE_API int ADA_set_license_expiry ( tag_t  license_tag,
date_t  expiry 
)

This function will set an expiry date on the given ADA License. Expiry date should be greater than the current date and the Lock date specified on the License.

Parameters:
license_tag  (I) Tag of an ADA License
expiry  (I) Expiry date to be set on the ADA License

TCCORE_API int ADA_set_license_id ( tag_t  license_tag,
const char *  id 
)

This function will set the ID of the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
id  (I) ID to be set on the ADA License

TCCORE_API int ADA_set_license_lock ( tag_t  license_tag,
date_t  myLockdate 
)

This function will set the lock date on the ADA License. Lock date should be between current date and expiry date.

Parameters:
license_tag  (I) Tag of an ADA License
myLockdate  (I) Lock date to be set on the ADA License

TCCORE_API int ADA_set_license_reason ( tag_t  license_tag,
const char *  reason 
)

This function will set the reason for the ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
reason  (I) Reason to be set for the ADA License

TCCORE_API int ADA_user_licensed ( tag_t  license_tag,
tag_t  user_tag,
logical *  is_licensed 
)

This function checks if a particular user is listed on the given ADA License.

Parameters:
license_tag  (I) Tag of an ADA License
user_tag  (I) Tag of the user
is_licensed  (O) True if the user is listed on ADA License, otherwise false.