oracle.iam.platformservice.api

Interface LookupQueryService

public interface LookupQueryService

Service interface to query admin roles defined in an OIM installation and manage scoped user memberships in these roles.

Method Summary

Modifier and Type	Method and Description
java.util.Map	getDependantAttrValuesExceptFormData(java.lang.String attrName, java.lang.String entityType, java.util.Map params) Returns dependent attribute values in the query but does not return values for type Form Data supported types: REQUESTER_INFORMATION, RESOURCE_OBJECT_INFORMATION, ORGANIZATION_DATA FORM_DATA type needs to be handled in the client/UI layer
java.util.Map	getQueryElements(java.lang.String attrName, java.lang.String entityType) Returns various elements of the lookup query for attrname Keys in the map: SAVE_COLUMN, DISPLAY_COLUMN, QUERY_ATTRS, RESULTS_TABLE_ATTRS
java.util.List	getResults(java.lang.String attrName, java.lang.String entityType, java.util.List queryValues, java.util.Map dependentAttrValues, java.util.Map controls) Returns the results after executing the query

Method Detail

getQueryElements

java.util.Map getQueryElements(java.lang.String attrName,
                               java.lang.String entityType)

Returns various elements of the lookup query for attrname Keys in the map: SAVE_COLUMN, DISPLAY_COLUMN, QUERY_ATTRS, RESULTS_TABLE_ATTRS

Returns:

map containing various query elements.

getResults

java.util.List getResults(java.lang.String attrName,
                          java.lang.String entityType,
                          java.util.List queryValues,
                          java.util.Map dependentAttrValues,
                          java.util.Map controls)

Returns the results after executing the query

Parameters:

queryValues - values specified in the QUERy on the UI in the form of single, un-nested searchcriteria

dependentAttrValues - contains values from the form fields, as well as other contxtual attributes

controls - other search controls like for sorting, paging

Returns:

results of query execution

getDependantAttrValuesExceptFormData

java.util.Map getDependantAttrValuesExceptFormData(java.lang.String attrName,
                                                   java.lang.String entityType,
                                                   java.util.Map params)

Returns dependent attribute values in the query but does not return values for type Form Data supported types: REQUESTER_INFORMATION, RESOURCE_OBJECT_INFORMATION, ORGANIZATION_DATA FORM_DATA type needs to be handled in the client/UI layer

Parameters:

attrName - values specified in the QUERy on the UI in the form of single, un-nested searchcriteria

entityType - contains values from the form fields, as well as other contxtual attributes

params - Other context details like objectkey "OBJECT_KEY" for RESOURCE_OBJECT_INFORMATION

Returns:

Map with values replaced for dependent attributes except for FORM_DATA