Class

# VMware_VCloud_SDK_AdminCatalog

class VMware_VCloud_SDK_AdminCatalog extends VMware_VCloud_SDK_Abstract

## Methods

string | getEntityId() Get vCloud ID of the vCloud resource entity from its data object. | from VMware_VCloud_SDK_Abstract
VMware_VCloud_API_ReferenceType | getAdminCatalogRef() Get a reference to a VMware vCloud catalog entity in an administrator view. |
VMware_VCloud_API_AdminCatalogType | getAdminCatalog() Get a VMware vCloud catalog entity in an administrator view. |
string | getId() Constructs vCloud ID of this catalog from its UUID. |
VMware_VCloud_API_LinkType|null | getCatalogRef() Get a reference to a VMware vCloud catalog entity. |
VMware_VCloud_API_CatalogType | getCatalog() Get a VMware vCloud catalog entity. |
VMware_VCloud_API_LinkType|null | getAdminOrgRef() Get the link to the container entity of the catalog in an administrator view. |
VMware_VCloud_API_AdminOrgType|null | getAdminOrg() Get the container entity of the catalog in an administrator view. |
null | publish(boolean $ispub = true) Publish a catalog. |
null | unpublish() Unpublish a catalog. |
VMware_VCloud_API_AdminCatalogType | modify(VMware_VCloud_API_AdminCatalogType $catalog) Modify a catalog. |
null | delete() Delete a catalog. |
array | getCatalogItemRefs(string $name = null) Get references to catalog items in this catalog entity. |
array | getCatalogItems(string $name = null) Get all catalog items or catalog items with the given name in this catalog. |
VMware_VCloud_API_OwnerType | getOwner() Returns owner of the catalog. |
null | changeOwner(VMware_VCloud_API_OwnerType $owner) Changes owner of the catalog. |
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null | getMetadata(string $key = null, string $domain = null) Get metadata associated with the catalog or metadata associated with the catalog for the specified key in the specified domain. |
VMware_VCloud_API_TaskType | mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for the catalog with the information provided. |
VMware_VCloud_API_TaskType | setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null) Sets the metadata for the particular key in the specified domain for the catalog to the value provided. |
VMware_VCloud_API_TaskType | deleteMetadataByKey(string $key, string $domain = null) Deletes the metadata for the particular key in the specified domain for the catalog. |
VMware_VCloud_SDK_Catalog|null | getSdkCatalog() Return an alternate SDK catalog object. |
| publishToExternalOrganizations(VMware_VCloud_API_PublishExternalCatalogParamsType $params) Publish a catalog to external orgs. |
| subscribeToExternalCatalog(VMware_VCloud_API_ExternalCatalogSubscriptionParamsType $params) Subscribe to an external catalog. |

## Details

###
in VMware_VCloud_SDK_Abstract at line 85
`public string getEntityId()`

Get vCloud ID of the vCloud resource entity from its data object.

#### Return Value

string |

###
at line 10
`public VMware_VCloud_API_ReferenceType getAdminCatalogRef()`

Get a reference to a VMware vCloud catalog entity in an administrator view.

#### Return Value

VMware_VCloud_API_ReferenceType |

###
at line 22
`public VMware_VCloud_API_AdminCatalogType getAdminCatalog()`

Get a VMware vCloud catalog entity in an administrator view.

#### Return Value

VMware_VCloud_API_AdminCatalogType |

###
at line 33
`public string getId()`

Constructs vCloud ID of this catalog from its UUID.

#### Return Value

string |

###
at line 44
`public VMware_VCloud_API_LinkType|null getCatalogRef()`

Get a reference to a VMware vCloud catalog entity.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 56
`public VMware_VCloud_API_CatalogType getCatalog()`

Get a VMware vCloud catalog entity.

#### Return Value

VMware_VCloud_API_CatalogType |

###
at line 69
`public VMware_VCloud_API_LinkType|null getAdminOrgRef()`

Get the link to the container entity of the catalog in an administrator view.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 80
`public VMware_VCloud_API_AdminOrgType|null getAdminOrg()`

Get the container entity of the catalog in an administrator view.

#### Return Value

VMware_VCloud_API_AdminOrgType|null |

###
at line 93
`public null publish(boolean $ispub = true)`

Publish a catalog.

#### Parameters

boolean | $ispub |

#### Return Value

null |

###
at line 108
`public null unpublish()`

Unpublish a catalog.

#### Return Value

null |

###
at line 120
`public VMware_VCloud_API_AdminCatalogType modify(VMware_VCloud_API_AdminCatalogType $catalog)`

Modify a catalog.

#### Parameters

VMware_VCloud_API_AdminCatalogType | $catalog |

#### Return Value

VMware_VCloud_API_AdminCatalogType |

###
at line 132
`public null delete()`

Delete a catalog.

#### Return Value

null |

###
at line 146
`public array getCatalogItemRefs(string $name = null)`

Get references to catalog items in this catalog entity.

#### Parameters

string | $name | Name of the catalog item to get. If null, returns all

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 161
`public array getCatalogItems(string $name = null)`

Get all catalog items or catalog items with the given name in this catalog.

#### Parameters

string | $name | Name of the catalog item to get. If null, returns all

#### Return Value

array | VMwareVCloudAPI_CatalogItemType object array

###
at line 173
`public VMware_VCloud_API_OwnerType getOwner()`

Returns owner of the catalog.

#### Return Value

VMware_VCloud_API_OwnerType |

###
at line 186
`public null changeOwner(VMware_VCloud_API_OwnerType $owner)`

Changes owner of the catalog.

#### Parameters

VMware_VCloud_API_OwnerType | $owner |

#### Return Value

null |

###
at line 203
`public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)`

Get metadata associated with the catalog or metadata associated with the catalog for the specified key in the specified domain.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null |

###
at line 215
`public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)`

Merges the metadata for the catalog with the information provided.

#### Parameters

VMware_VCloud_API_MetadataType | $meta |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 234
`public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)`

Sets the metadata for the particular key in the specified domain for the catalog to the value provided.

Note: This will replace any existing metadata information.

#### Parameters

string | $key |
VMware_VCloud_API_MetadataValueType | $value |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 253
`public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)`

Deletes the metadata for the particular key in the specified domain for the catalog.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 265
`public VMware_VCloud_SDK_Catalog|null getSdkCatalog()`

Return an alternate SDK catalog object.

#### Return Value

VMware_VCloud_SDK_Catalog|null |

###
at line 278
`public publishToExternalOrganizations(VMware_VCloud_API_PublishExternalCatalogParamsType $params)`

Publish a catalog to external orgs.

#### Parameters

VMware_VCloud_API_PublishExternalCatalogParamsType | $params |

###
at line 291
`public subscribeToExternalCatalog(VMware_VCloud_API_ExternalCatalogSubscriptionParamsType $params)`

Subscribe to an external catalog.

#### Parameters

VMware_VCloud_API_ExternalCatalogSubscriptionParamsType | $params |