Class WSKSource

Description

Encloses a collection of elements which provide detailed information about a single source in the requested folder.

Located in /wsk/WSKSource.class.php (line 6)


	
			
Class Constant Summary
 tSecuredSource = "SecuredSource"
 tStandard = "Standard"
 tTableOfContents = "TableOfContents"
Variable Summary
Method Summary
WSKSource __construct ([int $sourceId = null], [string $name = null], [string $type = null], [boolean $premiumSource = null], [boolean $hasIndex = null], [boolean $hasTOC = null], [boolean $versionable = null], [boolean $isPageBrowsable = null], [WSKCombinabilityList $combinabilityList = null])
Variables
WSKCombinabilityList $combinabilityList (line 79)

Contains the list of combinability strings for this source.

  • access: public
boolean $hasIndex (line 54)

true indicates that this source has an index source associated with it.

  • access: public
boolean $hasTOC (line 60)

true indicates that this source has a table of contents source associated with it.

  • access: public
boolean $isPageBrowsable (line 73)

true indicates that the source page can be browsed.

  • access: public
string $name (line 18)

Contains either the actual name of the publication or the name given to a group of publications.

  • access: public
boolean $premiumSource (line 48)

true indicates that this source is outside your user's subscription and is only available at an additional charge.

  • access: public
int $sourceId (line 12)

Contains a unique identifier value used to represent a specific source in the source directory.

  • access: public
string $type (line 27)

The SecuredSource flag indicates that this source has secured source information that should or must be displayed to your user before they are permitted to access this source. The GetSourceDetails operation is used to retrieve this secured source information.

boolean $versionable (line 66)

true indicates that some documents within this source may have multiple versions available. This can be used to determine when offer the ability to retrieve different document versions.

  • access: public
Methods
Constructor __construct (line 94)

Cosntructs a source object

  • access: public
WSKSource __construct ([int $sourceId = null], [string $name = null], [string $type = null], [boolean $premiumSource = null], [boolean $hasIndex = null], [boolean $hasTOC = null], [boolean $versionable = null], [boolean $isPageBrowsable = null], [WSKCombinabilityList $combinabilityList = null])
  • int $sourceId: Contains a unique identifier value used to represent a specific source in the source directory.
  • string $name: Contains either the actual name of the publication or the name given to a group of publications.
  • string $type: The SecuredSource flag indicates that this source has secured source information that should or must be displayed to your user before they are permitted to access this source. The GetSourceDetails operation is used to retrieve this secured source information.
  • boolean $premiumSource: true indicates that this source is outside your user's subscription and is only available at an additional charge.
  • boolean $hasIndex: true indicates that this source has an index source associated with it.
  • boolean $hasTOC: true indicates that this source has a table of contents source associated with it.
  • boolean $versionable: true indicates that some documents within this source may have multiple versions available. This can be used to determine when offer the ability to retrieve different document versions.
  • boolean $isPageBrowsable: true indicates that the source page can be browsed.
  • WSKCombinabilityList $combinabilityList: Contains the list of combinability strings for this source.
Class Constants
tSecuredSource = "SecuredSource" (line 37)
tStandard = "Standard" (line 32)
tTableOfContents = "TableOfContents" (line 42)

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