@Transactional(readOnly=true, noRollbackFor=DoesNotExistException.class, rollbackFor=java.lang.Throwable.class) public class HoldServiceImpl extends Object implements HoldService
Constructor and Description |
---|
HoldServiceImpl() |
Modifier and Type | Method and Description |
---|---|
AppliedHoldInfo |
createAppliedHold(String personId,
String issueId,
String holdTypeKey,
AppliedHoldInfo holdInfo,
ContextInfo context)
Creates a new applied hold.
|
HoldIssueInfo |
createHoldIssue(String issueTypeKey,
HoldIssueInfo issueInfo,
ContextInfo context)
Creates a new hold Issue.
|
StatusInfo |
deleteAppliedHold(String holdId,
ContextInfo context)
Deletes an existing applied hold record.
|
StatusInfo |
deleteHoldIssue(String issueId,
ContextInfo contextInfo)
Deletes an existing hold Issue.
|
List<AppliedHoldInfo> |
getActiveAppliedHoldsByIssueAndPerson(String issueId,
String personId,
ContextInfo contextInfo)
Retrieves a list of active applied holds, both warning and blocking, by
hold Issue for a Person.
|
List<AppliedHoldInfo> |
getActiveAppliedHoldsByPerson(String personId,
ContextInfo contextInfo)
Retrieves a list of active applied holds, that pertain to the given
Person.
|
AppliedHoldInfo |
getAppliedHold(String holdId,
ContextInfo context)
Retrieves the a single applied hold by the applied hold Id.
|
AppliedHoldDao |
getAppliedHoldDao() |
List<String> |
getAppliedHoldIdsByIssue(String issueId,
ContextInfo contextInfo)
Retrieves all Student Holds related to the given hold Issue.
|
List<String> |
getAppliedHoldIdsByType(String holdTypeKey,
ContextInfo contextInfo)
Retrieves a list Student Hold Ids by Student Hold Type.
|
List<AppliedHoldInfo> |
getAppliedHoldsByIds(List<String> holdIds,
ContextInfo contextInfo)
Retrieves a list applied holds from to a list of applied hold Ids.
|
List<AppliedHoldInfo> |
getAppliedHoldsByIssueAndPerson(String issueId,
String personId,
ContextInfo contextInfo)
Retrieves a list of all Holds by Issue for a Person.
|
List<AppliedHoldInfo> |
getAppliedHoldsByPerson(String personId,
ContextInfo contextInfo)
Retrieves all applied holds to the given Person.
|
CriteriaLookupService |
getCriteriaLookupService() |
HoldIssueInfo |
getHoldIssue(String issueId,
ContextInfo context)
Retrieves the details of a single hold Issue by it's hold issue Id.
|
HoldIssueDao |
getHoldIssueDao() |
List<String> |
getHoldIssueIdsByType(String issueTypeKey,
ContextInfo context)
Retrieves a list of hold Issues by Type.
|
List<HoldIssueInfo> |
getHoldIssuesByIds(List<String> issueIds,
ContextInfo contextInfo)
Retrieves a list hold Issues corresponding to a list of issue Ids.
|
List<HoldIssueInfo> |
getHoldIssuesByOrg(String organizationId,
ContextInfo context)
Retrieves a list of hold Issues that pertain to the given organization.
|
AppliedHoldInfo |
releaseAppliedHold(String holdId,
ContextInfo context)
Releases a applied hold.
|
List<String> |
searchForAppliedHoldIds(QueryByCriteria criteria,
ContextInfo context)
Searches for applied holds based on the criteria and returns a list of Hold
identifiers which match the search criteria.
|
List<AppliedHoldInfo> |
searchForAppliedHolds(QueryByCriteria criteria,
ContextInfo context)
Searches for applied holds based on the criteria and returns a list of Holds
which match the search criteria.
|
List<String> |
searchForHoldIssueIds(QueryByCriteria criteria,
ContextInfo context)
Searches for Issues based on the criteria and returns a list of Issue
identifiers which match the search criteria.
|
List<HoldIssueInfo> |
searchForHoldIssues(QueryByCriteria criteria,
ContextInfo context)
Searches for Issues based on the criteria and returns a list of Issues
which match the search criteria.
|
void |
setAppliedHoldDao(AppliedHoldDao appliedHoldDao) |
void |
setCriteriaLookupService(CriteriaLookupService criteriaLookupService) |
void |
setHoldIssueDao(HoldIssueDao holdIssueDao) |
AppliedHoldInfo |
updateAppliedHold(String holdId,
AppliedHoldInfo holdInfo,
ContextInfo context)
Updates an existing applied hold.
|
HoldIssueInfo |
updateHoldIssue(String issueId,
HoldIssueInfo issueInfo,
ContextInfo context)
Updates an existing hold Issue.
|
List<ValidationResultInfo> |
validateAppliedHold(String validationTypeKey,
AppliedHoldInfo holdInfo,
ContextInfo context)
Validates a applied hold.
|
List<ValidationResultInfo> |
validateHoldIssue(String validationTypeKey,
HoldIssueInfo issueInfo,
ContextInfo context)
Validates an issue.
|
public HoldServiceImpl()
public HoldIssueDao getHoldIssueDao()
public void setHoldIssueDao(HoldIssueDao holdIssueDao)
public AppliedHoldDao getAppliedHoldDao()
public void setAppliedHoldDao(AppliedHoldDao appliedHoldDao)
public void setCriteriaLookupService(CriteriaLookupService criteriaLookupService)
public CriteriaLookupService getCriteriaLookupService()
@Transactional(readOnly=true) public AppliedHoldInfo getAppliedHold(String holdId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHold
in interface HoldService
holdId
- a unique identifier of the Hold to be retrievedcontext
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- appliedHoldId not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- appliedHoldId or contextInfo is missing
or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurred@Transactional(readOnly=true) public List<String> searchForAppliedHoldIds(QueryByCriteria criteria, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
searchForAppliedHoldIds
in interface HoldService
criteria
- the search criteriacontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- parameter is missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<AppliedHoldInfo> searchForAppliedHolds(QueryByCriteria criteria, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
searchForAppliedHolds
in interface HoldService
criteria
- the search criteriacontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- parameter is missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validateAppliedHold(String validationTypeKey, AppliedHoldInfo holdInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
HoldService
validateAppliedHold
in interface HoldService
validationTypeKey
- Identifier of the extent of validationholdInfo
- the hold information to be tested.context
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- validationTypeKey not foundInvalidParameterException
- invalid validationTypeKey,
appliedHoldInfoMissingParameterException
- missing validationTypeKey,
appliedHoldInfoOperationFailedException
- unable to complete request@Transactional public AppliedHoldInfo createAppliedHold(String personId, String issueId, String holdTypeKey, AppliedHoldInfo holdInfo, ContextInfo context) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
createAppliedHold
in interface HoldService
personId
- identifying the person for whom the hold is to be appliedissueId
- identifying the exact issue involvedholdTypeKey
- identifying the type of the holdholdInfo
- Details of the Hold to be createdcontext
- Context information containing the principalId and
locale information about the caller of service operationDataValidationErrorException
- One or more values invalid for this
operationInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional public AppliedHoldInfo updateAppliedHold(String holdId, AppliedHoldInfo holdInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
HoldService
updateAppliedHold
in interface HoldService
holdId
- Id of Hold to be updatedholdInfo
- Details of updates to the Hold being updatedcontext
- Context information containing the principalId and
locale information about the caller of service operationDataValidationErrorException
- One or more values invalid for this
operationDoesNotExistException
- the Hold does not existInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureVersionMismatchException
- The action was attempted on an out of
date version.@Transactional public AppliedHoldInfo releaseAppliedHold(String holdId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
releaseAppliedHold
in interface HoldService
holdId
- a holdcontext
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- the Hold does not existInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional public StatusInfo deleteAppliedHold(String holdId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
deleteAppliedHold
in interface HoldService
holdId
- the Id of the Hold to be deletedcontext
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- the Hold does not existInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public HoldIssueInfo getHoldIssue(String issueId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getHoldIssue
in interface HoldService
issueId
- Unique Id of the Issue to be retrievedcontext
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- holdIssueId not foundInvalidParameterException
- invalid holdIssueIdMissingParameterException
- missing holdIssueIdOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<String> getHoldIssueIdsByType(String issueTypeKey, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getHoldIssueIdsByType
in interface HoldService
issueTypeKey
- a Type of the Issue to be retrievedcontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<HoldIssueInfo> getHoldIssuesByOrg(String organizationId, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getHoldIssuesByOrg
in interface HoldService
organizationId
- a unique Id of an organizationcontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<String> searchForHoldIssueIds(QueryByCriteria criteria, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
searchForHoldIssueIds
in interface HoldService
criteria
- the search criteriacontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- parameter is missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<HoldIssueInfo> searchForHoldIssues(QueryByCriteria criteria, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
searchForHoldIssues
in interface HoldService
criteria
- the search criteriacontext
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- parameter is missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validateHoldIssue(String validationTypeKey, HoldIssueInfo issueInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
HoldService
validateHoldIssue
in interface HoldService
validationTypeKey
- Identifier of the extent of validationissueInfo
- the issue information to be tested.context
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- validationTypeKey not foundInvalidParameterException
- invalid validationTypeKey,
holdIssueInfoMissingParameterException
- missing validationTypeKey,
holdIssueInfoOperationFailedException
- unable to complete request@Transactional public HoldIssueInfo createHoldIssue(String issueTypeKey, HoldIssueInfo issueInfo, ContextInfo context) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
createHoldIssue
in interface HoldService
issueTypeKey
- indicates the type of issueissueInfo
- Details of the Issue to be createdcontext
- Context information containing the principalId and
locale information about the caller of service operationDataValidationErrorException
- One or more values invalid for this
operationInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional public HoldIssueInfo updateHoldIssue(String issueId, HoldIssueInfo issueInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
HoldService
updateHoldIssue
in interface HoldService
issueId
- Id of the Issue to be updatedissueInfo
- Details of updates to the Issue being updatedcontext
- Context information containing the principalId and
locale information about the caller of service operationDataValidationErrorException
- One or more values invalid for this
operationDoesNotExistException
- the Issue does not existInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureVersionMismatchException
- The action was attempted on an out of
date version.@Transactional public StatusInfo deleteHoldIssue(String issueId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DependentObjectsExistException
HoldService
deleteHoldIssue
in interface HoldService
issueId
- the Id of the Issue to be deletedcontextInfo
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- the Issue does not existInvalidParameterException
- One or more parameters invalidMissingParameterException
- One or more parameters missingOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureDependentObjectsExistException
- if a hold exists for this issue@Transactional(readOnly=true) public List<AppliedHoldInfo> getAppliedHoldsByIds(List<String> holdIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHoldsByIds
in interface HoldService
holdIds
- list of Hold identifierscontextInfo
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- a appliedHoldId in list not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- appliedHoldIds, a appliedHoldId in
appliedHoldIds, or contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurred@Transactional(readOnly=true) public List<String> getAppliedHoldIdsByType(String holdTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHoldIdsByType
in interface HoldService
holdTypeKey
- an identifier for a Hold TypecontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- contextInfo is not validMissingParameterException
- appliedHoldTypeKey or contextInfo is
missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurred@Transactional(readOnly=true) public List<String> getAppliedHoldIdsByIssue(String issueId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHoldIdsByIssue
in interface HoldService
issueId
- a unique identifier for the IssuecontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- contextInfo is not validMissingParameterException
- holdIssueId or contetInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurred@Transactional(readOnly=true) public List<AppliedHoldInfo> getAppliedHoldsByPerson(String personId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHoldsByPerson
in interface HoldService
personId
- a unique identifier for the PersoncontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- contextInfo is not validMissingParameterException
- personId of contextInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurred@Transactional(readOnly=true) public List<AppliedHoldInfo> getActiveAppliedHoldsByPerson(String personId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getActiveAppliedHoldsByPerson
in interface HoldService
personId
- an Id of a PersoncontextInfo
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<AppliedHoldInfo> getAppliedHoldsByIssueAndPerson(String issueId, String personId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getAppliedHoldsByIssueAndPerson
in interface HoldService
issueId
- an IssuepersonId
- Id of a personcontextInfo
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<AppliedHoldInfo> getActiveAppliedHoldsByIssueAndPerson(String issueId, String personId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getActiveAppliedHoldsByIssueAndPerson
in interface HoldService
issueId
- an IssuepersonId
- Id of a personcontextInfo
- Context information containing the principalId and
locale information about the caller of service operationInvalidParameterException
- invalid parameterMissingParameterException
- missing parameterOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=true) public List<HoldIssueInfo> getHoldIssuesByIds(List<String> issueIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
HoldService
getHoldIssuesByIds
in interface HoldService
issueIds
- list of unique Ids of the Issue to be retrievedcontextInfo
- Context information containing the principalId and
locale information about the caller of service operationDoesNotExistException
- a holdIssueId in list not foundInvalidParameterException
- invalid holdIssueId in listMissingParameterException
- missing holdIssueIdsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCopyright © 2004-2013 The Kuali Foundation. All Rights Reserved.