All Frameworks Class Hierarchy This Framework Previous Next Indexes
ProductStructure Interface CATIPrdObjectPublisher
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPrdObjectPublisher
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPrdObjectPublisher
Interface to create and manage publications on a Product.
Method Index
- o
GetDirectObject(CATUnicodeString&,CATBaseUnknown*&,CATUnicodeString&)
- Retrieves the direct publication object.
- o
GetFinalObject(CATUnicodeString&)
- Retrieves the final publication object.
- o
IsFinallyPublished(CATBaseUnknown*,CATListValCATBaseUnknown_var*&,CATListValCATUnicodeString*&)
- Retrieves the list of the publication objects referencing a given publication object.
- o
IsFinallyPublished(CATIPrdObjectPublisher*,CATUnicodeString&,CATListValCATBaseUnknown_var*&,CATListValCATUnicodeString*&)
- Retrieves the list of the publication objects referencing a given publication object.
- o
IsPublished(CATBaseUnknown*,CATListValCATUnicodeString*&)
- Retrieves the list of an object's publications.
- o
IsPublished(CATIPrdObjectPublisher*,CATUnicodeString&,CATListValCATUnicodeString*&)
- Retrieves the list of an object's publications.
- o
ListPublications(CATListValCATUnicodeString*&)
- Retrieves the list of the publications of the current product.
- o
Publish(CATUnicodeString&,CATBaseUnknown*)
- Creates a new publication.
- o
Unpublish(CATUnicodeString&)
- Deletes an existing publication.
- o
Unvaluate(CATUnicodeString&)
- Deletes a publication's valuation.
- o
Valuate(CATUnicodeString&,CATBaseUnknown*)
- Valuates a publication directly with the object being published.
- o
Valuate(CATUnicodeString&,CATIPrdObjectPublisher*,CATUnicodeString&)
- Valuates a publication with another publication object.
Methods
o GetDirectObject
-
Retrieves the direct publication object.
- Parameters:
-
- iName
- The name of the publication referring to the direct object
that is to be retrieved.
- oObjectOrSubPublisher
- If Return = 1, this is the direct publication object. Otherwise, if
Return = 2, this is the sub-publisher, a pointer to another publication.
- oSubPublicationName
- If Return = 2, this is the name of the publication pointed to by the
sub-publisher.
- Returns:
- 0: The publication is not valuated.
1: The direct publication object is returned.
2: The direct publication object is a pointer to another publication.
o GetFinalObject
-
Retrieves the final publication object.
- Parameters:
-
- iName
- The name of the publication referring to the final object
that is to be retrieved.
- Returns:
- If NULL: The publication is not valuated.
Otherwise: The final publication object.
o IsFinallyPublished
-
Retrieves the list of the publication objects referencing a given publication object.
- Parameters:
-
- iObject
- The object whose referencing publications (sub-publications) are to be retrieved.
- oSubPublishers
- The list of sub-publishers of the given publication object.
- oSubPublicationNames
- The list of the sub-publication names.
- Returns:
- 0: The object is not published.
1: The object is published and a list of names has been retrieved.
o IsFinallyPublished
-
Retrieves the list of the publication objects referencing a given publication object.
- Parameters:
-
- iSubPublisher
- The sub-publisher whose publications are to be retrieved.
- iName
- The name of the sub-publication.
- oSubPublishers
- The list of sub-publishers of the given publication object.
- oSubPublicationNames
- The list of the sub-publication names.
- Returns:
- 0: The object is not published.
1: The object is published and a list of names has been retrieved.
o IsPublished
-
Retrieves the list of an object's publications.
- Parameters:
-
- iObject
- The object whose publications are to be retrieved.
- oListOfNames
- The list of publications for the given object.
- Returns:
- 0: The object is not published.
1: The object is published and a list of names has been retrieved.
o IsPublished
-
Retrieves the list of an object's publications.
- Parameters:
-
- iSubPublisher
- The sub-publication object referencing the object whose publications
are to be retrieved.
- iName
- The name of the publication of the sub-publication object referencing
the object whose publications are to be retrieved.
- oListOfNames
- The list of publications for the referenced object.
- Returns:
- 0: The object is not published.
1: The object is published and a list of names has been retrieved.
o ListPublications
-
Retrieves the list of the publications of the current product.
- Parameters:
-
- oListOfPublications
- The list of publication names of the current product.
- Returns:
- =0: No publications found.
>1: The number of publications found.
o Publish
-
Creates a new publication.
- Parameters:
-
- iName
- The name of the new publication.
- iObject
- The object being published. If none, the publication is not valuated.
- Returns:
- 1: The publication is OK.
0: The publication already exists.
o Unpublish
-
Deletes an existing publication.
- Parameters:
-
- iName
- The name of the publication to be deleted.
- Returns:
- 1: The publication is deleted.
0: The publication name is not found.
o Unvaluate
-
Deletes a publication's valuation.
- Parameters:
-
- iName
- The name of the publication whose valuation is to be deleted.
o Valuate
-
Valuates a publication directly with the object being published.
- Parameters:
-
- iName
- The name of the publication to be valuated.
- iObject
- The publication object.
- Returns:
- 0: The publication name is not found.
1: The publication is valuated OK.
o Valuate
-
Valuates a publication with another publication object.
- Parameters:
-
- iName
- The name of the publication to be valuated.
- iSubPublisher
- The publication object referencing the object being published.
- iSubName
- The name of the referencing publication.
- Returns:
- 0: The publication name is not found.
1: The publication is valuated OK.
This object is included in the file: CATIPrdObjectPublisher.h
If needed, your Imakefile.mk should include the module: CATProductStructure1