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

Public Member Functions

 __construct ($assetid=0)
 
 getFunctionList ()
 
 CreateAssetLink ($request)
 
 DeleteAssetLink ($request)
 
 GetAllChildLinks ($request)
 
 GetDependantChildren ($request)
 
 GetDependantParents ($request)
 
 GetLinks ($request)
 
 MoveLink ($request)
 
 UpdateLink ($request)
 
 GetChildren ($request)
 
 GetParents ($request)
 
 GetParentsUnderTree ($request)
 
 GetLinkByAsset ($request)
 
 GetLinkLineages ($request)
 

Static Public Member Functions

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

Detailed Description

Definition at line 31 of file soap_api_link_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_link_service.inc.

Member Function Documentation

CreateAssetLink (   $request)

Description: This operation will create link between two assets

Parameters
string$requestThe request information
Array (
    'MajorID'       => [The asset id of the major asset],
    'MinorID'       => [The asset id of the major asset],
        'LinkType'      => [The link type being created],
        'LinkValue'     => [Value of the new link],
        'SortOrder'     => [Minor Asset position under the Major],
        'IsDependant'   => [Whether the minor asset is dependent on the major]
    'IsExclusive'   => [Whether the major asset is the minor's only parent]
       )
Returns
void public

Definition at line 96 of file soap_api_link_service.inc.

DeleteAssetLink (   $request)

Description: This operation will delete a link based on the LinkID

Parameters
array$requestThe request information 
Array (
     'LinkID'    => [The link ID to be deleted],
       )
Returns
void public

Definition at line 140 of file soap_api_link_service.inc.

GetAllChildLinks (   $request)

Description: This operation will return all child links

Parameters
array$requestThe request information 
Array (
    'AssetID'   => [The Asset to find links under],
    'LinkType'  => [The type of link]
       )
string$assetidthe id of the asset being deleted
Returns
void public

Definition at line 198 of file soap_api_link_service.inc.

GetChildren (   $request)

Description: This function returns the children of a specific asset base on criterions

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'           => [assetid of node],
    'TypeCode'          => [type code of the chilren asset],
    'StrictTypeCode'    => [strict type code or not],
    'Dependant'         => [dependant or not],
    'SortBy'            => [asset attribute],
    'PermissionLevel'   => [Read, Write, Admin],
    'EffectiveAccess'   => [effective permission],
    'MinDepth'          => [minimum child level],
    'MaxDepth'          => [maximum child level],
    'DirectShadowsOnly' => [whether to get only shadow asset],
    'LinkValueWanted'   => [link value],
       )
Returns
void public

Definition at line 495 of file soap_api_link_service.inc.

static getComplexElements (   $func_list = Array())
static

getComplexType

Returns
array public

Definition at line 777 of file soap_api_link_service.inc.

static getComplexTypes (   $func_list = Array())
static

getComplexTypes: return all the complex types used by the API

Returns
array public

Definition at line 969 of file soap_api_link_service.inc.

GetDependantChildren (   $request)

Description: This operation will return dependant children of the specified criteria

Parameters
array$requestThe request information 
Array (
    'AssetID'           => [The Asset to find dependant children for],
    'TypeCode'          => [The desired type code of dependants],
    'StrictTypeCode'    => [Strict Type Code, TRUE | FALSE],
       )
Returns
void public

Definition at line 247 of file soap_api_link_service.inc.

GetDependantParents (   $request)

Description: This operation will return dependant parents of the specified criteria

Parameters
array$requestThe request information 
Array (
    'AssetID'               => [The Asset to find dependant children for],
    'TypeCode'              => [The desired type code of dependants],
    'StrictTypeCode'        => [Strict Type Code, TRUE | FALSE],
    'IncludeAllDependants'  => [Whether to include all dependants or only top level dependant parents(FALSE)]
       )
Returns
void public

Definition at line 289 of file soap_api_link_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_link_service.inc.

GetLinkByAsset (   $request)

Description: This function returns all the links between two asset

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'           => [assetid of node],
    'OtherAssetID'      => [type code of the asset on the other side of the link],
    'LinkType'          => [Desired link type],
    'LinkValue'         => [The Value of the link],
    'SideOfLink'        => [Which side of the link the first assetid is on, Major or Minor],
    'IsDependant'       => [The dependant status for all the links must be this (if not null)],
    'IsExclusive'       => [The exclusive status for all the links must be this (if not null)],
       )
Returns
void public

Definition at line 672 of file soap_api_link_service.inc.

GetLinkLineages (   $request)

This function return link lineages by root node.

Returns
array public

Definition at line 721 of file soap_api_link_service.inc.

GetLinks (   $request)

Description: This operation will return dependant parents of the specified criteria

Parameters
array$requestThe request information 
Array (
    'AssetID'               => [The Asset to find links for],
    'LinkType'              => [Desired link type]
    'TypeCode'              => [The desired type code of linked assets],
    'StrictTypeCode'        => [Strict Type Code, TRUE | FALSE],
    'SideOfLink'            => [Major or Minor link],
    'LinkValue'             => [Value of the link],
    'Dependant'             => [If not null, either return non-depandant or dependant, if is null return both],
    'Exclusive'             => [If not null, either return non-exclusive or exclusive, if is null return both],
    'SortBy'                => [Sort By a field in asset table],
    'PermissionLevel'       => [Read, Write, Admin],
    'Effective'             => [If effective permissions should be considered or not],
       )
Returns
void public

Definition at line 339 of file soap_api_link_service.inc.

GetParents (   $request)

Description: This function returns all the parent of a specific asset

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'           => [assetid of node],
    'TypeCode'          => [type code of the chilren asset],
    'StrictTypeCode'    => [strict type code or not],
    'Dependant'         => [dependant or not],
    'SortBy'            => [asset attribute],
    'PermissionLevel'   => [Read, Write, Admin],
    'EffectiveAccess'   => [effective permission],
    'MinDepth'          => [minimum child level],
    'MaxDepth'          => [maximum child level],
    'DirectShadowsOnly' => [whether to get only shadow asset],
    'LinkValueWanted'   => [link value],
       )
Returns
void public

Definition at line 559 of file soap_api_link_service.inc.

GetParentsUnderTree (   $request)

Get Parents Under Tree

Parameters
$request
Returns
unknown_type

Definition at line 603 of file soap_api_link_service.inc.

static getSimpleRestrictedTypes (   $func_list = Array())
static

getSimpleRestrictedTypes

Returns
array public

Definition at line 1052 of file soap_api_link_service.inc.

MoveLink (   $request)

Description: This operation will move a link under a new parent asset

Parameters
array$requestThe request information 
Array (
    'LinkID'                => [The ID of the link],
    'LinkType'              => [Desired link type]
    'ToParentID'            => [New parent of the minor asset of the link],
    'ToParentPosition'      => [The position under the new parent],
       )
Returns
void public

Definition at line 402 of file soap_api_link_service.inc.

UpdateLink (   $request)

Description: This operation will update an existing link

Parameters
array$requestThe request information 
Array (
    'LinkID'                => [The ID of the link],
    'LinkType'              => [Desired link type]
    'LinkValue'             => [The Value of the link],
    'SortOrder'             => [The position in the links list that this link should take, if less than zero places at end of list],
       )
Returns
void public

Definition at line 447 of file soap_api_link_service.inc.

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