All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMPosResourceUseItf Interface PLMIPosSecondaryOwnershipVector

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface PLMIPosSecondaryOwnershipVector

The Interface to scan and update the Secondary Ownership Vector of an Object.

Role: This interface is used to scan and update the Secondary Ownership Vector of an Object.
A pointer to this interface can be retrieved using method .

Method Index

o NextSecondaryOwnershipItem(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Gets the next Secondary Ownership Item in this Vector, that is, gets an Access granted on the object to a P&O entity.
o UpdateSecondaryOwnershipItem(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIAdpPLMErrorReviewer*&): Updates a Secondary Ownership Item in this Vector, that is, grants some Access to a given P&O entity.

Methods

o NextSecondaryOwnershipItem

public virtual NextSecondaryOwnershipItem(		`oUser`,
		`oOrganization`,
		`oCollabSpace`,
		`oAccess`,
		`oComment`)

Gets the next Secondary Ownership Item in this Vector, that is, gets an Access granted on the object to a P&O entity.
The scan of the Vector ends when this method returns S_FALSE.
If the Access is granted to a User (User Ownership) only oUser is returned as the P&O entity.
If the Access is granted to an Organization (Organization Ownership) only oOrganization is returned as the P&O entity.
If the Access is granted to a Collab Space (Collab Space Ownership) only oCollabSpace is returned as the P&O entity.
If the Access is granted to a family of Security Contexts (Security Context Ownership) only {oOrganization,oCollabSpace} are returned as the P&O entity (meaning any Security Contexts like *.oOrganization.oCollabSpace).

Parameters:

oUser: Attribute V_id of the User granted with the returned Access when applicable. Empty otherwise.
oOrganization: Attribute V_id of the Organization granted with the returned Access when applicable. Empty otherwise.
oCollabSpace: Attribute V_id of the Collab Space granted with the returned Access when applicable. Empty otherwise.
oAccess: The Access granted to the returned P&O entity.
oComment: An informative string about this Item.

Returns:

S_OK : iteration successful
S_FALSE : end of Vector reached (and all returned values are empty)
E_FAIL : iteration failed

o UpdateSecondaryOwnershipItem

public virtual UpdateSecondaryOwnershipItem(	const	`iUser`,
	const	`iOrganization`,
	const	`iCollabSpace`,
	const	`iAccess`,
	const	`iComment`,
		`oErrors`)

Updates a Secondary Ownership Item in this Vector, that is, grants some Access to a given P&O entity.
To grant Access to a User (User Ownership) only iUser should be given as the P&O entity.
To grant Access to an Organization (Organization Ownership) only iOrganization should be given as the P&O entity.
To grant Access to a Collab Space (Collab Space Ownership) only iCollabSpace should be given as the P&O entity.
To grant Access to a family of Security Contexts (Security Context Ownership) only {iOrganization, iCollabSpace} should be given as the P&O entity (meaning any Security Contexts like *.iOrganization.iCollabSpace). Valid couples can be retrieved using .
Any other combination of P&O entity will result in an E_INVALIDARG return code.
If the item does not exist then the item is added to this Vector.
If the item already exists and iAccess is not empty then the item's Access is updated if needed.
If the item already exists and iAccess is empty then the item is removed from this Vector.
Any successful operation results in the iterator on the Vector to be reset to its starting position.
To commit all the operations to the database method should be called.

Parameters:

iUser: Attribute V_id of the User to be granted with the given Access.
iOrganization: Attribute V_id of the Organization to be granted with the given Access.
iCollabSpace: Attribute V_id of the Collab Space to be granted with the given Access.
iAccess: The Access to be granted to the given P&O entity. Valid Accesses can be retrieved using method
iComment: An informative string about this Item.
oErrors: Errors to be reviewed only when return code is different from S_OK. Ignore otherwise.

Returns:

S_OK : update successful
S_FALSE : no update done
E_INVALIDARG : not a valid Item or Access

This object is included in the file: PLMIPosSecondaryOwnershipVector.h
If needed, your Imakefile.mk should include the module: GUIDPLMPosResourceUseItf