Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions
Soap_Api_Metadata_Service Class Reference
Inheritance diagram for Soap_Api_Metadata_Service:

Public Member Functions

 __construct ($assetid=0)
 
 getFunctionList ()
 
 SetMetadataSchema ($request)
 
 RegenerateMetadataSchema ($request)
 
 RegenerateMetadataAsset ($request)
 
 SetAssetMetadata ($request)
 
 SetMultipleMetadataFields ($request)
 
 SetMetadataFieldDefaultValue ($request)
 
 GetMetadataValueByIDs ($request)
 
 GetSchemasOnAsset ($request)
 
 GetMetadataFieldsOfSchema ($request)
 
 GetMetadataFieldValues ($request)
 

Static Public Member Functions

static getComplexElements ($func_list=Array())
 
static getSimpleRestrictedTypes ($func_list=Array())
 
static getComplexTypes ($func_list=Array())
 

Detailed Description

Definition at line 31 of file soap_api_metadata_service.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file soap_api_metadata_service.inc.

Member Function Documentation

static getComplexElements (   $func_list = Array())
static

getComplexType

Returns
array public

Definition at line 556 of file soap_api_metadata_service.inc.

static getComplexTypes (   $func_list = Array())
static

getComplexTypes: return all the complex types used by the API

Returns
array public

Definition at line 695 of file soap_api_metadata_service.inc.

getFunctionList ( )

Returns a function list of the asset let the children handle this

Returns
string private
See Also
Asset::_getName()

Definition at line 55 of file soap_api_metadata_service.inc.

GetMetadataFieldsOfSchema (   $request)

Description: This operation will return the metadata fields ids which belong to a metadata schema

Parameters
array$requestThe request information 
Array (
     'SchemaID'         => [The metadata schema in query],
       )
Returns
void public

Definition at line 475 of file soap_api_metadata_service.inc.

GetMetadataFieldValues (   $request)

Description: This operation will return the values of the field names which belong to an asset

Parameters
array$requestThe request information 
Array (
    'AssetID'           => [The asset which has the metadata field],
    'FieldNames'        => [The metadata field names],
       )
Returns
void public

Definition at line 511 of file soap_api_metadata_service.inc.

GetMetadataValueByIDs (   $request)

Description: This operation will return the metadata value for a metadata field of an asset

Parameters
array$requestThe request information 
Array (
     'AssetID'          => [The Asset in query],
     'FieldID'          => [The metadata field ID],
       )
Returns
void public

Definition at line 399 of file soap_api_metadata_service.inc.

GetSchemasOnAsset (   $request)

Description: This operation will return the metadata schemas applied on the asset

Parameters
array$requestThe request information 
Array (
     'AssetID'          => [The Asset in query],
       )
Returns
void public

Definition at line 437 of file soap_api_metadata_service.inc.

static getSimpleRestrictedTypes (   $func_list = Array())
static

getSimpleRestrictedTypes

Returns
array public

Definition at line 669 of file soap_api_metadata_service.inc.

RegenerateMetadataAsset (   $request)

Description: This operation will regenerate metadata for the specified asset

Parameters
array$requestThe request information 
Array (
     'AssetID'      => [The asset to regenerate metadata for],
       )
Returns
void public

Definition at line 190 of file soap_api_metadata_service.inc.

RegenerateMetadataSchema (   $request)

Description: This operation will regenerate metadata for all asset which has a metadata schema applied on

Parameters
array$requestThe request information 
Array (
     'SchemaID'     => [The metadata scheme being applied],
       )
Returns
void public

Definition at line 146 of file soap_api_metadata_service.inc.

SetAssetMetadata (   $request)

Description: This operation will set the value for a metadata field of an asset

Parameters
array$requestThe request information 
Array (
     'AssetID'      => [The asset to regenerate metadata for],
     'FieldID'      => [The metadata field id],
     'NewValue'     => [The new value for the field],
       )
Returns
void public

Definition at line 229 of file soap_api_metadata_service.inc.

SetMetadataFieldDefaultValue (   $request)

Description: This operation will set the default value for a metadata field

Parameters
array$requestThe request information 
Array (
     'FieldID'          => [The metadata field id],
     'NewDefaultValue'  => [The new default value for the field],
       )
Returns
void public

Definition at line 352 of file soap_api_metadata_service.inc.

SetMetadataSchema (   $request)

Description: This operation will apply or revoke a metadata schema from an asset

Parameters
array$requestThe request information 
Array (
     'AssetID'      => [The asset to apply the schema on],
     'SchemaID'     => [The metadata scheme being applied],
     'Grant'        => [Apply, Deny, Revoke],
       )
Returns
void public

Definition at line 88 of file soap_api_metadata_service.inc.

SetMultipleMetadataFields (   $request)

Description: This operation will set the value for a metadata fields of an asset

Parameters
array$requestThe request information 
Array (
     'AssetID'      => [The asset to regenerate metadata for],
     'MetadataInfo' => [metadata field id/value pairs],
       )
Returns
void public

Definition at line 288 of file soap_api_metadata_service.inc.

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