PLMSRMExposedServices CATPLMSiteStatus

Usage: you must use this class as is. You should never derive it.

public class CATPLMSiteStatus

Class dedicated to the Site Ownership status information management.

Role: It provides a set of information about the Site Ownership of a PLM Entity.

 When exchanging data, it is important to know which site possesses the right of edition, because a PLM Entity
 can only be edited on one site at a time. This right of edition is determined by the repository privilege: it can be local (same
 repository) or distant (another repository).
 
 To know if a PLM Entity belongs to the local repository or a distant one, the user can use the 
  method. 
 For a list of PLM Entities it gives a list of site information in the form of a list of CATPLMSiteStatus.

 That CATPLMSiteStatus contains one main information: the repository privilege of the Core Data PLM Entity.
 Core Data is a qualifier for types and attributes that must always be exchanged. It includes semantic relations,
 streams descriptors, extensions and some PLM attributes.
 
 For each of the CATPLMSiteStatus, you can retrieve the Core Data Site Privilege by using the 
 method.

Note that the 
 method should not be used. It cannot modify the site ownership status in the database.  It is only purpose for internal implementation.

Example:

 
  CATLISTP(CATPLMSiteStatus) PLMSiteStatusList;
  HRESULT Rc = exchangeChannelServices->GetSiteInformation(iPLMEntitiesIdsList, PLMSiteStatusList);
  for (int i=1; i<=PLMSiteStatusList.Size(); i++)
  ...
     CATPLMSiteStatus* siteStatus = PLMSiteStatusList[i];
     CATPLMSiteStatus::CATPLMSiteOwnershipInformation siteInfo = CATPLMSiteStatus::Unknown;
     Rc = siteStatus->GetCoreDataSitePrivilege(siteInfo);
  ...
 

 

See also:

Constructor and Destructor Index

o CATPLMSiteStatus()

Constructs an empty Site Status class.

o ~CATPLMSiteStatus()

Method Index

o GetCoreDataSitePrivilege(CATPLMSiteOwnershipInformation&)

Retrieves the Site Ownership information.

o SetCoreDataSitePrivilege(CATPLMSiteOwnershipInformation&)

Sets the Site Ownership information.

Enumerated Type Index

o CATPLMSiteOwnershipInformation

Status for the Site Ownership information.

Constructor and Destructor

Constructs an empty Site Status class.

Methods

Retrieves the Site Ownership information.
Role: It retrieves the Core Data Site Ownership information. It determines whether a PLM Entity belongs to the local repository or to a distant one.

Parameters:

oSiteOwnershipInfo[out]

The status (local or distant) for the Site Ownership of the PLM Entity.

Returns:

An HRESULT value.
Legal values:

S_OK

if the status is correctly retrieved.

E_FAIL

if there is any problem. The return status is then set to Unknown. A CATError is associated.

Sets the Site Ownership information.
Role: It sets the Core Data Site Ownership information. This method is not to be used. Its only purpose is only for implementation. It does not allow the user to modify the site ownership information on a PLM Entity. Information is set on the class instance but it is not saved into the database.

Parameters:

iSiteOwnershipInformation[in]

The status (local or distant) for the Site Ownership of the PLM Entity.

Returns:

An HRESULT value.
Legal values:

S_OK

if the status is correctly set.

E_FAIL

if there is any problem.

Enumerated Types