DWFToolkit::OPCRelationshipContainerInterface Class Reference

Inheritance diagram for DWFToolkit::OPCRelationshipContainerInterface:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 34 of file RelationshipContainerInterface.h.

Public Member Functions

virtual _DWFTK_API OPCRelationshipaddRelationship (OPCPart *pTargetPart, const DWFString &zRelationshipType, OPCRelationship::teTargetMode eTargetMode=OPCRelationship::eInternal)=0 throw ( DWFException )
virtual _DWFTK_API bool deleteRelationship (OPCRelationship *pRelationship)=0 throw ()
virtual _DWFTK_API size_t relationshipCount () const =0 throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationships ()=0 throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByTarget (const DWFString &zTargetURI) const =0 throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByTarget (OPCPart *pTargetPart) const =0 throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByType (const DWFString &zType) const =0 throw ()
virtual _DWFTK_API void deleteRelationshipsByTarget (OPCPart *pTargetPart)=0 throw ( DWFException )
_DWFTK_API DWFInputStreamgetInputStream () throw ( DWFException )

Protected Member Functions

_DWFTK_API OPCRelationshipContainerInterface () throw ()
virtual _DWFTK_API ~OPCRelationshipContainerInterface () throw ()


Member Function Documentation

virtual _DWFTK_API OPCRelationship* DWFToolkit::OPCRelationshipContainerInterface::addRelationship OPCPart pTargetPart,
const DWFString zRelationshipType,
OPCRelationship::teTargetMode  eTargetMode = OPCRelationship::eInternal
throw ( DWFException ) [pure virtual]
 

Create and add a new relationship from the container to the specified part.

Parameters:
pTargetPart The target of the new relationship.
zRelationshipType The type to be assigned to the relationship.
eTargetMode The mode of the relationship - internal or external.
Returns:
Pointer to the new relationship
Exceptions:
DWFException 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API bool DWFToolkit::OPCRelationshipContainerInterface::deleteRelationship OPCRelationship pRelationship  )  throw () [pure virtual]
 

Delete a specific relationship

Parameters:
pRelationship Pointer to the relationship to be removed.
Exceptions:
None 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API void DWFToolkit::OPCRelationshipContainerInterface::deleteRelationshipsByTarget OPCPart pTargetPart  )  throw ( DWFException ) [pure virtual]
 

Remove all relationships from this item to the specified target.

Parameters:
pTargetPart Relationships to this target willl be removed.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

_DWFTK_API DWFInputStream* DWFToolkit::OPCRelationshipContainerInterface::getInputStream  )  throw ( DWFException )
 

Get the input stream that will provide the serialized bytes of all relationships in the container.

Returns:
Pointer to an input stream. It must be deleted by the caller using DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

Reimplemented in DWFToolkit::DWFXResourcePart, DWFToolkit::OPCPart, DWFToolkit::OPCRelationshipContainer, and DWFToolkit::OPCXMLPart.

virtual _DWFTK_API size_t DWFToolkit::OPCRelationshipContainerInterface::relationshipCount  )  const throw () [pure virtual]
 

Get the total number of relationships from this item.

Returns:
The number of relationships from this item.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCRelationshipContainerInterface::relationships  )  throw () [pure virtual]
 

Get all the relationships from this item

Returns:
Pointer to an iterator over all relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCRelationshipContainerInterface::relationshipsByTarget OPCPart pTargetPart  )  const throw () [pure virtual]
 

Get all the relationships from this item to a specific target.

Parameters:
pTargetPart Relationships to this target will be returned.
Returns:
Pointer to an iterator over the relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCRelationshipContainerInterface::relationshipsByTarget const DWFString zTargetURI  )  const throw () [pure virtual]
 

Get all the relationships from this item to a specific target.

Parameters:
zTargetURI Relationships to the target with this URI will be returned.
Returns:
Pointer to an iterator over the relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCRelationshipContainerInterface::relationshipsByType const DWFString zType  )  const throw () [pure virtual]
 

Get all the relationships of a given type from this item.

Parameters:
zType The type of relationships to be iterated over.
Returns:
Pointer to an iterator over the relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implemented in DWFToolkit::OPCPackage, DWFToolkit::OPCPart, and DWFToolkit::OPCRelationshipContainer.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:26 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5