org.kuali.student.r2.core.process
Class ProcessPocPopulationServiceMockImpl

java.lang.Object
  extended by org.kuali.student.r2.core.process.ProcessPocPopulationServiceMockImpl
All Implemented Interfaces:
MockService, PopulationService

public class ProcessPocPopulationServiceMockImpl
extends Object
implements PopulationService, MockService


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

ProcessPocPopulationServiceMockImpl

public ProcessPocPopulationServiceMockImpl()
Method Detail

clear

public void clear()
Description copied from interface: MockService
Clear all cached service data. This should place the service back to its initial configuration.

Specified by:
clear in interface MockService

isMemberAsOfDate

public Boolean isMemberAsOfDate(String personId,
                                String populationId,
                                Date date,
                                ContextInfo contextInfo)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException
Description copied from interface: PopulationService
Tests if a Person is a member of a Population.

Specified by:
isMemberAsOfDate in interface PopulationService
Parameters:
personId - a unique Id of a Person
populationId - a unique Id of a Population
date - the date on which to perform the evaluation
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
true if the person is a member of the Population, false otherwise
Throws:
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 failure

getMembersAsOfDate

public List<String> getMembersAsOfDate(String populationId,
                                       Date date,
                                       ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
Description copied from interface: PopulationService
Gets a list of people Ids who qualify as a member of a Population. This method is intended for auditing purposes in setting up and testing Population rules.

Specified by:
getMembersAsOfDate in interface PopulationService
Parameters:
populationId - a unique Id of a Population
date - the date on which to perform the evaluation
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of Person Ids
Throws:
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 failure

getPopulation

public PopulationInfo getPopulation(String populationId,
                                    ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a Population.

Specified by:
getPopulation in interface PopulationService
Parameters:
populationId - a unique Id of a Population
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a Population
Throws:
DoesNotExistException - populationId not found
InvalidParameterException - invalid populationId or contextInfo
MissingParameterException - missing populationId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationsByIds

public List<PopulationInfo> getPopulationsByIds(List<String> populationIds,
                                                ContextInfo contextInfo)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of Populations corresponding to the given list of Population Ids.

Specified by:
getPopulationsByIds in interface PopulationService
Parameters:
populationIds - list of Populationss to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of Population Ids of the given type
Throws:
DoesNotExistException - an populationId in list not found
InvalidParameterException - invalid populationId or contextInfo
MissingParameterException - missing populationId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationIdsByType

public List<String> getPopulationIdsByType(String populationTypeId,
                                           ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of Population Ids of the specified type.

Specified by:
getPopulationIdsByType in interface PopulationService
Parameters:
populationTypeId - a Population type to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of Population Ids
Throws:
InvalidParameterException - invalid populationTypeId or contextInfo
MissingParameterException - missing populationTypeId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationsForPopulationRule

public List<PopulationInfo> getPopulationsForPopulationRule(String populationRuleId,
                                                            ContextInfo contextInfo)
                                                     throws InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of Populations in which the given PopulationRule is applied.

Specified by:
getPopulationsForPopulationRule in interface PopulationService
Parameters:
populationRuleId - a PopulationRule Id
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of Populations
Throws:
InvalidParameterException - invalid populationRuleId or contextInfo
MissingParameterException - missing populationRuleId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulationIds

public List<String> searchForPopulationIds(QueryByCriteria criteria,
                                           ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Description copied from interface: PopulationService
Searches for Populations based on the criteria and returns a list of Population identifiers which match the search criteria.

Specified by:
searchForPopulationIds in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of Population Ids
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulations

public List<PopulationInfo> searchForPopulations(QueryByCriteria criteria,
                                                 ContextInfo contextInfo)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException
Description copied from interface: PopulationService
Searches for Populations based on the criteria and returns a list of Populations which match the search criteria.

Specified by:
searchForPopulations in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of Populations
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

validatePopulation

public List<ValidationResultInfo> validatePopulation(String validationTypeId,
                                                     PopulationInfo populationInfo,
                                                     ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Description copied from interface: PopulationService
Validates a Population. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Population and a record is found for that identifier, the validation checks if the Population can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Specified by:
validatePopulation in interface PopulationService
Parameters:
validationTypeId - the identifier of the extent of validation
populationInfo - the Population information to be tested
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
Results from performing the validation
Throws:
DoesNotExistException - validationTypeId not found
InvalidParameterException - invalid validationTypeId, populationInfo, or contextInfo
MissingParameterException - missing validationTypeKey, populationInfo, or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

createPopulation

public PopulationInfo createPopulation(PopulationInfo populationInfo,
                                       ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       ReadOnlyException
Description copied from interface: PopulationService
Creates a new Population.

Specified by:
createPopulation in interface PopulationService
Parameters:
populationInfo - the details of Population to be created
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the Population just created
Throws:
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-only

updatePopulation

public PopulationInfo updatePopulation(String populationId,
                                       PopulationInfo populationInfo,
                                       ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       ReadOnlyException,
                                       VersionMismatchException
Description copied from interface: PopulationService
Updates an existing Population.

Specified by:
updatePopulation in interface PopulationService
Parameters:
populationId - the Id of Population to be updated
populationInfo - the details of updates to Population being updated
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the details of Population just updated
Throws:
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.

deletePopulation

public StatusInfo deletePopulation(String populationId,
                                   ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
Description copied from interface: PopulationService
Deletes an existing Population.

Specified by:
deletePopulation in interface PopulationService
Parameters:
populationId - the Id of the Population to be deleted
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status of the operation (success, failed)
Throws:
DoesNotExistException - populationId not found
InvalidParameterException - invalid populationId or contextInfo
MissingParameterException - missing populationId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationRule

public PopulationRuleInfo getPopulationRule(String populationRuleId,
                                            ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a PopulationRule.

Specified by:
getPopulationRule in interface PopulationService
Parameters:
populationRuleId - a unique Id of a PopulationRule
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a PopulationRule
Throws:
DoesNotExistException - populationRuleId not found
InvalidParameterException - invalid populationRuleId or contextInfo
MissingParameterException - missing populationRuleId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationRulesByIds

public List<PopulationRuleInfo> getPopulationRulesByIds(List<String> populationRuleIds,
                                                        ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationRules corresponding to the given list of PopulationRule Ids.

Specified by:
getPopulationRulesByIds in interface PopulationService
Parameters:
populationRuleIds - list of PopulationRules to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of PopulationRule Ids of the given type
Throws:
DoesNotExistException - an populationRuleId in list not found
InvalidParameterException - invalid populationRuleId or contextInfo
MissingParameterException - missing populationRuleId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationRuleIdsByType

public List<String> getPopulationRuleIdsByType(String populationTypeKey,
                                               ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationRule Ids of the specified type.

Specified by:
getPopulationRuleIdsByType in interface PopulationService
Parameters:
populationTypeKey - a PopulationRule type to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of PopulationRule Ids
Throws:
InvalidParameterException - invalid populationTypeKey or contextInfo
MissingParameterException - missing populationTypeKey or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationRuleForPopulation

public PopulationRuleInfo getPopulationRuleForPopulation(String populationKey,
                                                         ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationRules in which the given Population is related.

Specified by:
getPopulationRuleForPopulation in interface PopulationService
Parameters:
populationKey - a Population id
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a PopulationRules
Throws:
DoesNotExistException - populationId is not found
InvalidParameterException - invalid populationid or contextInfo
MissingParameterException - missing populationId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulationRuleIds

public List<String> searchForPopulationRuleIds(QueryByCriteria criteria,
                                               ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
Description copied from interface: PopulationService
Searches for PopulationRules based on the criteria and returns a list of PopulationRule identifiers which match the search criteria.

Specified by:
searchForPopulationRuleIds in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of PopulationRule Ids
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulationRules

public List<PopulationRuleInfo> searchForPopulationRules(QueryByCriteria criteria,
                                                         ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
Description copied from interface: PopulationService
Searches for PopulationRules based on the criteria and returns a list of PopulationRules which match the search criteria.

Specified by:
searchForPopulationRules in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of PopulationRules
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

validatePopulationRule

public List<ValidationResultInfo> validatePopulationRule(String validationTypeKey,
                                                         PopulationRuleInfo populationInfo,
                                                         ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
Description copied from interface: PopulationService
Validates a PopulationRule. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the PopulationRule and a record is found for that identifier, the validation checks if the PopulationRule can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Specified by:
validatePopulationRule in interface PopulationService
Parameters:
validationTypeKey - the identifier of the extent of validation
populationInfo - the PopulationRule information to be tested
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
Results from performing the validation
Throws:
DoesNotExistException - validationTypeKey not found
InvalidParameterException - invalid validationTypeKey, populationInfo, or contextInfo
MissingParameterException - missing validationTypeKey, populationInfo, or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

createPopulationRule

public PopulationRuleInfo createPopulationRule(PopulationRuleInfo populationInfo,
                                               ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException
Description copied from interface: PopulationService
Creates a new PopulationRule.

Specified by:
createPopulationRule in interface PopulationService
Parameters:
populationInfo - the details of PopulationRule to be created
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the PopulationRule just created
Throws:
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-only

updatePopulationRule

public PopulationRuleInfo updatePopulationRule(String populationRuleId,
                                               PopulationRuleInfo populationInfo,
                                               ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException
Description copied from interface: PopulationService
Updates an existing PopulationRule.

Specified by:
updatePopulationRule in interface PopulationService
Parameters:
populationRuleId - the Id of PopulationRule to be updated
populationInfo - the details of updates to PopulationRule being updated
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the details of PopulationRule just updated
Throws:
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.

deletePopulationRule

public StatusInfo deletePopulationRule(String populationRuleId,
                                       ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
Description copied from interface: PopulationService
Deletes an existing PopulationRule.

Specified by:
deletePopulationRule in interface PopulationService
Parameters:
populationRuleId - the Id of the PopulationRule to be deleted
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status of the operation (success, failed)
Throws:
DoesNotExistException - populationRuleId not found
InvalidParameterException - invalid populationRuleId or contextInfo
MissingParameterException - missing populationRuleId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

applyPopulationRuleToPopulation

public StatusInfo applyPopulationRuleToPopulation(String populationRuleId,
                                                  String populationId,
                                                  ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException
Description copied from interface: PopulationService
Applies PopulationRule to a Population. If the Population already has a rule, it is replaced with the specified one.

Specified by:
applyPopulationRuleToPopulation in interface PopulationService
Parameters:
populationRuleId - a unique identifier for a PopulationRule
populationId - a unique identifier for a Population
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status
Throws:
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 failure

removePopulationRuleFromPopulation

public StatusInfo removePopulationRuleFromPopulation(String populationRuleId,
                                                     String populationId,
                                                     ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Description copied from interface: PopulationService
Removes Population from a PopulationRule.

Specified by:
removePopulationRuleFromPopulation in interface PopulationService
Parameters:
populationRuleId - a unique identifier for a PopulationRule
populationId - a unique identifier for a Population
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status
Throws:
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 failure

getPopulationCategory

public PopulationCategoryInfo getPopulationCategory(String populationCategoryId,
                                                    ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a PopulationCategory.

Specified by:
getPopulationCategory in interface PopulationService
Parameters:
populationCategoryId - a unique Id of a PopulationCategory
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a PopulationCategory
Throws:
DoesNotExistException - populationCategoryId not found
InvalidParameterException - invalid populationCategoryId or contextInfo
MissingParameterException - missing populationCategoryId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationCategoriesByIds

public List<PopulationCategoryInfo> getPopulationCategoriesByIds(List<String> populationCategoryIds,
                                                                 ContextInfo contextInfo)
                                                          throws DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationCategorys corresponding to the given list of PopulationCategory Ids.

Specified by:
getPopulationCategoriesByIds in interface PopulationService
Parameters:
populationCategoryIds - list of PopulationCategories to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of PopulationCategory Ids of the given type
Throws:
DoesNotExistException - an populationCategoryId in list not found
InvalidParameterException - invalid populationCategoryId or contextInfo
MissingParameterException - missing populationCategoryId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationCategoryIdsByType

public List<String> getPopulationCategoryIdsByType(String populationTypeKey,
                                                   ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationCategory Ids of the specified type.

Specified by:
getPopulationCategoryIdsByType in interface PopulationService
Parameters:
populationTypeKey - a PopulationCategory type to be retrieved
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of PopulationCategory Ids
Throws:
InvalidParameterException - invalid PopulationTypeKey or contextInfo
MissingParameterException - missing PopulationTypeKey or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

getPopulationCategoriesForPopulation

public List<PopulationCategoryInfo> getPopulationCategoriesForPopulation(String populationId,
                                                                         ContextInfo contextInfo)
                                                                  throws InvalidParameterException,
                                                                         MissingParameterException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException
Description copied from interface: PopulationService
Retrieves a list of PopulationCategories in which the given Population is related.

Specified by:
getPopulationCategoriesForPopulation in interface PopulationService
Parameters:
populationId - a Population key
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
a list of PopulationCategories
Throws:
InvalidParameterException - invalid populationId or contextInfo
MissingParameterException - missing populationId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulationCategoryIds

public List<String> searchForPopulationCategoryIds(QueryByCriteria criteria,
                                                   ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException
Description copied from interface: PopulationService
Searches for PopulationCategories based on the criteria and returns a list of PopulationCategory identifiers which match the search criteria.

Specified by:
searchForPopulationCategoryIds in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of PopulationCategory Ids
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

searchForPopulationCategories

public List<PopulationCategoryInfo> searchForPopulationCategories(QueryByCriteria criteria,
                                                                  ContextInfo contextInfo)
                                                           throws InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException
Description copied from interface: PopulationService
Searches for PopulationCategories based on the criteria and returns a list of PopulationCategories which match the search criteria.

Specified by:
searchForPopulationCategories in interface PopulationService
Parameters:
criteria - the search criteria
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
list of PopulationCategories
Throws:
InvalidParameterException - invalid criteria or contextInfo
MissingParameterException - missing criteria or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

validatePopulationCategory

public List<ValidationResultInfo> validatePopulationCategory(String validationTypeKey,
                                                             String populationCategoryTypeKey,
                                                             PopulationCategoryInfo populationCategoryInfo,
                                                             ContextInfo contextInfo)
                                                      throws DoesNotExistException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException
Description copied from interface: PopulationService
Validates a PopulationCategory. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the PopulationCategory and a record is found for that identifier, the validation checks if the PopulationCategory can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Specified by:
validatePopulationCategory in interface PopulationService
Parameters:
validationTypeKey - the identifier of the extent of validation
populationCategoryTypeKey - the PopulationCategory type key
populationCategoryInfo - the PopulationCategory information to be tested
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
Results from performing the validation
Throws:
DoesNotExistException - validationTypeKey not found
InvalidParameterException - invalid validationTypeKey, PopulationInfo, or contextInfo
MissingParameterException - missing validationTypeKey, PopulationInfo, or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

createPopulationCategory

public PopulationCategoryInfo createPopulationCategory(String populationCategoryTypeKey,
                                                       PopulationCategoryInfo populationCategoryInfo,
                                                       ContextInfo contextInfo)
                                                throws DataValidationErrorException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException,
                                                       ReadOnlyException
Description copied from interface: PopulationService
Creates a new PopulationCategory.

Specified by:
createPopulationCategory in interface PopulationService
Parameters:
populationCategoryTypeKey - the PopulationCategory type key
populationCategoryInfo - the details of PopulationCategory to be created
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the PopulationCategory just created
Throws:
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-only

updatePopulationCategory

public PopulationCategoryInfo updatePopulationCategory(String populationCategoryId,
                                                       PopulationCategoryInfo populationInfo,
                                                       ContextInfo contextInfo)
                                                throws DataValidationErrorException,
                                                       DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException,
                                                       ReadOnlyException,
                                                       VersionMismatchException
Description copied from interface: PopulationService
Updates an existing PopulationCategory.

Specified by:
updatePopulationCategory in interface PopulationService
Parameters:
populationCategoryId - the Id of PopulationCategory to be updated
populationInfo - the details of updates to PopulationCategory being updated
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
the details of PopulationCategory just updated
Throws:
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.

deletePopulationCategory

public StatusInfo deletePopulationCategory(String populationCategoryId,
                                           ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Description copied from interface: PopulationService
Deletes an existing PopulationCategory.

Specified by:
deletePopulationCategory in interface PopulationService
Parameters:
populationCategoryId - the Id of the PopulationCategory to be deleted
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status of the operation (success, failed)
Throws:
DoesNotExistException - populationCategoryId not found
InvalidParameterException - invalid populationCategoryId or contextInfo
MissingParameterException - missing populationCategoryId or contextInfo
OperationFailedException - unable to complete request
PermissionDeniedException - authorization failure

addPopulationToPopulationCategory

public StatusInfo addPopulationToPopulationCategory(String populationId,
                                                    String populationCategoryId,
                                                    ContextInfo contextInfo)
                                             throws AlreadyExistsException,
                                                    DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
Description copied from interface: PopulationService
Adds Population to a PopulationCategory.

Specified by:
addPopulationToPopulationCategory in interface PopulationService
Parameters:
populationId - a unique identifier for a Population
populationCategoryId - a unique identifier for a PopulationCategory
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status
Throws:
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 failure

removePopulationFromPopulationCategory

public StatusInfo removePopulationFromPopulationCategory(String populationId,
                                                         String populationCategoryId,
                                                         ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
Description copied from interface: PopulationService
Removes Population from a PopulationCategory.

Specified by:
removePopulationFromPopulationCategory in interface PopulationService
Parameters:
populationId - a unique identifier for a Population
populationCategoryId - a unique identifier for a PopulationCategory
contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:
status
Throws:
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


Copyright © 2004-2013 The Kuali Foundation. All Rights Reserved.