|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RequestService
Request Service is used for managing requests and its related operations . This service allows
Below is the code snippet that shows how to get an instance of this service:
//returns an Request service instance
RequestService reqsrvc = Platform.getService(RequestService.class);
// Gets the list of request template names that are available for logged in user for request creation.
List<String> templateNames = reqsrvc.getTemplateNames();
....
Method Summary | |
---|---|
void |
addRequestComment(java.lang.String reqId, oracle.iam.request.vo.RequestComment comment) Deprecated. Human task comments feature in SOA needs to be used as replacement for request comments. |
void |
closeRequest(java.lang.String reqId) Closes the specified request. |
void |
deleteDraftRequest(java.lang.String requestId) Deletes the request given a request id. |
java.util.List |
getAllModelNames() Gets all the request model names available in the system |
Request |
getBasicRequestData(java.lang.String reqId) Gets the complete request details for the specified request Id. |
java.util.List |
getCertificationRequests(java.lang.String certificationId, RequestSearchCriteria srchCrit, java.util.HashMap configParams) Returns a list of requests raised as part of the certification review process, that match the given search criteria. |
java.util.List |
getChildRequests(java.lang.String reqId) Gets List of child requests for the specified request Id. |
java.util.List |
getDependentRequests(java.lang.String requestId) Returns the list of requests that depends on a particular request |
RequestModel |
getModel(java.lang.String modelName) Gets the Request Model object for the specified model name |
RequestModel |
getModelForTemplate(java.lang.String templateName) Deprecated. |
java.util.List |
getModelNames() Gets all the non-deprecated request model names available in the system |
java.util.List |
getModelNames(java.lang.String pattern) Gets all the request model names that matches the specified search pattern. |
long |
getNumberOfRequestsCreatedByUser(long userKey, RequestSearchCriteria searchCriteria) Gets the number of requests raised by user that match the specified search criteria. |
long |
getNumberOfRequestsCreatedForUser(long userKey, RequestSearchCriteria searchCriteria) Gets the number of requests raised for the specified user that match the search criteria. |
long |
getNumberOfRequestsRaisedByMe(RequestSearchCriteria searchCriteria) Gets the count of requests raised by login user that matches the given search criteria. |
long |
getNumberOfRequestsRaisedForMe(RequestSearchCriteria searchCriteria) Gets the count of requests raised for login user that match the given search criteria. |
java.util.List |
getRequestComments(java.lang.String reqId) Deprecated. Human task comments feature in SOA needs to be used as replacement for request comments. |
java.util.List |
getRequestComments(java.lang.String reqId, oracle.iam.request.vo.RequestComment.TYPE type) Deprecated. Human task comments feature in SOA needs to be used as replacement for request comments. |
java.util.List |
getRequestComments(java.lang.String reqId, java.lang.String taskId, oracle.iam.request.vo.RequestComment.TYPE type) Deprecated. Human task comments feature in SOA needs to be used as replacement for request comments. |
RequestDataSet |
getRequestDataSet(RequestBeneficiaryEntity entity) Gets the request data set associated with the given request entity object. |
RequestDataSet |
getRequestDataSet(RequestEntity entity) Gets the request data set associated with the given request entity object. |
RequestDataSet |
getRequestDataSet(java.lang.String requestModel, java.lang.String entityType) Deprecated. As of release 11.1.2.2.0, replaced by RequestService.getRequestDataSet(RequestEntity) and RequestService.getRequestDataSet(RequestBeneficiaryEntity) |
java.lang.String |
getRequestDataSetName(RequestBeneficiaryEntity entity) Gets the request dataset name associated with the given request entity object. |
java.lang.String |
getRequestDataSetName(RequestEntity entity) Gets the request dataset name associated with the given request entity object. |
java.lang.String |
getRequestDataSetName(java.lang.String requestType, java.lang.String entitySubType) Deprecated. As of release 11.1.2.2.0, replaced by RequestService.getRequestDataSetName(RequestEntity) and RequestService.getRequestDataSetName(RequestBeneficiaryEntity) |
java.util.List |
getRequestHistory(java.lang.String reqId) Gets all the request history instances for the specified request id |
RequestModel |
getRequestModel(java.lang.String entityType, java.lang.String operation) Gets the Request Model object associated with given entity type and operation |
java.util.List |
getRequestsForUser(java.lang.String userKey, RequestSearchCriteria srchCrit, java.util.HashMap configParams) Returns a list of requests raised for and raised by a specific user, that match the given search criteria. |
java.util.List |
getRequestsRaisedByMe(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) Gets list of all requests raised by login user that matches the given search criteria. |
java.util.List |
getRequestsRaisedForMe(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) Gets list of all requests raised for the login user that matches the given search criteria. |
java.util.List |
getRequestStageNames() Gets all the request stage names defined in the system |
java.util.List |
getRequestStages() Gets all the request stages defined in the system |
RequestStatusSummary[] |
getRequestStatusSummary(java.lang.String reqId) Gets the status changes of the specified request. |
java.util.List |
getRequestTemplates(oracle.iam.request.vo.RequestTemplateSearchCriteria searchCriteria, java.util.Set returnAttrs, java.util.Map configParams) Deprecated. |
RequestDataSet |
getRestrictedDataSet(java.lang.String templateName, java.lang.String entityType) Deprecated. |
long |
getSearchResultCount(RequestSearchCriteria searchCriteria) Gets the count of requests that match the specified search criteria. |
RequestTemplate |
getTemplate(java.lang.String templateName) Deprecated. |
java.util.List |
getTemplateNames() Deprecated. |
java.util.List |
getTemplateNamesForSelf() Deprecated. |
RequestBeneficiaryEntity |
prePopulate(RequestBeneficiaryEntity rbEntity, RequestDataSet dataset, RequestData data) Used during Request Creation to get the value to be pre-populated for the attributes configured to be prepopulated |
RequestEntity |
prePopulate(RequestEntity rEntity, RequestDataSet dataset, RequestData data) Used during Request Creation to get the value to be pre-populated for the attributes configured to be prepopulated |
java.io.Serializable |
prePopulate(java.lang.String attribute, RequestDataSet dataset, RequestData data) Used during Request Creation to get the value to be pre-populated for a non-child dataset attribute, if it is configured with a PrePopulationAdapter in the dataset. |
java.io.Serializable |
prePopulate(java.lang.String attribute, java.lang.String parentAttribute, RequestDataSet dataset, RequestData data) Used during Request Creation to get the value to be pre-populated for a child dataset attribute, if it is configured with a PrePopulationAdapter in the dataset. |
java.lang.String |
saveDraftRequest(RequestData requestData) Creates the request in draft mode, request is not submitted for approval and request data is not validated |
java.util.List |
search(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) Gets the the requests that match the specified search criteria. |
void |
submitDraftRequest(java.lang.String requestId, RequestData requestData) Submits the draft request given a draft request id , request data is validated |
java.lang.String |
submitRequest(RequestData requestData) Submit a request for an authenticated user. |
void |
updateApproverOnlyData(java.lang.String reqId, java.util.List benEntities, java.util.List reqEntities) Deprecated. This method is replaced with updateRequestData |
void |
updateDraftRequest(java.lang.String requestId, RequestData requestData) Updates the draft request given a draft request id |
void |
updateRequestData(java.lang.String reqId, java.util.List beneficiaryEntities, java.util.List entities) Updates the request with provided data. |
void |
updateRequestData(java.lang.String reqId, java.util.List beneficiaryEntities, java.util.List entities, java.util.List additionalAttributes) Updates the request with provided data. |
void |
updateRequestStatus(java.lang.String requestID, java.lang.String status) Updates status of the Request given a request id. |
void |
validateRequestData(RequestData requestData) Validates the request data against the data set and data set validator plug-in, if any. |
void |
withdrawRequest(java.lang.String reqId) Withdraws the specified request. |
Method Detail |
---|
java.lang.String submitRequest(RequestData requestData) throws InvalidRequestException, InvalidRequestDataException, RequestServiceException, BulkBeneficiariesAddException, BulkEntitiesAddException
requestData
- an instance of requestDataInvalidRequestException
- if requestData does not have either Target entity or Beneficiary details as per request Model definitionRequestServiceException
- if the authentication or data validation failsInvalidRequestDataException
- if request data validation failsBulkBeneficiariesAddException
BulkEntitiesAddException
void validateRequestData(RequestData requestData) throws InvalidRequestDataException, RequestServiceException
requestData
- request data that needs to be validatedInvalidRequestDataException
- if request data validation failsRequestServiceException
- if the authentication or data validation fails
@Deprecated
java.util.List getTemplateNames()
throws RequestServiceException
RequestServiceException
- if it fails to get corresponding request model configurations
@Deprecated
RequestDataSet getRequestDataSet(java.lang.String requestModel,
java.lang.String entityType)
throws RequestServiceException
RequestService.getRequestDataSet(RequestEntity)
and RequestService.getRequestDataSet(RequestBeneficiaryEntity)
RequestService.getRequestDataSet(RequestBeneficiaryEntity)
needs to be used.requestModel
- Request model name.entityType
- resource name for resource based request model/type,otherwise null.RequestServiceException
- if fails to get the request data from repositoryRequestDataSet getRequestDataSet(RequestEntity entity) throws RequestServiceException
entity
- request entity object with entity type, operation and entity key set.RequestServiceException
- if fails to get the request data from repositoryRequestDataSet getRequestDataSet(RequestBeneficiaryEntity entity) throws RequestServiceException
entity
- request entity object with entity type, operation and entity key set.RequestServiceException
- if fails to get the request data from repository
@Deprecated
java.lang.String getRequestDataSetName(java.lang.String requestType,
java.lang.String entitySubType)
throws RequestServiceException
RequestService.getRequestDataSetName(RequestEntity)
and RequestService.getRequestDataSetName(RequestBeneficiaryEntity)
RequestService.getRequestDataSetName(RequestBeneficiaryEntity)
needs to be used.requestType
- Name of the Request type.entitySubType
- resource name for resource based request types, otherwise null.RequestServiceException
- if fails to get the dataset namejava.lang.String getRequestDataSetName(RequestEntity entity) throws RequestServiceException
entity
- request entity object with entity type, operation and entity key set.RequestServiceException
- if fails to get the dataset namejava.lang.String getRequestDataSetName(RequestBeneficiaryEntity entity) throws RequestServiceException
entity
- request entity object with entity type, operation and entity key set.RequestServiceException
- if fails to get the dataset nameRequest getBasicRequestData(java.lang.String reqId) throws RequestServiceException, NoRequestPermissionException
reqId
- Request IdRequestServiceException
- if fails to get request object from repositoryNoRequestPermissionException
- if the login user does not have access to the requestjava.util.List search(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameretAttrs
- Request data which will be returned in Request Object. If the retAttrs is null or empty Set whole request data is returned in Request object.
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_TEMPLATE_NAME
, Request Template NameREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Request creation dateREQUEST_END_DATE
, Request end dateREQUESTER_USER_KEY
, Requester user keyREQUEST_BENEFICIARY_INFO
, Request Beneficiary DetailsREQUEST_TARGET_ENTITY_INFO
, Request Target Entity DetailsREQUEST_PARENT_INFO
, Parent Request DetailsREQUEST_CHILD_INFO
, Child Request DetailsconfigParams
- Additional configuration 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 login user has no search permission or if fails to retrieve the requests from the repository
Below code snippet shows how to search for requests based on a criteria and additional config parameters Creates an search criteria with condition - where request user id equals "jdoe"
RequestSearchCriteria searchCriteria = new RequestSearchCriteria();
searchCriteria.setConjunctionOp(RequestSearchCriteria.Operator.OR);
searchCriteria.addExpression(RequestConstants.REQUESTER_USERID, "jdoe", RequestSearchCriteria.Operator.EQUAL);
//Creates additional search result configuration for sort order
//Sort all the request object returned order by ascending of requestid
Map <String, Object> config = new HashMap<String,Object>;
config.put(RequestConstants.SEARCH_SORTORDER,RequestConstants.SortOrder.ASCENDING);
config.put(RequestConstants.SEARCH_SORTBY, RequestConstants.REQUEST_ID);
//Search the requests based on the above criteria and config
//returns an Request service instance
RequestService reqsrvc = Platform.getService(RequestService.class);
//gets a list of request
List<Request> requests = reqsrvc.search(searchCriteria,config)
......
......
RequestModel getModel(java.lang.String modelName) throws RequestServiceException
modelName
- Request model nameRequestServiceException
- if fails to retrieve the specified request model details from the repositoryRequestModel getRequestModel(java.lang.String entityType, java.lang.String operation) throws RequestServiceException
modelName
- Request model nameRequestServiceException
- if fails to retrieve the specified request model details from the repository
@Deprecated
RequestModel getModelForTemplate(java.lang.String templateName)
throws RequestServiceException
templateName
- Request template nameRequestServiceException
- if fails to retrieve request model details
@Deprecated
RequestDataSet getRestrictedDataSet(java.lang.String templateName,
java.lang.String entityType)
throws RequestServiceException
templateName
- Request template nameentityType
- entity name for generic entities, null otherwise.RequestServiceException
- if fails to retrieve specified request template or request dataset detailsjava.util.List getRequestHistory(java.lang.String reqId) throws RequestServiceException
reqId
- request idRequestServiceException
- if fails to retrieve the request history instances from repositoryjava.io.Serializable prePopulate(java.lang.String attribute, RequestDataSet dataset, RequestData data) throws RequestServiceException
attribute
- Attribute for which the value is needed for pre-populationdataset
- Request Datasetdata
- RequestData objectRequestServiceException
- if Pre-population failsRequestEntity prePopulate(RequestEntity rEntity, RequestDataSet dataset, RequestData data) throws RequestServiceException
rEntity
- RequestEntity for which the data has to be populated.dataset
- Request Datasetdata
- RequestData objectRequestServiceException
- if Pre-population failsRequestBeneficiaryEntity prePopulate(RequestBeneficiaryEntity rbEntity, RequestDataSet dataset, RequestData data) throws RequestServiceException
rbEntity
- RequestBeneficiaryEntity for which the data has to be populated.dataset
- Request Datasetdata
- RequestData objectRequestServiceException
- if Pre-population failsjava.io.Serializable prePopulate(java.lang.String attribute, java.lang.String parentAttribute, RequestDataSet dataset, RequestData data) throws RequestServiceException
attribute
- Attribute for which the value is needed for pre-populationparentAttribute
- Parent attribute of the attribute to be pre-populateddataset
- Request Datasetdata
- RequestData objectRequestServiceException
- if Pre-population failsjava.util.List getModelNames() throws RequestServiceException
RequestServiceException
- if fails to retrieve the request models from the repositoryjava.util.List getAllModelNames() throws RequestServiceException
RequestServiceException
- if fails to retrieve the request models from the repositoryjava.util.List getModelNames(java.lang.String pattern) throws RequestServiceException
pattern
- - search pattern with "*" as wild characterRequestServiceException
- if fails to retrieve request models from the repositorylong getNumberOfRequestsCreatedByUser(long userKey, RequestSearchCriteria searchCriteria) throws RequestServiceException
userKey
- Key of the user by whom requests are raisedsearchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameRequestServiceException
- if login user has no search permission or if fails to retrieve the requests from the repositorylong getNumberOfRequestsCreatedForUser(long userKey, RequestSearchCriteria searchCriteria) throws RequestServiceException
userKey
- Key of the user for whom requests are raisedsearchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameRequestServiceException
- if the login user has no search permission or if fails to retrieve the requests from the repositoryjava.util.List getChildRequests(java.lang.String reqId) throws RequestServiceException, NoRequestPermissionException
reqId
- Parent request IdRequestServiceException
- if the specified request id is invalid or fails to retrieve the request details from the repositoryNoRequestPermissionException
- if the login user doesn't have permissions over the request
@Deprecated
RequestTemplate getTemplate(java.lang.String templateName)
throws RequestServiceException
templateName
- Request template nameRequestServiceException
- if fails to retrieve the request template details from the repositoryRequestStatusSummary[] getRequestStatusSummary(java.lang.String reqId) throws RequestServiceException
reqId
- request idRequestServiceException
- if fails to retrieve the request summary details from the repositorylong getSearchResultCount(RequestSearchCriteria searchCriteria) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameRequestServiceException
- if the login user has no search permission or if fails to retrieve the requests from the repositoryvoid addRequestComment(java.lang.String reqId, oracle.iam.request.vo.RequestComment comment) throws RequestServiceException
Only authorized users can add request comments. Authorized users are
reqId
- request idcomment
- Request comment value objectRequestServiceException
- if the login user has no search permission or fails to add comments to the specified requestsjava.util.List getRequestComments(java.lang.String reqId) throws RequestServiceException
Only authorized users can get request comments. Authorized users are
reqId
- Request IDRequestServiceException
- the login user is not authorized or fails to retrieve the comments from repositoryjava.util.List getRequestComments(java.lang.String reqId, oracle.iam.request.vo.RequestComment.TYPE type) throws RequestServiceException
Only authorized users can get request comments. Authorized users are
reqId
- Request Idtype
- Request comment typeRequestServiceException
- the login user is not authorized or fails to retrieve the comments from repositoryjava.util.List getRequestComments(java.lang.String reqId, java.lang.String taskId, oracle.iam.request.vo.RequestComment.TYPE type) throws RequestServiceException
Only authorized users can get request comments. Authorized users are
reqId
- Request IdtaskId
- Task Idtype
- Request comment typeRequestServiceException
- the login user is not authorized or fails to retrieve the comments from repositoryvoid withdrawRequest(java.lang.String reqId) throws RequestServiceException, AccessDeniedException
reqId
- request IdRequestServiceException
- if fails to withdraw the requestAccessDeniedException
void closeRequest(java.lang.String reqId) throws RequestServiceException, AccessDeniedException
reqId
- request IdRequestServiceException
- if fails to close the requestAccessDeniedException
java.util.List getRequestsRaisedForMe(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameretAttrs
- Request data which will be returned in Request Object. If the retAttrs is null or empty Set whole request data is returned in Request object.
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_TEMPLATE_NAME
, Request Template NameREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Request creation dateREQUEST_END_DATE
, Request end dateREQUESTER_USER_KEY
, Requester user keyREQUEST_BENEFICIARY_INFO
, Request Beneficiary DetailsREQUEST_TARGET_ENTITY_INFO
, Request Target Entity DetailsREQUEST_PARENT_INFO
, Parent Request DetailsREQUEST_CHILD_INFO
, Child Request DetailsconfigParams
- Additional configuration 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 fails to retrieve the requests from repositoryjava.util.List getRequestsRaisedByMe(RequestSearchCriteria searchCriteria, java.util.Set retAttrs, java.util.HashMap configParams) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameretAttrs
- Request data which will be returned in Request Object. If the retAttrs is null or empty Set whole request data is returned in Request object.
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_TEMPLATE_NAME
, Request Template NameREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Request creation dateREQUEST_END_DATE
, Request end dateREQUESTER_USER_KEY
, Requester user keyREQUEST_BENEFICIARY_INFO
, Request Beneficiary DetailsREQUEST_TARGET_ENTITY_INFO
, Request Target Entity DetailsREQUEST_PARENT_INFO
, Parent Request DetailsREQUEST_CHILD_INFO
, Child Request DetailsconfigParams
- Additional configuration 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 fails to retrieve requests from repositorylong getNumberOfRequestsRaisedForMe(RequestSearchCriteria searchCriteria) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameRequestServiceException
- if fails to retrieve requests from repositorylong getNumberOfRequestsRaisedByMe(RequestSearchCriteria searchCriteria) throws RequestServiceException
searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameRequestServiceException
- if fails to retrieve requests from repositoryjava.util.List getRequestsForUser(java.lang.String userKey, RequestSearchCriteria srchCrit, java.util.HashMap configParams) throws RequestServiceException
userKey
- Mandatory parameter, of user key for which request search is donesearchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameconfigParams
- Additional configuration 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
java.util.List getCertificationRequests(java.lang.String certificationId, RequestSearchCriteria srchCrit, java.util.HashMap configParams) throws RequestServiceException
certificationId
- certification id.searchCriteria
- Request search criteria
Below is the list of allowed search parameters
REQUEST_KEY
, Request key (internal unique id)REQUEST_ID
, Request id (customized unique id)REQUEST_MODEL_NAME
, Request Model NameREQUEST_STATUS
, Request current statusREQUEST_JUSTIFICATION
, Justification to raise the requestREQUEST_EFFECTIVE_DATE
, Request effective dateREQUEST_CREATION_DATE
, Returns all the requests that are created on or after this dateREQUEST_END_DATE
, Returns all the requests that are created on or before this dateREQUESTER_FIRST_NAME
, Requester first nameREQUESTER_LAST_NAME
, Requester last nameREQUESTER_USERID
, Requester login idREQUEST_BENEFICIARY_USERID
, Beneficiary login idREQUEST_BENEFICIARY_FIRST_NAME
, Beneficiary first nameREQUEST_BENEFICIARY_LAST_NAME
, Beneficiary last nameconfigParams
- Additional configuration 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
java.util.List getRequestStageNames() throws RequestServiceException
RequestServiceException
- if fails to retrieve the request stage names from the repositoryjava.util.List getRequestStages() throws RequestServiceException
RequestServiceException
- if fails to retrieve the request stage names from the repositoryvoid updateApproverOnlyData(java.lang.String reqId, java.util.List benEntities, java.util.List reqEntities) throws RequestServiceException
updateRequestData
reqId
-benEntities
-reqEntities
-RequestServiceException
void updateRequestData(java.lang.String reqId, java.util.List beneficiaryEntities, java.util.List entities) throws RequestServiceException, InvalidRequestDataException
reqId
- id of the request that needs to be updated.beneficiaryEntities
- beneficiary entities with the updated data.entities
- entities with updated data.RequestServiceException
InvalidRequestDataException
@Deprecated
java.util.List getTemplateNamesForSelf()
throws RequestServiceException
RequestServiceException
- if it fails to get corresponding request model configurationsvoid updateRequestStatus(java.lang.String requestID, java.lang.String status) throws RequestServiceException
Request
- Id of the request whose status needs to be updatedstatus
- to which the request needs to be updatedRequestServiceException
@Deprecated
java.util.List getRequestTemplates(oracle.iam.request.vo.RequestTemplateSearchCriteria searchCriteria,
java.util.Set returnAttrs,
java.util.Map configParams)
throws RequestServiceException
RequestServiceException
void deleteDraftRequest(java.lang.String requestId) throws RequestServiceException
requestId
- The id of the draft request which needs to be deletedRequestServiceException
- if it fails to delete the request or the request is not in draft state or the logged-in user is not requesterjava.lang.String saveDraftRequest(RequestData requestData) throws RequestServiceException
requestData
- The request data which needs to be savedRequestServiceException
- if creation of draft request failsvoid updateDraftRequest(java.lang.String requestId, RequestData requestData) throws RequestServiceException
requestId
- The id of the draft request which needs to be updatedrequestData
- The request data which needs to be updatedRequestServiceException
- if it fails to update the request successfully or the request is not in draft statevoid submitDraftRequest(java.lang.String requestId, RequestData requestData) throws InvalidRequestException, InvalidRequestDataException, RequestServiceException, BulkBeneficiariesAddException, BulkEntitiesAddException
requestId
- The id of the draft request which needs to be submittedrequestData
- The request data which needs to be submittedInvalidRequestException
- if requestData does not have either Target entity or Beneficiary details as per request Model definitionInvalidRequestDataException
- if request data validation failsRequestServiceException
- if it fails to update the draft request or fails due to authorizationBulkBeneficiariesAddException
BulkEntitiesAddException
java.util.List getDependentRequests(java.lang.String requestId) throws RequestServiceException, NoRequestPermissionException
requestId
- The id of the request for which the list of dependents need to be returnedRequestServiceException
- if the specified request id is invalid or fails to retrieve the request details from the repositoryNoRequestPermissionException
- if the login user doesn't have permissions over the requestvoid updateRequestData(java.lang.String reqId, java.util.List beneficiaryEntities, java.util.List entities, java.util.List additionalAttributes) throws RequestServiceException, InvalidRequestDataException
reqId
- id of the request that needs to be updated.beneficiaryEntities
- beneficiary entities with the updated data.entities
- entities with updated data.additionalAttributes
- - additional/template attributes to be updated in the request.RequestServiceException
InvalidRequestDataException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |