Collapse all Symbian^3 Product Developer Library

ContentAccess::CAgentFactory Class Reference

class ContentAccess::CAgentFactory : public CBase

Abstract interface handed out by an ECOM agent implementation by REComSession::CreateImplementationL().

CAgentFactory defines an abstract factory that is responsible for creating the abstract products:

Derived classes will hand out concrete product implementations which are specific for that particular agent.

Derived classes effectively represent the ECOM session handle used by CAF classes

ContentAccess::CF32AgentFactory. This implements ContentAccess::CAgentFactory to handle unrestricted content.

Inherits from

ContentAccess::CAgentFactory
- CBase

Public Member Functions
	~CAgentFactory()
CAgentContent *	CreateContentBrowserL(const TDesC &, TContentShareMode)
CAgentContent *	CreateContentBrowserL(RFile &)
CAgentData *	CreateDataConsumerL(const TVirtualPathPtr &, TContentShareMode)
CAgentData *	CreateDataConsumerL(RFile &, const TDesC &)
CAgentImportFile *	CreateImporterL(const TDesC8 &, const CMetaDataArray &, const TDesC &, const TDesC &)
CAgentImportFile *	CreateImporterL(const TDesC8 &, const CMetaDataArray &)
CAgentManager *	CreateManagerL()
CAgentRightsManager *	CreateRightsManagerL()
CAgentFactory *	NewL(TUid)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TUid	iEcomKey

Constructor & Destructor Documentation

~CAgentFactory()

IMPORT_C

~CAgentFactory

(

)

[virtual]

Destructor, calls REComSession::DestroyedImplementation(); to destroy the ECOM implementation. When all implementations are destroyed ECOM will unload the agent DLL

Member Functions Documentation

CreateContentBrowserL(const TDesC &, TContentShareMode)

CAgentContent *	CreateContentBrowserL	(	const TDesC &	aURI,
			TContentShareMode	aShareMode
		)	[pure virtual]

Factory function creates a CAgentContent object for browsing the contents of a file belonging to this agent.

Parameters

const TDesC & aURI	The location of the file.
TContentShareMode aShareMode	The share mode used for opening this content

CreateContentBrowserL(RFile &)

CAgentContent *

CreateContentBrowserL

(

RFile &

aFile

)

[pure virtual]

Creates a CAgentContent object for browsing the contents of a file belonging to this agent

Parameters

RFile & aFile

An open file handle for reading from the file, the agent must make its own duplicate of the file handle.

CreateDataConsumerL(const TVirtualPathPtr &, TContentShareMode)

CAgentData *	CreateDataConsumerL	(	const TVirtualPathPtr &	aVirtualPath,
			TContentShareMode	aShareMode
		)	[pure virtual]

Factory function creates a CAgentData object for reading from a content object

Parameters

const TVirtualPathPtr & aVirtualPath	The content object to read from
TContentShareMode aShareMode	The share mode for opening the file containing the content object

CreateDataConsumerL(RFile &, const TDesC &)

CAgentData *	CreateDataConsumerL	(	RFile &	aFile,
			const TDesC &	aUniqueId
		)	[pure virtual]

Factory function creates a CAgentData object for reading from a content object.

Parameters

RFile & aFile	An open file handle used by the agent to read from the file. The agent MUST make its own duplicate of this file handle, either in the same process or a server process
const TDesC & aUniqueId	The agent specific unique ID of object within the file to read.

CreateImporterL(const TDesC8 &, const CMetaDataArray &, const TDesC &, const TDesC &)

CAgentImportFile *	CreateImporterL	(	const TDesC8 &	aMimeType,
			const CMetaDataArray &	aMetaDataArray,
			const TDesC &	aOutputDirectory,
			const TDesC &	aSuggestedFileName
		)	[pure virtual]

Factory function creates an object that allows the agent to import or transform content. The agent will supply output files where necessary

leave: KErrCANotSupported If the agent does not support importing or transforming content

Parameters

const TDesC8 & aMimeType	The mime type of the file to be imported
const CMetaDataArray & aMetaDataArray	Array of metadata associated with the file to import
const TDesC & aOutputDirectory	Preferred directory to store output files
const TDesC & aSuggestedFileName	Suggested filename for the output file(s)

CreateImporterL(const TDesC8 &, const CMetaDataArray &)

CAgentImportFile *	CreateImporterL	(	const TDesC8 &	aMimeType,
			const CMetaDataArray &	aMetaDataArray
		)	[pure virtual]

Factory function creates an object that allows the agent to import or transform content. The caller will supply output files where necessary

leave: KErrCANotSupported If the agent does not support importing or transforming content

Parameters

const TDesC8 & aMimeType	The mime type of the file to be imported
const CMetaDataArray & aMetaDataArray	Array of metadata associated with the file to import

CreateManagerL()

CAgentManager *

CreateManagerL

(

)

[pure virtual]

Factory function creates an object for performing management functions with this particular agent

CAgentManager objects are stateless so they require no construction parameters.

CreateRightsManagerL()

CAgentRightsManager *

CreateRightsManagerL

(

)

[pure virtual]

Factory function that creates an rights manager object for this agent

leave: KErrCANotSupported If the agent does not provide any rights management functions

NewL(TUid)

CAgentFactory *

NewL

(

TUid

aUid

)

[static]

Create a new instance of a particular agent using its DLL implementation Uid

Parameters

TUid aUid

The Uid of the agent to create an instance of its CAgentFactory

Member Data Documentation

TUid iEcomKey

TUid

iEcomKey

[private]