ComponentCatalogManagement Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | ComponentCatalogManagement.h |
– listAllComponentTypesCatalog
Get a list of all component types with minimal information.
- (CloudResponse *)listAllComponentTypesCatalogReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
ComponentCatalogManagement.h
– listAllDetailsOfComponentTypesCatalog
Get a list of all component types with full detailed information.
- (CloudResponse *)listAllDetailsOfComponentTypesCatalogReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
ComponentCatalogManagement.h
– listComponentTypeDetails:
Get a complete description of a component type for a specific component.
- (CloudResponse *)listComponentTypeDetails:(NSString *)componentIdParameters
componentId |
the identifier for the component to get information for. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
ComponentCatalogManagement.h
– createCustomComponent:
Create a new custom component. The dimension and version attributes are used for determining if the component exists. If not, a new component is created which auto-generated id results the concatenation of dimension and version values.
- (CloudResponse *)createCustomComponent:(ComponentCatalog *)createComponentCatalogParameters
createComponentCatalog |
the component type to be added to the catalog |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
ComponentCatalogManagement.h
– updateAComponent:OnComponent:
Update a component type definition by creating a brand new component which definition is composed by the origin component data plus the requested changes having in mind that minor version info (version attribute) is incremented by 1.
- (CloudResponse *)updateAComponent:(ComponentCatalog *)createComponentCatalog OnComponent:(NSString *)componentIdParameters
createComponentCatalog |
the component type to be updated in the catalog. |
|---|---|
componentId |
the identifier for the component to be updated. |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
ComponentCatalogManagement.h