Class WSKDocumentContainer

Description

Encloses the documentId and document elements which encapsulates the search/retrieve result, including a document excerpt and a unique document identifier.

Located in /wsk/WSKDocumentContainer.class.php (line 7)


	
			
Variable Summary
Method Summary
WSKDocumentContainer __construct ([string $documentId = null], [string $document = null], [WSKDocumentVersionList $documentVersionList = null], [WSKSourceContextInfo $sourceContextInfo = null], [WSKShepardsSignal $shepardsSignal = null])
Variables
string $document (line 19)

Contains the document (Base 64).

  • access: public
string $documentId (line 13)

Contains a unique identifier that independently represents a document for up to 48 hours.

  • access: public
WSKDocumentVersionList $documentVersionList (line 25)

Encloses zero or more documentVersion elements, each of which identifies a document version.

  • access: public
WSKShepardsSignal $shepardsSignal (line 36)

Encloses the Shepard's Signal information if requested.

  • access: public
WSKSourceContextInfo $sourceContextInfo (line 30)
  • access: public
Methods
Constructor __construct (line 46)

Constructs a documentContainer object

  • access: public
WSKDocumentContainer __construct ([string $documentId = null], [string $document = null], [WSKDocumentVersionList $documentVersionList = null], [WSKSourceContextInfo $sourceContextInfo = null], [WSKShepardsSignal $shepardsSignal = null])

Documentation generated on Thu, 10 Dec 2009 15:22:28 +0100 by phpDocumentor 1.4.1