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

Release Status

Functions

Function Documentation

TCCORE_API int CR_ask_date_effectivity ( tag_t  release_status,
date_t *  start_date,
date_t *  end_date 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_ask_date_effectivity
Parameters:
release_status  (I)
start_date  (O)
end_date  (O)

TCCORE_API int CR_ask_is_effectivity_user ( logical *  answer  ) 

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_ask_is_effectivity_user
Answers true if the user as currently logged in to Teamcenter Engineering has the privilege to edit effectivity data. This privilege is granted by preferences in the site preference file, either for an individual user or by role.
Parameters:
answer  (O)

TCCORE_API int CR_ask_release_status_type ( tag_t  release_status,
char  release_status_type[WSO_name_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use RELSTAT_ask_release_status_type
Returns the status_type for the given release status.
Parameters:
release_status  (I)
release_status_type  (O)

TCCORE_API int CR_ask_release_status_type2 ( tag_t  release_status,
char **  release_status_type 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_ask_release_status_type
Returns the status_type for the given release status.
Parameters:
release_status  (I)
release_status_type  (OF)

TCCORE_API int CR_ask_unit_effectivity ( tag_t  release_status,
int *  start_num,
int *  end_num 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_ask_unit_effectivity
Parameters:
release_status  (I)
start_num  (O)
end_num  (O)

TCCORE_API int CR_create_release_status ( const char  status_type[WSO_name_size_c+1],
tag_t *  release_status 
)

Creates release status object for given input status type. The function initializes start and end effectivity dates and start and end serial numbers to NULL. This means that the released objects will be effective for all dates and all serial numbers.

See also CR_add_release_status(tag_t job, tag_t release_status). ============= !!!CAUTION!!! ============= CR_create_release_status creates a release status with null value to the date_released property. So the date_released property needs to be populated before the release status is added to workspace objects. Use RELSTAT_add_release_status which populates the date_released with the current date (if release status has an invalid date) before adding the status.

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use CR_create_release_status2
Parameters:
status_type  (I)
release_status  (O)

TCCORE_API int CR_create_release_status2 ( const char *  status_type,
tag_t *  release_status 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_create_release_status
Parameters:
status_type  (I)
release_status  (O)

TCCORE_API int CR_initialize_release_status ( tag_t  release_status,
const char  status_type[WSO_name_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use RELSTAT_initialize_release_status
Initializes release status with given status type.

You normally use this function with subclass of object ReleaseStatus. Generally, this function follows immediately after POM_create_instance. This function is used to initialize the attributes inherited from the ReleaseStatus.

Parameters:
release_status  (I)
status_type  (I)

TCCORE_API int CR_initialize_release_status2 ( tag_t  release_status,
const char *  status_type 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_initialize_release_status
Initializes release status with given status type.

You normally use this function with subclass of object ReleaseStatus. Generally, this function follows immediately after POM_create_instance. This function is used to initialize the attributes inherited from the ReleaseStatus.

Parameters:
release_status  (I)
status_type  (I)

TCCORE_API int CR_set_date_effectivity ( tag_t  release_status,
date_t  start_date,
date_t  end_date 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_set_date_effectivity
Parameters:
release_status  (I)
start_date  (I)
end_date  (I)

TCCORE_API int CR_set_release_status_type ( tag_t  release_status,
char  release_status_type[WSO_name_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use RELSTAT_set_release_status_type
Sets the status_type for the given release status.
Parameters:
release_status  (I)
release_status_type  (I)

TCCORE_API int CR_set_release_status_type2 ( tag_t  release_status,
const char *  release_status_type 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_set_release_status_type
Sets the status_type for the given release status.
Parameters:
release_status  (I)
release_status_type  (I)

TCCORE_API int CR_set_unit_effectivity ( tag_t  release_status,
int  start_num,
int  end_num 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_set_unit_effectivity
Parameters:
release_status  (I)
start_num  (I)
end_num  (I)

TCCORE_API int EPM_add_release_status ( tag_t  release_status,
int  count,
tag_t *  ws_objects,
logical  retain_released_date 
)

Deprecated:
This function is deprecated and will be removed from Tc12.1 In Tc10.1 onwards, please use RELSTAT_add_release_status

TCCORE_API int RELSTAT_add_release_status ( tag_t  release_status,
int  count,
tag_t *  ws_objects,
logical  retain_released_date 
)

Adds the given release status to each of the ws_objects, with an indicator to retain the released date or not.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object. An error POM_invalid_tag will be returned if the input count and/or the input set of Workspace objects does not lead to valid objects.

Parameters:
release_status  (I) The release_status object.
count  (I) The number of objects to get a release_status object.
ws_objects  (I) The set of objects to get a release_status object.
retain_released_date  (I) The indicator of whether to keep the released date or not.

TCCORE_API int RELSTAT_ask_date_effectivity ( tag_t  release_status,
date_t *  start_date,
date_t *  end_date 
)

Returns the effective start and end dates from the given release_status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object.

Parameters:
release_status  (I) The release_status object.
start_date  (O) The start date.
end_date  (O) The end date.

TCCORE_API int RELSTAT_ask_is_effectivity_user ( logical *  answer  ) 

Answers true if the user as currently logged in to Teamcenter Engineering has the privilege to edit effectivity data. This privilege is granted by preferences in the site preference file, either for an individual user or by role.

Parameters:
answer  (O) The indicator if the user has effectivity edit privilege

TCCORE_API int RELSTAT_ask_release_status_type ( tag_t  release_status,
char **  release_status_type 
)

Returns the status_type for the given release status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object.

Parameters:
release_status  (I) The release_status object.
release_status_type  (OF) The type of the given release_status object.

TCCORE_API int RELSTAT_ask_unit_effectivity ( tag_t  release_status,
int *  start_num,
int *  end_num 
)

Returns the unit effectivity from the given release_status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object.

Parameters:
release_status  (I) The release_status object
start_num  (O) The unit start number
end_num  (O) The unit end number

TCCORE_API int RELSTAT_create_release_status ( const char *  status_type,
tag_t *  release_status 
)

Creates release status object for given input status type. The function initializes start and end effectivity dates and start and end serial numbers to NULL. This means that the released objects will be effective for all dates and all serial numbers.

See also RELSTAT_add_release_status(tag_t job, tag_t release_status). ============= !!!CAUTION!!! ============= RELSTAT_create_release_status creates a release status with null value to the date_released property. So the date_released property needs to be populated before the release status is added to workspace objects. Use RELSTAT_add_release_status which populates the date_released with the current date (if release status has an invalid date) before adding the status.

An error POM_attr_null_forbidden will be returned if the input status_type is null or an empty string. An error POM_string_too_long will be returned if the input status_type is too long. No error is returned if the status type already exists.

Parameters:
status_type  (I) The new status type to create.
release_status  (O) The newly created release status object.

TCCORE_API int RELSTAT_initialize_release_status ( tag_t  release_status,
const char *  status_type 
)

Initializes release status with given status type.

You normally use this function with subclass of object ReleaseStatus. Generally, this function follows immediately after POM_create_instance. This function is used to initialize the attributes inherited from the ReleaseStatus.

An error POM_attr_null_forbidden will be returned if the input status_type is null or an empty string. An error POM_string_too_long will be returned if the input status_type is too long.

Parameters:
release_status  (I) The release_status object to initialize.
status_type  (I) The status_type that the release_status will be initialized to.

TCCORE_API int RELSTAT_set_date_effectivity ( tag_t  release_status,
date_t  start_date,
date_t  end_date 
)

Sets the date effectivity on the given release_status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object. An error EPM_cannot_edit_old_effectivities will be returned if the current mode of V7 effectivity is set. An error POM_invalid_date will be returned if the start_date or end_date are invalid dates. An error EPM_end_before_start_date will be returned if the start_date is after than the end_date.

Parameters:
release_status  (I) The release_status object
start_date  (I) The start date
end_date  (I) The end date

TCCORE_API int RELSTAT_set_release_status_type ( tag_t  release_status,
const char *  release_status_type 
)

Sets the status_type for the given release status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object. An error POM_attr_null_forbidden will be returned if the input release_status_type is null or an empty string. An error POM_string_too_long will be returned if the input release_status_type is too long.

Parameters:
release_status  (I) The release_status object.
release_status_type  (I) The status type to set on the object.

TCCORE_API int RELSTAT_set_unit_effectivity ( tag_t  release_status,
int  start_num,
int  end_num 
)

Sets the unit effectivity on the given release_status.

An error CXPOM_wrong_class will be returned if the input release_status is a tag to an object other than a release status object. An error EPM_cannot_edit_old_effectivities will be returned if the current mode of V7 effectivity is set. An error EPM_negative_serial_number will be returned if the start_num or end_num are invalid (too long) or negative numbers. An error EPM_end_before_start_serial_number will be returned if the start_num is larger than the end_num.

Parameters:
release_status  (I) The release_status object
start_num  (I) The unit start number
end_num  (I) The unit end number