|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CatalogService
Service can be used to perform all CRUDQ operation on Catalog entities.
Method Summary | |
---|---|
Result |
addCatalogItems(Catalog catalog) Adds the list of catalog items in to the catalog table. |
java.util.List |
deleteCatalogItems(java.util.List catalogItems, boolean softDelete) Delete the catalog item from catalog table. |
java.util.List |
findAvailableCategories(SearchCriteria searchCriteria) Find categories present in catalog. |
java.util.List |
findCatalog(SearchCriteria searchCriteria, int lowerBound, int higherBound, java.lang.String sortField, CatalogSearchCriteria.SortCriteria sortCriteria) Find catalog on the basis of input provided as searchCriteria that has been provided by User, It will return the objects after applying the entity level security. |
java.util.List |
getCatalogDetailsAsMetadata(java.lang.Long catalogID, java.lang.String entityKey, OIMType entityType, OperationContext opContext) To get the details of the catalog items this should be used. |
Catalog |
getCatalogItemDetails(java.lang.Long catalogID, java.lang.String entityKey, OIMType entityType, OperationContext opContext) To get the details of the catalog items this should be used. |
java.util.List |
getCatalogItemDetailsInBulk(java.util.List catalogIDs, java.util.List entityKeys, java.util.List entityTypes) Bulk API to get the details of the catalog items this should be used. |
CategoryTally |
getCategoryWithCount(CatalogSearchCriteria searchCriteria) This is to get the search category ion on the basis of Tags that has been provided by User, All the tags will be AND-ed, It will return the objects after applying the entity level security. |
CategoryTally |
getCategoryWithCountForComplexSearchCriteria(SearchCriteria searchCriteria) This is to get the search category on the basis of any attribute in catalog that has been provided by User, All the criterias will be AND-ed, It will return the objects after applying the entity level security. |
HierarchicalAttributeDetails |
getDetailsOfHierarchicalData(java.lang.Long catalogId, java.lang.String entityKey, OIMType entityType, java.lang.String xpath) This is to get the hierarchical attributes details for the catalog id , for a given xpath. |
HierarchicalAttributes |
getHierarchicalData(java.lang.Long catalogId, java.lang.String entityKey, OIMType entityType, java.lang.String xpath, int startIndex, int endIndex) This is to get the hierarchical attributes or further child nodes for the catalog id , for a given xpath. |
java.util.List |
getMetaDataDefinition(java.lang.String name) To get the catalog meta data on the basis of name. |
CatalogSearchResult |
search(CatalogSearchCriteria searchCriteria, int lowerBound, int higherBound, java.lang.String sortField, CatalogSearchCriteria.SortCriteria sortCriteria) Search on the basis of Tags that has been provided by User, All the tags will be AND-ed, It will return the objects after applying the entity level security. |
Result |
updateCatalogItems(Catalog catalogItems) Update the catalog item, this can also be used to update the tags and metadata value. |
Result |
updateCatalogMetadataValues(java.util.List catalogItemList) Adds/Updates metadata values for catalog items against metadata definitions defined for all the catalog items. |
Method Detail |
---|
Result updateCatalogItems(Catalog catalogItems) throws CatalogException
catalogItems
- The catalog item that has to be updated.CatalogException
- @CatalogException
Result addCatalogItems(Catalog catalog) throws CatalogException
catalog
- Catalog item that will be inserted in to catalog table.CatalogException
java.util.List deleteCatalogItems(java.util.List catalogItems, boolean softDelete)
catalogItems
- List of catalog items that have to be soft deleted.softDelete
- User want to soft delete or hard delete if true it will be soft deleted means isdeleted will be updated to 1 for all the catalog items passed in a listCatalog getCatalogItemDetails(java.lang.Long catalogID, java.lang.String entityKey, OIMType entityType, OperationContext opContext) throws CatalogException
catalogID
- Primary key that uniquely identifies the Catalog Items in catalog tabel.entityKey
- This is the Prmiary key of Entities like Role, Entitlement and TargetResources. when this is passed Entity type should also bepassed.entityType
- This is one of the entity Type like Role, Entitlement or TargetResourceopContext
- operation Context to be passed when in request context else it can be null. This should bepassed in combination with entity key and typeCatalogException
CatalogSearchResult search(CatalogSearchCriteria searchCriteria, int lowerBound, int higherBound, java.lang.String sortField, CatalogSearchCriteria.SortCriteria sortCriteria) throws CatalogException
searchCriteria
- Object that contains the search criteria, It could contain the List of Category or the List of TagslowerBound
- lower bound for searchhigherBound
- higher bound for paginated searchsortField
- Field on which sorting needs to be performed.sortCriteria
- Criteria if its an Ascending or DescendingCatalogException
java.util.List getCatalogItemDetailsInBulk(java.util.List catalogIDs, java.util.List entityKeys, java.util.List entityTypes) throws CatalogException
catalogIDs
- List of primary key that uniquely identifies the Catalog Items in catalog tabel.entityKeys
- List of prmiary key of Entities like Role, Entitlement and TargetResources. when this is passed Entity type should also bepassed.entityTypes
- List of entity Type like Role, Entitlement or TargetResourceCatalogException
Result updateCatalogMetadataValues(java.util.List catalogItemList)
catalogItemList
- Catalog VO List for which metadata values has to be added/updatedjava.util.List getCatalogDetailsAsMetadata(java.lang.Long catalogID, java.lang.String entityKey, OIMType entityType, OperationContext opContext) throws CatalogException
catalogID
- Primary key that uniquely identifies the Catalog Items in catalog tabel.entityKey
- This is the Prmiary key of Entities like Role, Entitlement and TargetResources. when this is passed Entity type should also bepassed.entityType
- This is one of the entity Type like Role, Entitlement or TargetResourceopContext
- operation Context to be passed when in request context else it can be null. This should bepassed in combination with entity key and typeCatalogException
java.util.List getMetaDataDefinition(java.lang.String name) throws CatalogException
name
- Search pattern to get catalog metadataCatalogException
CategoryTally getCategoryWithCount(CatalogSearchCriteria searchCriteria) throws CatalogException
searchCriteria
- Object that contains the search criteria, It could contain the List of Category or the List of TagsCatalogException
java.util.List findCatalog(SearchCriteria searchCriteria, int lowerBound, int higherBound, java.lang.String sortField, CatalogSearchCriteria.SortCriteria sortCriteria) throws CatalogException
searchCriteria
- SearchCriteria
lowerBound
- lower bound for searchhigherBound
- higher bound for paginated searchsortField
- Field on which sorting needs to be performed.sortCriteria
- Criteria if its an Ascending or DescendingCatalogException
java.util.List findAvailableCategories(SearchCriteria searchCriteria) throws CatalogException
searchCriteria
-CatalogException
CategoryTally getCategoryWithCountForComplexSearchCriteria(SearchCriteria searchCriteria) throws CatalogException
searchCriteria
- Object that contains the search criteria, It could contain any of the Catalog attributesCatalogException
HierarchicalAttributes getHierarchicalData(java.lang.Long catalogId, java.lang.String entityKey, OIMType entityType, java.lang.String xpath, int startIndex, int endIndex) throws CatalogException
catalogKey
- Catalog ID for which you have to get the detailsentityKey
- Entity key should be passed in combination with entityType for which you want to have detailsentityType
- entityType @link OIMType It coould be Role Entitlement and Application Instance. This should be passed when entityKey is passed.xpath
- Provide an XPATH query to get the XML nodes. Use the W3 recommendations for XPATHstartIndex
- start index for the no of nodes.endIndex
- endIndex when the no of index are more.CatalogException
HierarchicalAttributeDetails getDetailsOfHierarchicalData(java.lang.Long catalogId, java.lang.String entityKey, OIMType entityType, java.lang.String xpath) throws CatalogException
catalogKey
- Catalog ID for which you have to get the detailsentityKey
- Entity key should be passed in combination with entityType for which you want to have detailsentityType
- entityType @link OIMType It coould be Role Entitlement and Application Instance. This should be passed when entityKey is passed.xpath
- Provide an XPATH query to get the XML nodes. Use the W3 recommendations for XPATHCatalogException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |