All Frameworks Class Hierarchy This Framework Indexes Previous Next

ProductStructureUseItf Interface CATIPrdPublications

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

interface CATIPrdPublications

Interface to manage a collection of PLM Product Publications.

Role: This interface provides means to manage the collection of Publications aggregated by this PLM Product Reference.
To manage the Publciation added in the collection, used interface for Publciation definition.
This interface is implemented on PLM Product Reference.

Method Index

o AddExplicitPublication(CATListValCATICkeParm_var&,CATListValCATICkeParm_var&,CATIAdpEnvironment*,CATOmbObjectInContext*,CATIPrdPublication_var&)
o AddPrdPublication(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATOmbObjectInContext*,CATIPrdPublication_var&): Adds a new Publication.
o AddPublication(CATUnicodeString&,CATOmbObjectInContext*,CATIPrdPublication_var&)
o Count(int&): Retrieves the Publications count.
o GetByName(CATUnicodeString&,CATIPrdPublication_var&): Retrieves a Publication using its name.
o Iterator(CATIPrdIterator*&): Creates an iterator to navigate on the Publications collection.
o Remove(CATBaseUnknown*): Removes a Publication from the collection.
o RemoveAll(): Removes all Publications from the collection.
o RemoveByName(CATUnicodeString&): Removes a Publication from the collection, using its name.

Methods

o AddExplicitPublication

public virtual AddExplicitPublication(		`iPublicListValues`,
		`iControlledListValues`,
		`iEnv`,
	const	`iObjInCtx`,
		`ohPLMPublication`)

Deprecated:

R211 Adds a new Publication.
Role: This method creates a new Publication with a given name, a pointed object and a list of PLM attributes.
The newly created Publication is aggregated by this (a PLM Product Reference).

Parameters:

iPublicListValues: The list contains read/write public attributes. This list can be empty.
iControlledListValues: The list must contain the name of the Publication (V_FunctionalName).
The name of the Publication should follow the naming rules described in the
iEnv: The Environment enables you to specify indirectly the PLM Port type. This type is the one defined by the authoring customization for the PRODUCT modeler in this environment.
It must not be NULL, otherwise the method fails.
iObjInCtx: The pointed object in context to publish. You retrieve this object using
ohPLMPublication: The newly created Publication. This parameter should not be valuated before the call.
This handler is not valid if the creation fails.

Returns:

An HRESULT value.
Legal values:

S_OK: The new Publication was successfully added and ohPLMPublication is valuated.
E_FAIL: The the Publication creation failed with the given information.

ProductERR_2300:
ProductERR_2301:
ProductERR_2302:
ProductERR_2303:
ProductERR_2304:
ProductERR_2305:
ProductERR_2306:
ProductERR_2307:
ProductERR_2308:

o AddPrdPublication

public virtual AddPrdPublication(		`iEnv`,
		`iPrdAttributesValues`,
	const	`iObjInCtx`,
		`ohPLMPublication`)

Adds a new Publication.
Role: This method creates a new Publication with a given name and a pointed object.
The newly created Publication is aggregated by this (a PLM Product Reference).

Parameters:

ipEnv: The environment defining the project. The project determines the deployment type to associate (or not) to the new PLM Object.
If the argument is NULL, the current environment is used.
iPrdAttributesValues: A list of Product Publciations attributes values.
The list must only contain the name of the Publication (V_FunctionalName).
The name of the Publication should follow the naming rules described in the
ohPLMPublication: The created Product Publication.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

Returns:

S_OK: The new Publication was successfully added and ohPLMPublication is valuated.
E_FAIL: The the Publication creation failed with the given information.

o AddPublication

public virtual AddPublication(	const	`iPublicationName`,
	const	`iObjInCtx`,
		`ohPLMPublication`)

Deprecated:

R211 Adds a new Publication.
Role: This method creates a new Publication with a given name and a pointed object.
The newly created Publication is aggregated by this (a PLM Product Reference).

Parameters:

iPublicationName: The Publication name, which must be unique among this's Publications collection.
It should follow the naming rules described in the
iObjInCtx: The pointed object in context to publish. You retrieve this object using
ohPLMPublication: The newly created Publication. This parameter should not be valuated before the call.
This handler is not valid if the creation fails.

Returns:

An HRESULT value.
Legal values:

S_OK: The new Publication was successfully added and ohPLMPublication is valuated.
E_FAIL: The the Publication creation failed with the given information.

ProductERR_2300:
ProductERR_2301:
ProductERR_2302:
ProductERR_2303:
ProductERR_2304:
ProductERR_2305:
ProductERR_2306:
ProductERR_2307:
ProductERR_2308:

o Count

public virtual Count( oSize)

Retrieves the Publications count.
Role: This method retrieves the Publications count of the collection of this PLM Product Reference.
To retrieve the Publications themselves, use the method.

Parameters:

oSize: The count of this Publications collection.

Returns:

An HRESULT value.
Legal values:

S_OK: The number of Publications was successfully retrieved. The value is between 0 and N.
E_FAIL: In this case, oSize is set to -1.

o GetByName

public virtual GetByName(	const	`iPublicationName`,
		`ohPLMPublication`)

Retrieves a Publication using its name.
Role: This method performs a search through this Publications collection, and retrieves the Publication using its name.

Parameters:

iPublicationName: The name of the Publication to retrieve.
This name can be obtained by using the
ohPLMPublication: The searched Publication.

Returns:

An HRESULT value.
Legal values:

S_OK: The Publication was successfully retrieved.
E_INVALIDARG: Either iPublicationName is not valuated, or ohPLMPublication is already valuated before the call.
E_FAIL: The Publication was not found.

o Iterator

public virtual Iterator( opSpecIterator)

Creates an iterator to navigate on the Publications collection.
Role: This method creates a iterator which iterates on all the Publications of this collection.
Do not modify the collection (by removing, replacing or adding a Publication for example) while the iterator is being in used !

Parameters:

opSpecIterator

[out, CATBaseUnknown#Release] The created iterator. It should not be valuated before the call.
Do not forget to release this pointer once it is no longer in use !
For example :

CATIPrdPublications * pPublicationsCollection = ... ;
		  	 CATIPrdIterator * pIterator = NULL;
				 if (SUCCEEDED(pPublicationsCollection->Iterator(pPublicationsIterator)))
				 {
				 CATIPrdPublication * pPublication = NULL;
				 while (SUCCEEDED(pIterator->Next((CATBaseUnknown*&)pPublication)))
				 {
						...
						pPublication->Release(); pPublication = NULL;
				}
				pIterator->Release(); pIterator = NULL;
}

Returns:

An HRESULT value.
Legal values:

S_OK: The iterator was successfully created.
E_INVALIDARG: The output argument opSpecIterator is already valuated before the call.
E_FAIL: Iterator creation failed.

o Remove

public virtual Remove( ipObject)

Removes a Publication from the collection.
Role: This method removes a Publication from the collection of this PLM Product Reference.
The Publication object will be removed and will no longer be aggregated by this.

Parameters:

ipObject: The Publication to be removed.

Returns:

An HRESULT value.
Legal values:

S_OK: The Publication was successfully removed.
E_INVALIDARG: The input argument ipObject is not valuated.
E_FAIL: Either the Publication was not retrieved in current collection, or it was not successfully removed.

o RemoveAll

public virtual RemoveAll(

)

Removes all Publications from the collection.
Role: This method removes all the Publications from this collection.
All the Publications objects will be removed and will no longer be aggregated by this.

Returns:

An HRESULT value.
Legal values:

S_OK: All Publications are successfully removed.
E_FAIL: Removal failed. In this case, the collection is left unchanged.

o RemoveByName

public virtual RemoveByName( const iPublicationName)

Removes a Publication from the collection, using its name.
Role: This method removes a Publication using its name, from this collection.
The Publication object will be removed and will no longer be aggregated by this.

Parameters:

iPublicationName

The name of the Publication to be removed.
It can be retrieved by using the

Returns:

An HRESULT value.
Legal values:

S_OK: The Publication was successfully removed.
E_INVALIDARG: The input argument ipObject is not valuated.
E_FAIL: Either the Publication was not founded in the collection, or it was not successfully removed.

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