public interface RequestProfileService
Modifier and Type | Method and Description |
---|---|
RequestProfile |
createRequestProfile(RequestProfile profile)
Creates Request profile.
|
RequestProfile |
deleteEntitiesFromRequestProfiles(RequestProfileEntity entity)
This API is used to delete entity references in all request profiles,
when an entity is deleted from the system.
|
void |
deleteRequestProfile(RequestProfile profile)
Deletes the profile with given name.
|
RequestProfile |
getRequestProfile(java.lang.String name)
Get the profile with given name.
|
RequestProfile |
modifyRequestProfile(RequestProfile profile)
Modify the given profile.
|
java.util.List |
searchRequestProfiles(java.lang.String namePattern,
java.util.Set retAttrs,
java.util.Map configParams)
Get the list of profiles matching the given name pattern.
|
RequestProfile createRequestProfile(RequestProfile profile) throws RequestProfileServiceException
profile
- Request profile object that needs to be createdRequestProfileServiceException
- if creation fails or profile with same name already existsjava.util.List searchRequestProfiles(java.lang.String namePattern, java.util.Set retAttrs, java.util.Map configParams) throws RequestProfileServiceException
namePattern
- profile name pattern with "*" as wild character.retAttrs
- attributes that need to be populated in RequestProfile result
object.
Below is the list of allowed search parameters
RequestProfileConstants.PROFILE_NAME
, Profile name.
RequestProfileConstants.PROFILE_DESCRIPTION
,Description of the profile.
RequestProfileConstants.PROFILE_KEY
, Profile key which is unique.
RequestProfileConstants.UPDATED_ON
, Timestamp when profile is updated.
RequestProfileConstants.UPDATED_BY
, User who updated the profile.
RequestProfileConstants.CREATED_BY
, User who created the profile.
RequestProfileConstants.CREATED_ON
, Timestamp when profile is created.
configParams
- Additional configuration parameters for search results
like sorting, pagination parameters
SEARCH_STARTROW
, Start row of the search result
SEARCH_ENDROW
, End row of the search result
SEARCH_SORTBY
, Column on which results should be sorted on
SEARCH_SORTORDER
, Sort Order, allowed values are ASCENDING or DESCENDING
configParams
- RequestProfileServiceException
- if search failsRequestProfile modifyRequestProfile(RequestProfile profile) throws RequestProfileServiceException
profile
- modified profile object that needs to be savedRequestProfileServiceException
- if modification failsvoid deleteRequestProfile(RequestProfile profile) throws RequestProfileServiceException
profile
- profile object that needs to be deleted.RequestProfileServiceException
- if deletion failsRequestProfile getRequestProfile(java.lang.String name) throws RequestProfileServiceException
name
- name of the profile.RequestProfileServiceException
- if search failsRequestProfile deleteEntitiesFromRequestProfiles(RequestProfileEntity entity) throws RequestProfileServiceException
entity
- entity object that contains the entity key and the type that
need to be deleted from all request profiles.RequestProfileServiceException
- if search fails