|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RequestTemplateService
This class is used to manage request templates. This service allows
Method Summary | |
---|---|
RequestTemplate |
createTemplate(RequestTemplate template) Creates Request template. |
RequestTemplate |
createTemplate(RequestTemplate template, java.util.List roleKeys) Creates Request template and assigns it to given list of roles. |
void |
deleteTemplate(java.lang.Long templateKey, java.sql.Timestamp updatedTimestamp) Deletes the template with given key. |
java.util.List |
getGrantedRolesWithTemplate(java.lang.Long templateKey) Get the list of roles that are granted with the given template. |
RequestTemplate |
getTemplate(java.lang.String name) Get the template with given name |
java.util.List |
getTemplateNames(java.lang.String modelName) 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) 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) Grants the given template to given roles. |
RequestTemplate |
modifyTemplate(RequestTemplate template) Modify the given template. |
void |
revokeTemplateFromRoles(java.lang.Long templateKey, java.util.List roleKeys) Revokes the template access from given roles. |
java.util.List |
searchTemplates(RequestTemplateSearchCriteria searchCriteria, java.util.Map configParams) Returns a list of request templates that match the given search criteria. |
Method Detail |
---|
RequestTemplate createTemplate(RequestTemplate template) throws RequestServiceException
template
- that needs to be createdRequestServiceException
RequestTemplate createTemplate(RequestTemplate template, java.util.List roleKeys) throws RequestServiceException
template
- that needs to be createdroleKeys
- list of roles to which the template needs to be assigned.RequestServiceException
java.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
java.util.List getTemplateNames(java.lang.String modelName) throws RequestServiceException
modelName
-RequestServiceException
java.util.List searchTemplates(RequestTemplateSearchCriteria searchCriteria, java.util.Map configParams) throws RequestServiceException
RequestTemplateSearchCriteria
- Value object to specify the 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
RequestTemplate modifyTemplate(RequestTemplate template) throws RequestServiceException
template
- that needs to be modifiedRequestServiceException
void 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
java.util.List getGrantedRolesWithTemplate(java.lang.Long templateKey) throws RequestServiceException
templateKey
- key of the templateRequestServiceException
void 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
- In case of error in granting the template to rolevoid 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
- In case of error in revoking the template from roleRequestTemplate getTemplate(java.lang.String name) throws RequestServiceException
name
- - name of the template.RequestServiceException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |