oracle.iam.catalog.api

Interface MetaDataDefinitionManager

public interface MetaDataDefinitionManager

For handling all the information specific to metadata definition will be exposed

Since:

11.1.2.0.0

Method Summary

Modifier and Type	Method and Description
Result	addMetadata(MetaDataDefinition metadatasDataDefinition) Add metadata definition that will be applied to all the catalog Item.
Result	deleteMetadata(MetaDataDefinition metadatasDataDefinition) Delete metadataDefinition, this will dlete value from the CATALOG_EMTADAT_DATA first and then will dlete data from catalog_metadata
java.util.Map	getCollectionOfSortingColumnForCatalog() This will give the list of all the columns on which sorting can be applied for catalog search.
java.util.List	getMetadataForCatalogItem() To get what all metadata has been associated with Catalog items.
java.util.List	search(SearchCriteria searchCriteria) To get all metadata for a catalog with provided search criteria.
Result	updateMetadata(MetaDataDefinition metaDatasDataDefinitions) Update metadta fileds that will be applied to all the catalog items, irrespective of the Entity type.

Method Detail

updateMetadata

Result updateMetadata(MetaDataDefinition metaDatasDataDefinitions)
               throws CatalogException

Update metadta fileds that will be applied to all the catalog items, irrespective of the Entity type.

Parameters:

metaDatasDataDefinitions - MetaDataDefinintion that needs to be updated.

Returns:

True as statusFlag value of result Attribute if the metadta has been successfully updated or false if not and then Message will contain the reason and Throwable will contain the real exception message

Throws:

CatalogException

addMetadata

Result addMetadata(MetaDataDefinition metadatasDataDefinition)
            throws CatalogException

Add metadata definition that will be applied to all the catalog Item.

Parameters:

metadatasDataDefinitions - metadata Definition that has to be added and applied to all the Catalog Items

Returns:

List of result object if the metadata definition got added successfully id will be returned and successful flag will have value as true other wise successful flag will have value as false and Throwable will contain the actual exception.

Throws:

CatalogException

deleteMetadata

Result deleteMetadata(MetaDataDefinition metadatasDataDefinition)
               throws CatalogException

Delete metadataDefinition, this will dlete value from the CATALOG_EMTADAT_DATA first and then will dlete data from catalog_metadata

Parameters:

metadatasDataDefinitions - metaDataDefinition that needs to be deleted.

Returns:

Result object will have true value for statusFlag if the deletion was successfull and false if the deleting is a failure and Throwable will contain the real exception

Throws:

CatalogException

getMetadataForCatalogItem

java.util.List getMetadataForCatalogItem()
                                  throws CatalogException

To get what all metadata has been associated with Catalog items. This will have OOTB Metadat as well as UDF metadata

Returns:

List of MetaDataDefinition object.

Throws:

CatalogException

getCollectionOfSortingColumnForCatalog

java.util.Map getCollectionOfSortingColumnForCatalog()
                                              throws CatalogException

This will give the list of all the columns on which sorting can be applied for catalog search.

Returns:

Map where key is the backend column name and value is the display name of the column that can be displayed as LOV

Throws:

CatalogException

search

java.util.List search(SearchCriteria searchCriteria)
               throws CatalogException

To get all metadata for a catalog with provided search criteria. Use 0/1 for boolean(false/true) value for following columns SEARCHABLE SORTABLE IS_UDF CERTIFIABLE Following is sample code to set the SearchCriteria. SearchCriteria sc1 = new SearchCriteria("DISPLAY_NAME", "Test",SearchCriteria.Operator.EQUAL); SearchCriteria sc2 = new SearchCriteria("CERTIFIABLE", '1',SearchCriteria.Operator.EQUAL); SearchCriteria sc3 = new SearchCriteria(sc1, sc2,SearchCriteria.Operator.AND); Sample code to get all metadata. SearchCriteria sc1 = new SearchCriteria("DISPLAY_NAME", "Test",SearchCriteria.Operator.EQUAL); For OIM installed with Ldap based user store,now user can pass null as search criteria. At present Entity considered in this mode is Role. Only Searchable attributes of role will be returned by API. It will be OOTB column and UDF as well.

Parameters:

searchCriteria - Search Criteria

Returns:

List of MetaDataDefinition object.

Throws:

CatalogException

Since:

11.1.2.1.0