|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kuali.student.r2.core.process.ProcessPocPopulationServiceMockImpl
public class ProcessPocPopulationServiceMockImpl
Constructor Summary | |
---|---|
ProcessPocPopulationServiceMockImpl()
|
Method Summary | |
---|---|
StatusInfo |
addPopulationToPopulationCategory(String populationId,
String populationCategoryId,
ContextInfo contextInfo)
Adds Population to a PopulationCategory. |
StatusInfo |
applyPopulationRuleToPopulation(String populationRuleId,
String populationId,
ContextInfo contextInfo)
Applies PopulationRule to a Population. |
void |
clear()
Clear all cached service data. |
PopulationInfo |
createPopulation(PopulationInfo populationInfo,
ContextInfo contextInfo)
Creates a new Population. |
PopulationCategoryInfo |
createPopulationCategory(String populationCategoryTypeKey,
PopulationCategoryInfo populationCategoryInfo,
ContextInfo contextInfo)
Creates a new PopulationCategory. |
PopulationRuleInfo |
createPopulationRule(PopulationRuleInfo populationInfo,
ContextInfo contextInfo)
Creates a new PopulationRule. |
StatusInfo |
deletePopulation(String populationId,
ContextInfo contextInfo)
Deletes an existing Population. |
StatusInfo |
deletePopulationCategory(String populationCategoryId,
ContextInfo contextInfo)
Deletes an existing PopulationCategory. |
StatusInfo |
deletePopulationRule(String populationRuleId,
ContextInfo contextInfo)
Deletes an existing PopulationRule. |
List<String> |
getMembersAsOfDate(String populationId,
Date date,
ContextInfo contextInfo)
Gets a list of people Ids who qualify as a member of a Population. |
PopulationInfo |
getPopulation(String populationId,
ContextInfo contextInfo)
Retrieves a Population. |
List<PopulationCategoryInfo> |
getPopulationCategoriesByIds(List<String> populationCategoryIds,
ContextInfo contextInfo)
Retrieves a list of PopulationCategorys corresponding to the given list of PopulationCategory Ids. |
List<PopulationCategoryInfo> |
getPopulationCategoriesForPopulation(String populationId,
ContextInfo contextInfo)
Retrieves a list of PopulationCategories in which the given Population is related. |
PopulationCategoryInfo |
getPopulationCategory(String populationCategoryId,
ContextInfo contextInfo)
Retrieves a PopulationCategory. |
List<String> |
getPopulationCategoryIdsByType(String populationTypeKey,
ContextInfo contextInfo)
Retrieves a list of PopulationCategory Ids of the specified type. |
List<String> |
getPopulationIdsByType(String populationTypeId,
ContextInfo contextInfo)
Retrieves a list of Population Ids of the specified type. |
PopulationRuleInfo |
getPopulationRule(String populationRuleId,
ContextInfo contextInfo)
Retrieves a PopulationRule. |
PopulationRuleInfo |
getPopulationRuleForPopulation(String populationKey,
ContextInfo contextInfo)
Retrieves a list of PopulationRules in which the given Population is related. |
List<String> |
getPopulationRuleIdsByType(String populationTypeKey,
ContextInfo contextInfo)
Retrieves a list of PopulationRule Ids of the specified type. |
List<PopulationRuleInfo> |
getPopulationRulesByIds(List<String> populationRuleIds,
ContextInfo contextInfo)
Retrieves a list of PopulationRules corresponding to the given list of PopulationRule Ids. |
List<PopulationInfo> |
getPopulationsByIds(List<String> populationIds,
ContextInfo contextInfo)
Retrieves a list of Populations corresponding to the given list of Population Ids. |
List<PopulationInfo> |
getPopulationsForPopulationRule(String populationRuleId,
ContextInfo contextInfo)
Retrieves a list of Populations in which the given PopulationRule is applied. |
Boolean |
isMemberAsOfDate(String personId,
String populationId,
Date date,
ContextInfo contextInfo)
Tests if a Person is a member of a Population. |
StatusInfo |
removePopulationFromPopulationCategory(String populationId,
String populationCategoryId,
ContextInfo contextInfo)
Removes Population from a PopulationCategory. |
StatusInfo |
removePopulationRuleFromPopulation(String populationRuleId,
String populationId,
ContextInfo contextInfo)
Removes Population from a PopulationRule. |
List<PopulationCategoryInfo> |
searchForPopulationCategories(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for PopulationCategories based on the criteria and returns a list of PopulationCategories which match the search criteria. |
List<String> |
searchForPopulationCategoryIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for PopulationCategories based on the criteria and returns a list of PopulationCategory identifiers which match the search criteria. |
List<String> |
searchForPopulationIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for Populations based on the criteria and returns a list of Population identifiers which match the search criteria. |
List<String> |
searchForPopulationRuleIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for PopulationRules based on the criteria and returns a list of PopulationRule identifiers which match the search criteria. |
List<PopulationRuleInfo> |
searchForPopulationRules(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for PopulationRules based on the criteria and returns a list of PopulationRules which match the search criteria. |
List<PopulationInfo> |
searchForPopulations(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for Populations based on the criteria and returns a list of Populations which match the search criteria. |
PopulationInfo |
updatePopulation(String populationId,
PopulationInfo populationInfo,
ContextInfo contextInfo)
Updates an existing Population. |
PopulationCategoryInfo |
updatePopulationCategory(String populationCategoryId,
PopulationCategoryInfo populationInfo,
ContextInfo contextInfo)
Updates an existing PopulationCategory. |
PopulationRuleInfo |
updatePopulationRule(String populationRuleId,
PopulationRuleInfo populationInfo,
ContextInfo contextInfo)
Updates an existing PopulationRule. |
List<ValidationResultInfo> |
validatePopulation(String validationTypeId,
PopulationInfo populationInfo,
ContextInfo contextInfo)
Validates a Population. |
List<ValidationResultInfo> |
validatePopulationCategory(String validationTypeKey,
String populationCategoryTypeKey,
PopulationCategoryInfo populationCategoryInfo,
ContextInfo contextInfo)
Validates a PopulationCategory. |
List<ValidationResultInfo> |
validatePopulationRule(String validationTypeKey,
PopulationRuleInfo populationInfo,
ContextInfo contextInfo)
Validates a PopulationRule. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProcessPocPopulationServiceMockImpl()
Method Detail |
---|
public void clear()
MockService
clear
in interface MockService
public Boolean isMemberAsOfDate(String personId, String populationId, Date date, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
isMemberAsOfDate
in interface PopulationService
personId
- a unique Id of a PersonpopulationId
- a unique Id of a Populationdate
- the date on which to perform the evaluationcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId not found
InvalidParameterException
- invalid personId,
populationId, or contextInfo
MissingParameterException
- populationId, date, or
contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> getMembersAsOfDate(String populationId, Date date, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getMembersAsOfDate
in interface PopulationService
populationId
- a unique Id of a Populationdate
- the date on which to perform the evaluationcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId not found
InvalidParameterException
- invalid populationId or
contextInfo
MissingParameterException
- populationId, date, or
contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationInfo getPopulation(String populationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulation
in interface PopulationService
populationId
- a unique Id of a PopulationcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId not found
InvalidParameterException
- invalid populationId or contextInfo
MissingParameterException
- missing populationId or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationInfo> getPopulationsByIds(List<String> populationIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationsByIds
in interface PopulationService
populationIds
- list of Populationss to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- an populationId in list not found
InvalidParameterException
- invalid populationId or contextInfo
MissingParameterException
- missing populationId or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> getPopulationIdsByType(String populationTypeId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationIdsByType
in interface PopulationService
populationTypeId
- a Population type to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid populationTypeId or
contextInfo
MissingParameterException
- missing populationTypeId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationInfo> getPopulationsForPopulationRule(String populationRuleId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationsForPopulationRule
in interface PopulationService
populationRuleId
- a PopulationRule IdcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid populationRuleId or
contextInfo
MissingParameterException
- missing populationRuleId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> searchForPopulationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulationIds
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationInfo> searchForPopulations(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulations
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validatePopulation(String validationTypeId, PopulationInfo populationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
validatePopulation
in interface PopulationService
validationTypeId
- the identifier of the extent of validationpopulationInfo
- the Population information to be testedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- validationTypeId not found
InvalidParameterException
- invalid validationTypeId,
populationInfo, or contextInfo
MissingParameterException
- missing validationTypeKey,
populationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationInfo createPopulation(PopulationInfo populationInfo, ContextInfo contextInfo) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
PopulationService
createPopulation
in interface PopulationService
populationInfo
- the details of Population to be createdcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- one or more values invalid
for this operation
InvalidParameterException
- invalid populationInfo or
contextInfo
MissingParameterException
- missing populationInfo or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-onlypublic PopulationInfo updatePopulation(String populationId, PopulationInfo populationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
PopulationService
updatePopulation
in interface PopulationService
populationId
- the Id of Population to be updatedpopulationInfo
- the details of updates to Population being updatedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- One or more values invalid
for this operation
DoesNotExistException
- populationId not found
InvalidParameterException
- invalid populationId,
populationInfo, or contextInfo
MissingParameterException
- missing populationId,
populationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-only
VersionMismatchException
- The action was attempted on an out
of date version.public StatusInfo deletePopulation(String populationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
deletePopulation
in interface PopulationService
populationId
- the Id of the Population to be deletedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId not found
InvalidParameterException
- invalid populationId or contextInfo
MissingParameterException
- missing populationId or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationRuleInfo getPopulationRule(String populationRuleId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationRule
in interface PopulationService
populationRuleId
- a unique Id of a PopulationRulecontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationRuleId not found
InvalidParameterException
- invalid populationRuleId or
contextInfo
MissingParameterException
- missing populationRuleId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationRuleInfo> getPopulationRulesByIds(List<String> populationRuleIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationRulesByIds
in interface PopulationService
populationRuleIds
- list of PopulationRules to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- an populationRuleId in list not found
InvalidParameterException
- invalid populationRuleId or
contextInfo
MissingParameterException
- missing populationRuleId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> getPopulationRuleIdsByType(String populationTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationRuleIdsByType
in interface PopulationService
populationTypeKey
- a PopulationRule type to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid populationTypeKey or
contextInfo
MissingParameterException
- missing populationTypeKey or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationRuleInfo getPopulationRuleForPopulation(String populationKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationRuleForPopulation
in interface PopulationService
populationKey
- a Population idcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId is not found
InvalidParameterException
- invalid populationid or contextInfo
MissingParameterException
- missing populationId or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> searchForPopulationRuleIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulationRuleIds
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationRuleInfo> searchForPopulationRules(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulationRules
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validatePopulationRule(String validationTypeKey, PopulationRuleInfo populationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
validatePopulationRule
in interface PopulationService
validationTypeKey
- the identifier of the extent of validationpopulationInfo
- the PopulationRule information to be testedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- validationTypeKey not found
InvalidParameterException
- invalid validationTypeKey,
populationInfo, or contextInfo
MissingParameterException
- missing validationTypeKey,
populationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationRuleInfo createPopulationRule(PopulationRuleInfo populationInfo, ContextInfo contextInfo) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
PopulationService
createPopulationRule
in interface PopulationService
populationInfo
- the details of PopulationRule to be createdcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- one or more values invalid
for this operation
InvalidParameterException
- invalid populationInfo or
contextInfo
MissingParameterException
- missing populationInfo or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-onlypublic PopulationRuleInfo updatePopulationRule(String populationRuleId, PopulationRuleInfo populationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
PopulationService
updatePopulationRule
in interface PopulationService
populationRuleId
- the Id of PopulationRule to be updatedpopulationInfo
- the details of updates to PopulationRule
being updatedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- One or more values invalid
for this operation
DoesNotExistException
- populationRuleId not found
InvalidParameterException
- invalid populationRuleId,
populationInfo, or contextInfo
MissingParameterException
- missing populationRuleId,
populationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-only
VersionMismatchException
- The action was attempted on an out
of date version.public StatusInfo deletePopulationRule(String populationRuleId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
deletePopulationRule
in interface PopulationService
populationRuleId
- the Id of the PopulationRule to be deletedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationRuleId not found
InvalidParameterException
- invalid populationRuleId or
contextInfo
MissingParameterException
- missing populationRuleId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic StatusInfo applyPopulationRuleToPopulation(String populationRuleId, String populationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
applyPopulationRuleToPopulation
in interface PopulationService
populationRuleId
- a unique identifier for a PopulationRulepopulationId
- a unique identifier for a PopulationcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId or
populationRuleId not found
InvalidParameterException
- invalid populationRuleId,
populationId, or contextInfo
MissingParameterException
- missing populationRuleId,
populationId, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic StatusInfo removePopulationRuleFromPopulation(String populationRuleId, String populationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
removePopulationRuleFromPopulation
in interface PopulationService
populationRuleId
- a unique identifier for a PopulationRulepopulationId
- a unique identifier for a PopulationcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationRuleId or
populationId not found or unrelated
InvalidParameterException
- invalid populationRuleId,
populationId, or contextInfo
MissingParameterException
- missing populationRuleId,
populationId, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationCategoryInfo getPopulationCategory(String populationCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationCategory
in interface PopulationService
populationCategoryId
- a unique Id of a PopulationCategorycontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationCategoryId not found
InvalidParameterException
- invalid populationCategoryId or
contextInfo
MissingParameterException
- missing populationCategoryId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationCategoryInfo> getPopulationCategoriesByIds(List<String> populationCategoryIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationCategoriesByIds
in interface PopulationService
populationCategoryIds
- list of PopulationCategories to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- an populationCategoryId in list not found
InvalidParameterException
- invalid populationCategoryId or
contextInfo
MissingParameterException
- missing populationCategoryId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> getPopulationCategoryIdsByType(String populationTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationCategoryIdsByType
in interface PopulationService
populationTypeKey
- a PopulationCategory type to be retrievedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid PopulationTypeKey or contextInfo
MissingParameterException
- missing PopulationTypeKey or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationCategoryInfo> getPopulationCategoriesForPopulation(String populationId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
getPopulationCategoriesForPopulation
in interface PopulationService
populationId
- a Population keycontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid populationId or contextInfo
MissingParameterException
- missing populationId or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<String> searchForPopulationCategoryIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulationCategoryIds
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<PopulationCategoryInfo> searchForPopulationCategories(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
searchForPopulationCategories
in interface PopulationService
criteria
- the search criteriacontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
InvalidParameterException
- invalid criteria or contextInfo
MissingParameterException
- missing criteria or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validatePopulationCategory(String validationTypeKey, String populationCategoryTypeKey, PopulationCategoryInfo populationCategoryInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
validatePopulationCategory
in interface PopulationService
validationTypeKey
- the identifier of the extent of validationpopulationCategoryTypeKey
- the PopulationCategory type keypopulationCategoryInfo
- the PopulationCategory information to be testedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- validationTypeKey not found
InvalidParameterException
- invalid validationTypeKey,
PopulationInfo, or contextInfo
MissingParameterException
- missing validationTypeKey,
PopulationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic PopulationCategoryInfo createPopulationCategory(String populationCategoryTypeKey, PopulationCategoryInfo populationCategoryInfo, ContextInfo contextInfo) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
PopulationService
createPopulationCategory
in interface PopulationService
populationCategoryTypeKey
- the PopulationCategory type keypopulationCategoryInfo
- the details of PopulationCategory to be createdcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- one or more values invalid
for this operation
InvalidParameterException
- invalid PopulationInfo or
contextInfo
MissingParameterException
- missing PopulationInfo or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-onlypublic PopulationCategoryInfo updatePopulationCategory(String populationCategoryId, PopulationCategoryInfo populationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
PopulationService
updatePopulationCategory
in interface PopulationService
populationCategoryId
- the Id of PopulationCategory to be updatedpopulationInfo
- the details of updates to PopulationCategory
being updatedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DataValidationErrorException
- One or more values invalid
for this operation
DoesNotExistException
- populationCategoryId not found
InvalidParameterException
- invalid populationCategoryId,
PopulationInfo, or contextInfo
MissingParameterException
- missing populationCategoryId,
PopulationInfo, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
ReadOnlyException
- an attempt at supplying information
designated as read-only
VersionMismatchException
- The action was attempted on an out
of date version.public StatusInfo deletePopulationCategory(String populationCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
deletePopulationCategory
in interface PopulationService
populationCategoryId
- the Id of the PopulationCategory to be deletedcontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationCategoryId not found
InvalidParameterException
- invalid populationCategoryId or
contextInfo
MissingParameterException
- missing populationCategoryId or
contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic StatusInfo addPopulationToPopulationCategory(String populationId, String populationCategoryId, ContextInfo contextInfo) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
addPopulationToPopulationCategory
in interface PopulationService
populationId
- a unique identifier for a PopulationpopulationCategoryId
- a unique identifier for a PopulationCategorycontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
AlreadyExistsException
- populationId already related to
populationCategoryId
DoesNotExistException
- populationId or
populationCategoryId not found
InvalidParameterException
- invalid populationId,
populationCategoryId, or contextInfo
MissingParameterException
- missing populationId,
populationCategoryId, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failurepublic StatusInfo removePopulationFromPopulationCategory(String populationId, String populationCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
PopulationService
removePopulationFromPopulationCategory
in interface PopulationService
populationId
- a unique identifier for a PopulationpopulationCategoryId
- a unique identifier for a PopulationCategorycontextInfo
- Context information containing the
principalId and locale information about the caller of
service operation
DoesNotExistException
- populationId or
populationCategoryId not found or unrelated
InvalidParameterException
- invalid populationId,
populationCategoryId, or contextInfo
MissingParameterException
- missing populationId,
populationCategoryId, or contextInfo
OperationFailedException
- unable to complete request
PermissionDeniedException
- authorization failure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |