Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
WSKSource Class Reference

Public Member Functions

 __construct ($sourceId=null, $name=null, $type=null, $premiumSource=null, $hasIndex=null, $hasTOC=null, $versionable=null, $isPageBrowsable=null, $combinabilityList=null)

Data Fields

 $sourceId
 $name
 $type
const tStandard = "Standard"
const tSecuredSource = "SecuredSource"
const tTableOfContents = "TableOfContents"
 $premiumSource
 $hasIndex
 $hasTOC
 $versionable
 $isPageBrowsable
 $combinabilityList

Detailed Description

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

See also:
WSKGetSourceDetailsResponse

Constructor & Destructor Documentation

__construct ( sourceId = null,
name = null,
type = null,
premiumSource = null,
hasIndex = null,
hasTOC = null,
versionable = null,
isPageBrowsable = null,
combinabilityList = null 
)

Cosntructs a source object

Parameters:
int$sourceIdContains a unique identifier value used to represent a specific source in the source directory.
string$nameContains either the actual name of the publication or the name given to a group of publications.
string$typeThe 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$premiumSourcetrue indicates that this source is outside your user's subscription and is only available at an additional charge.
boolean$hasIndextrue indicates that this source has an index source associated with it.
boolean$hasTOCtrue indicates that this source has a table of contents source associated with it.
boolean$versionabletrue 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$isPageBrowsabletrue indicates that the source page can be browsed.
WSKCombinabilityListContains the list of combinability strings for this source.

Field Documentation

$combinabilityList
$hasIndex
$hasTOC
$isPageBrowsable
$name
$premiumSource
$sourceId
$type
$versionable
const tSecuredSource = "SecuredSource"
See also:
$type
const tStandard = "Standard"
See also:
$type
const tTableOfContents = "TableOfContents"
See also:
$type

The documentation for this class was generated from the following file: