|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Deprecated.
@Deprecated
public interface RequestTemplateService
This class is used to manage request templates. This service allows
This class is no longer supported. RequestProfile needs to be used as alternative to request templates. Please refer to product documentation for further information.
Method Summary | |
---|---|
RequestTemplate |
createTemplate(RequestTemplate template) Deprecated. Creates Request template. |
RequestTemplate |
createTemplate(RequestTemplate template, java.util.List roleKeys) Deprecated. Creates Request template and assigns it to given list of roles. |
void |
deleteTemplate(java.lang.Long templateKey, java.sql.Timestamp updatedTimestamp) Deprecated. Deletes the template with given key. |
java.util.List |
getGrantedRolesWithTemplate(java.lang.Long templateKey) Deprecated. Get the list of roles that are granted with the given template. |
RequestTemplate |
getTemplate(java.lang.String name) Deprecated. Get the template with given name |
java.util.List |
getTemplateNames(java.lang.String modelName) Deprecated. Get the list of templates matching the given name pattern and model name matching model name pattern. |
java.util.List |
getTemplates(java.lang.String namePattern, java.lang.String modelNamePattern) Deprecated. Get the list of templates matching the given name pattern and model name matching model name pattern. |
void |
grantTemplateToRoles(java.lang.Long templateKey, java.util.List roleKeys) Deprecated. Grants the given template to given roles. |
RequestTemplate |
modifyTemplate(RequestTemplate template) Deprecated. Modify the given template. |
void |
revokeTemplateFromRoles(java.lang.Long templateKey, java.util.List roleKeys) Deprecated. Revokes the template access from given roles. |
java.util.List |
searchTemplates(RequestTemplateSearchCriteria searchCriteria, java.util.Map configParams) Deprecated. Returns a list of request templates that match the given search criteria. |
Method Detail |
---|
RequestTemplate createTemplate(RequestTemplate template) throws RequestServiceException
template
- template object that needs to be createdRequestServiceException
- if data validation or creation failsRequestTemplate createTemplate(RequestTemplate template, java.util.List roleKeys) throws RequestServiceException
template
- template object that needs to be createdroleKeys
- list of roles to which the template needs to be assigned.RequestServiceException
- if data validation or creation failsjava.util.List getTemplates(java.lang.String namePattern, java.lang.String modelNamePattern) throws RequestServiceException
namePattern
- - template name pattern with "*" as wild charactermodelNamePattern
- - model name pattern with "*" as wild characterRequestServiceException
- if search failsjava.util.List getTemplateNames(java.lang.String modelName) throws RequestServiceException
modelName
-RequestServiceException
- if search failsjava.util.List searchTemplates(RequestTemplateSearchCriteria searchCriteria, java.util.Map configParams) throws RequestServiceException
searchCriteria
- Value object to specify the Request Template search criteria Below is the list of allowed search parameters
REQUEST_TEMPLATE_NAME
, Name of the request templateMODEL_NAME
, Request Model Name.configParams
- Additional configurational parameters for search results
SEARCH_STARTROW
, Start row of the search resultSEARCH_ENDROW
, End row of the search resultSEARCH_SORTBY
, Column on which results should be sorted onSEARCH_SORTORDER
, Sort Order, allowed values are ASCENDING or DESCENDINGRequestServiceException
- if data validation, search failsRequestTemplate modifyTemplate(RequestTemplate template) throws RequestServiceException
template
- modified template object that needs to be savedRequestServiceException
- if data validation or modification failsvoid deleteTemplate(java.lang.Long templateKey, java.sql.Timestamp updatedTimestamp) throws RequestServiceException
templateKey
- key of the template that needs to be deleted.updatedTimestamp
- - the updatedTimestamp field of the request template. This can be obtained as requestTemplate.getLastUpdatedTimestamp();
RequestServiceException
- if data validation or deletion failsjava.util.List getGrantedRolesWithTemplate(java.lang.Long templateKey) throws RequestServiceException
templateKey
- key of the templateRequestServiceException
- if search for granted role failsvoid grantTemplateToRoles(java.lang.Long templateKey, java.util.List roleKeys) throws RequestServiceException
templateKey
- key of the template that needs to be granted to the roleroleKeys
- list of the role keysRequestServiceException
- if role grant failsvoid revokeTemplateFromRoles(java.lang.Long templateKey, java.util.List roleKeys) throws RequestServiceException
templateKey
- key of the template that needs to be revoked from the roleroleKeys
- list of the role keysRequestServiceException
- if revoking the granted roles failsRequestTemplate getTemplate(java.lang.String name) throws RequestServiceException
name
- - name of the template.RequestServiceException
- if search fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |