org.kuali.student.r2.lum.lo.service.impl
Class LearningObjectiveServiceImpl

java.lang.Object
  extended by org.kuali.student.r2.lum.lo.service.impl.LearningObjectiveServiceImpl
All Implemented Interfaces:
SearchService, LearningObjectiveService

public class LearningObjectiveServiceImpl
extends Object
implements LearningObjectiveService


Constructor Summary
LearningObjectiveServiceImpl()
           
 
Method Summary
 StatusInfo addLoCategoryToLo(String loCategoryId, String loId, ContextInfo contextInfo)
          Adds a LoCategory to a Lo
 LoInfo createLo(String repositoryId, String loType, LoInfo loInfo, ContextInfo contextInfo)
          Creates a new Lo.
 LoCategoryInfo createLoCategory(String loCategoryTypeKey, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Creates a new LoCategory.
 LoLoRelationInfo createLoLoRelation(String loLoRelationTypeKey, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Creates a new LoLoRelation.
 LoRepositoryInfo createLoRepository(String loRepositoryKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Creates a new LoRepository.
 StatusInfo deleteLo(String loId, ContextInfo contextInfo)
          Deletes an existing Lo.
 StatusInfo deleteLoCategory(String loCategoryId, ContextInfo contextInfo)
          Deletes an existing LoCategory.
 StatusInfo deleteLoCategoryByLo(String loId, ContextInfo contextInfo)
          Deletes existing LoCategories of a Lo.
 StatusInfo deleteLoLoRelation(String loLoRelationId, ContextInfo contextInfo)
          Deletes an existing LoLoRelation.
 StatusInfo deleteLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Deletes an existing LoRepository.
 List<String> getAllowedLoLoRelationTypesForLoType(String loTypeKey, String relatedLoTypeKey, ContextInfo contextInfo)
           
 LoInfo getLo(String loId, ContextInfo contextInfo)
          Retrieves a single Lo by an Lo Id.
 List<LoInfo> getLoByIdList(List<String> loIds, ContextInfo contextInfo)
           
 List<LoCategoryInfo> getLoCategories(String loRepositoryKey, ContextInfo contextInfo)
           
 List<LoCategoryInfo> getLoCategoriesByIds(List<String> loCategoryIds, ContextInfo contextInfo)
          Retrieves a list of LoCategories from a list of LoCategory Ids.
 List<LoCategoryInfo> getLoCategoriesByLo(String loId, ContextInfo contextInfo)
          Retrieves a list of LoCategories by Lo.
 List<LoCategoryInfo> getLoCategoriesByLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Retrieves a list of LoCategories by their associated repository key
 List<LoCategoryInfo> getLoCategoriesForLo(String loId, ContextInfo contextInfo)
           
 LoCategoryInfo getLoCategory(String loCategoryId, ContextInfo contextInfo)
          Retrieves a single LoCategory by an LoCategory Id.
 List<String> getLoCategoryIdsByType(String loCategoryTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoCategory Ids by LoCategory Type.
 LoCategoryTypeInfo getLoCategoryType(String loCategoryTypeKey, ContextInfo contextInfo)
           
 List<LoCategoryTypeInfo> getLoCategoryTypes()
           
 LoDao getLoDao()
           
 List<String> getLoIdsByType(String loTypeKey, ContextInfo contextInfo)
          Retrieves a list of Lo Ids by Lo Type.
 LoLoRelationInfo getLoLoRelation(String loLoRelationId, ContextInfo contextInfo)
          Retrieves a single LoLoRelation by an LoLoRelation Id.
 List<String> getLoLoRelationIdsByType(String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoLoRelation Ids by LoLoRelation Type.
 List<LoLoRelationInfo> getLoLoRelationsByIds(List<String> loLoRelationIds, ContextInfo contextInfo)
          Retrieves a list of LoLoRelations from a list of LoLoRelation Ids.
 List<LoLoRelationInfo> getLoLoRelationsByLoId(String loId, ContextInfo contextInfo)
          Retrieves a list of LoLoRelations by Lo.
 LoLoRelationTypeInfo getLoLoRelationType(String loLoRelationTypeKey, ContextInfo contextInfo)
           
 List<LoLoRelationTypeInfo> getLoLoRelationTypes(ContextInfo contextInfo)
           
 List<LoRepositoryInfo> getLoRepositories(ContextInfo contextInfo)
          Retrieves a list of LoRepositories.
 List<LoRepositoryInfo> getLoRepositoriesByKeys(List<String> loRepositoryKeys, ContextInfo contextInfo)
          Retrieves a list of LoRepositories from a list of LoRepository Keys.
 LoRepositoryInfo getLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Retrieves a single LoRepository by an LoRepository Key.
 List<String> getLoRepositoryKeysByType(String loRepositoryTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoRepository keys by LoRepository Type.
 List<LoInfo> getLosByIds(List<String> loIds, ContextInfo contextInfo)
          Retrieves a list of Los from a list of Lo Ids.
 List<LoInfo> getLosByLoCategory(String loCategoryId, ContextInfo contextInfo)
          Retrieves a list of Los by LoCategory.
 List<LoInfo> getLosByLoRepository(String loRepositoryKey, String loTypeKey, String loStateKey, ContextInfo contextInfo)
          Retrieves a list of Los by LoRepository.
 List<LoInfo> getLosByRelatedLoId(String relatedLoId, String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of Los by related Lo.
 List<LoInfo> getLosByRepository(String loRepositoryKey, String loTypeKey, String loStateKey)
           
 LoTypeInfo getLoType(String loTypeKey, ContextInfo contextInfo)
           
 List<LoTypeInfo> getLoTypes(ContextInfo contextInfo)
           
 ObjectStructureDefinition getObjectStructure(String objectTypeKey, ContextInfo contextInfo)
           
 List<LoInfo> getRelatedLosByLoId(String loId, String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of related Los by Lo.
 SearchCriteriaTypeInfo getSearchCriteriaType(String searchCriteriaTypeKey)
          Retrieves information about a particular search criteria type.
 List<SearchCriteriaTypeInfo> getSearchCriteriaTypes()
          Retrieves the list of search criteria types known by this service.
 SearchResultTypeInfo getSearchResultType(String searchResultTypeKey)
          Retrieves information about a particular search result type.
 List<SearchResultTypeInfo> getSearchResultTypes()
          Retrieves the list of search result types known by this service.
 SearchTypeInfo getSearchType(String searchTypeKey)
          Retrieves information about a particular search type.
 List<SearchTypeInfo> getSearchTypes()
          Retrieves the list of search types known by this service.
 List<SearchTypeInfo> getSearchTypesByCriteria(String searchCriteriaTypeKey)
          Retrieves the list of search types which use criteria in the specified format.
 List<SearchTypeInfo> getSearchTypesByResult(String searchResultTypeKey)
          Retrieves the list of search types which return results in the specified format.
 ValidatorFactory getValidatorFactory()
           
 StatusInfo removeLoCategoryFromLo(String loCategoryId, String loId, ContextInfo contextInfo)
          Removes a LoCategory from a Lo
 SearchResult search(SearchRequest searchRequest)
           
 List<LoCategoryInfo> searchForLoCategories(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoCategories that meet the given search criteria.
 List<String> searchForLoCategoryIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoCategories that meet the given search criteria.
 List<String> searchForLoIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for Los that meet the given search criteria.
 List<String> searchForLoLoRelationIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoLoRelations that meet the given search criteria.
 List<LoLoRelationInfo> searchForLoLoRelations(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoLoRelations that meet the given search criteria.
 List<LoRepositoryInfo> searchForLoRepositories(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoRepositories that meet the given search criteria.
 List<String> searchForLoRepositoryKeys(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoRepositories that meet the given search criteria.
 List<LoInfo> searchForLos(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for Los that meet the given search criteria.
 void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)
           
 void setLoDao(LoDao dao)
           
 void setSearchManager(SearchManager searchManager)
           
 void setValidatorFactory(ValidatorFactory validatorFactory)
           
 LoInfo updateLo(String loId, LoInfo loInfo, ContextInfo contextInfo)
          Updates an existing Lo.
 LoCategoryInfo updateLoCategory(String loCategoryId, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Updates an existing LoCategory.
 LoLoRelationInfo updateLoLoRelation(String loLoRelationId, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Updates an existing LoLoRelation.
 LoRepositoryInfo updateLoRepository(String loRepositoryKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Updates an existing LoRepository.
 List<ValidationResultInfo> validateLo(String validationType, LoInfo loInfo, ContextInfo contextInfo)
          Validates an Lo.
 List<ValidationResultInfo> validateLoCategory(String validationType, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Validates an LoCategory.
 List<ValidationResultInfo> validateLoLoRelation(String validationType, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Validates an LoLoRelation.
 List<ValidationResultInfo> validateLoRepository(String validationTypeKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Validates an LoRepository.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LearningObjectiveServiceImpl

public LearningObjectiveServiceImpl()
Method Detail

getLoDao

public LoDao getLoDao()

setLoDao

public void setLoDao(LoDao dao)

setSearchManager

public void setSearchManager(SearchManager searchManager)

setDictionaryServiceDelegate

public void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)

getValidatorFactory

public ValidatorFactory getValidatorFactory()

setValidatorFactory

public void setValidatorFactory(ValidatorFactory validatorFactory)

getLoRepositories

@Transactional(readOnly=true)
public List<LoRepositoryInfo> getLoRepositories(ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoRepositories.

Specified by:
getLoRepositories in interface LearningObjectiveService
Parameters:
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepositoryKeysByType

public List<String> getLoRepositoryKeysByType(String loRepositoryTypeKey,
                                              ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoRepository keys by LoRepository Type.

Specified by:
getLoRepositoryKeysByType in interface LearningObjectiveService
Parameters:
loRepositoryTypeKey - a unique key for an LoRepository Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepository keys matching loRepositoryTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoRepositoryKeys

public List<String> searchForLoRepositoryKeys(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                              ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoRepositories that meet the given search criteria.

Specified by:
searchForLoRepositoryKeys in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepository keys matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoRepositories

public List<LoRepositoryInfo> searchForLoRepositories(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                                      ContextInfo contextInfo)
                                               throws InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoRepositories that meet the given search criteria.

Specified by:
searchForLoRepositories in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

validateLoRepository

public List<ValidationResultInfo> validateLoRepository(String validationTypeKey,
                                                       String loRepositoryTypeKey,
                                                       LoRepositoryInfo loRepositoryInfo,
                                                       ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException
Description copied from interface: LearningObjectiveService
Validates an LoRepository. Depending on the value of validationType, this validation could be limited to tests on just the current LoRepository and its directly contained sub-objects or expanded to perform all tests related to this LoRepository. If an identifier is present for the LoRepository (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LoRepository can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoRepository with the given data can be created.

Specified by:
validateLoRepository in interface LearningObjectiveService
Parameters:
validationTypeKey - the identifier for the validation Type
loRepositoryTypeKey - the identifier for the LoRepository Type
loRepositoryInfo - the LoRepository to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loRepositoryTypeKey is not found
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loRepositoryTypeKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLoRepository

public LoRepositoryInfo createLoRepository(String loRepositoryKey,
                                           String loRepositoryTypeKey,
                                           LoRepositoryInfo loRepositoryInfo,
                                           ContextInfo contextInfo)
                                    throws AlreadyExistsException,
                                           DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException
Description copied from interface: LearningObjectiveService
Creates a new LoRepository. The LoRepository Type, and Meta information may not be set in the supplied data object.

Specified by:
createLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - a unique key for the new LoRepository
loRepositoryTypeKey - the identifier for the Type of LoRepository to be created
loRepositoryInfo - the data with which to create the LoRepository
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoRepository
Throws:
AlreadyExistsException - loRepositoryKey already exists
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loRepositoryTypeKey does not exist or is not supported
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - loRepositoryTypeKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

updateLoRepository

public LoRepositoryInfo updateLoRepository(String loRepositoryKey,
                                           LoRepositoryInfo loRepositoryInfo,
                                           ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException,
                                           VersionMismatchException
Description copied from interface: LearningObjectiveService
Updates an existing LoRepository. The LoRepository Key, Type, and Meta information may not be changed.

Specified by:
updateLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - the identifier for the LoRepository to be updated
loRepositoryInfo - the new data for the LoRepository
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoRepository
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - loRepositoryKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLoRepository

public StatusInfo deleteLoRepository(String loRepositoryKey,
                                     ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
Description copied from interface: LearningObjectiveService
Deletes an existing LoRepository.

Specified by:
deleteLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - the identifier for the LoRepository to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKey or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepository

@Transactional(readOnly=true)
public LoRepositoryInfo getLoRepository(String loRepositoryKey,
                                                              ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a single LoRepository by an LoRepository Key.

Specified by:
getLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - the identifier for the LoRepository to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoRepository requested
Throws:
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKey or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepositoriesByKeys

public List<LoRepositoryInfo> getLoRepositoriesByKeys(List<String> loRepositoryKeys,
                                                      ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoRepositories from a list of LoRepository Keys. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:
getLoRepositoriesByKeys in interface LearningObjectiveService
Parameters:
loRepositoryKeys - a list of LoRepository Keys
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories
Throws:
DoesNotExistException - an loRepositoryKey in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKeys, a key in the loRepositoryKeys, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoTypes

@Transactional(readOnly=true)
public List<LoTypeInfo> getLoTypes(ContextInfo contextInfo)
                            throws OperationFailedException
Specified by:
getLoTypes in interface LearningObjectiveService
Throws:
OperationFailedException

getLoType

@Transactional(readOnly=true)
public LoTypeInfo getLoType(String loTypeKey,
                                                  ContextInfo contextInfo)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException
Specified by:
getLoType in interface LearningObjectiveService
Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

getLoLoRelationTypes

@Transactional(readOnly=true)
public List<LoLoRelationTypeInfo> getLoLoRelationTypes(ContextInfo contextInfo)
                                                throws OperationFailedException
Specified by:
getLoLoRelationTypes in interface LearningObjectiveService
Throws:
OperationFailedException

getLoLoRelationType

@Transactional(readOnly=true)
public LoLoRelationTypeInfo getLoLoRelationType(String loLoRelationTypeKey,
                                                                      ContextInfo contextInfo)
                                         throws OperationFailedException,
                                                MissingParameterException,
                                                DoesNotExistException
Specified by:
getLoLoRelationType in interface LearningObjectiveService
Throws:
OperationFailedException
MissingParameterException
DoesNotExistException

getAllowedLoLoRelationTypesForLoType

@Transactional(readOnly=true)
public List<String> getAllowedLoLoRelationTypesForLoType(String loTypeKey,
                                                                               String relatedLoTypeKey,
                                                                               ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException
Specified by:
getAllowedLoLoRelationTypesForLoType in interface LearningObjectiveService
Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

addLoCategoryToLo

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo addLoCategoryToLo(String loCategoryId,
                                                                                                                                      String loId,
                                                                                                                                      ContextInfo contextInfo)
                             throws AlreadyExistsException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException
Description copied from interface: LearningObjectiveService
Adds a LoCategory to a Lo

Specified by:
addLoCategoryToLo in interface LearningObjectiveService
Parameters:
loCategoryId - the identifier for the LoCategory
loId - the identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
AlreadyExistsException - LoCategory already exists for Lo
DoesNotExistException - loCategoryId or loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId, loId, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
UnsupportedActionException - loCategoryId and loId are not in the same repository

getLoLoRelationsByIds

public List<LoLoRelationInfo> getLoLoRelationsByIds(List<String> loLoRelationIds,
                                                    ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoLoRelations from a list of LoLoRelation Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:
getLoLoRelationsByIds in interface LearningObjectiveService
Parameters:
loLoRelationIds - a list of LoLoRelation identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations
Throws:
DoesNotExistException - an loLoRelationId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationIds, an Id in the loLoRelationIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoLoRelationIdsByType

public List<String> getLoLoRelationIdsByType(String loLoRelationTypeKey,
                                             ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoLoRelation Ids by LoLoRelation Type.

Specified by:
getLoLoRelationIdsByType in interface LearningObjectiveService
Parameters:
loLoRelationTypeKey - an identifier for an LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelation identifiers matching loLoRelationTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoLoRelationIds

public List<String> searchForLoLoRelationIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                             ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoLoRelations that meet the given search criteria.

Specified by:
searchForLoLoRelationIds in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelation identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoLoRelations

public List<LoLoRelationInfo> searchForLoLoRelations(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                                     ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoLoRelations that meet the given search criteria.

Specified by:
searchForLoLoRelations in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLo

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoInfo createLo(String repositoryId,
                                                                                                                         String loType,
                                                                                                                         LoInfo loInfo,
                                                                                                                         ContextInfo contextInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException,
                       ReadOnlyException
Description copied from interface: LearningObjectiveService
Creates a new Lo. The Lo Id, Type, and Meta information may not be set in the supplied data object.

Specified by:
createLo in interface LearningObjectiveService
loInfo - the data with which to create the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new Lo
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loTypeKey does not exist or is not supported
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - loTypeKey, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

deleteLo

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteLo(String loId,
                                                                                                                             ContextInfo contextInfo)
                    throws DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           DependentObjectsExistException
Description copied from interface: LearningObjectiveService
Deletes an existing Lo.

Specified by:
deleteLo in interface LearningObjectiveService
Parameters:
loId - the identifier for the Lo to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
DependentObjectsExistException

deleteLoCategory

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteLoCategory(String loCategoryId,
                                                                                                                                     ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   DependentObjectsExistException
Description copied from interface: LearningObjectiveService
Deletes an existing LoCategory.

Specified by:
deleteLoCategory in interface LearningObjectiveService
Parameters:
loCategoryId - the identifier for the LoCategory to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
DependentObjectsExistException

deleteLoCategoryByLo

public StatusInfo deleteLoCategoryByLo(String loId,
                                       ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
Description copied from interface: LearningObjectiveService
Deletes existing LoCategories of a Lo.

Specified by:
deleteLoCategoryByLo in interface LearningObjectiveService
Parameters:
loId - the identifier for the Lo for which LoCategories are to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLo

@Transactional(readOnly=true)
public LoInfo getLo(String loId,
                                          ContextInfo contextInfo)
             throws DoesNotExistException,
                    InvalidParameterException,
                    MissingParameterException,
                    OperationFailedException
Description copied from interface: LearningObjectiveService
Retrieves a single Lo by an Lo Id.

Specified by:
getLo in interface LearningObjectiveService
Parameters:
loId - the identifier for the Lo to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the Lo requested
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request

getLosByIds

public List<LoInfo> getLosByIds(List<String> loIds,
                                ContextInfo contextInfo)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of Los from a list of Lo Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:
getLosByIds in interface LearningObjectiveService
Parameters:
loIds - a list of Lo identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los
Throws:
DoesNotExistException - an loId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loIds, an Id in the loIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoIdsByType

public List<String> getLoIdsByType(String loTypeKey,
                                   ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of Lo Ids by Lo Type.

Specified by:
getLoIdsByType in interface LearningObjectiveService
Parameters:
loTypeKey - an identifier for an Lo Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Lo identifiers matching loTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByLoRepository

public List<LoInfo> getLosByLoRepository(String loRepositoryKey,
                                         String loTypeKey,
                                         String loStateKey,
                                         ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of Los by LoRepository.

Specified by:
getLosByLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - a key for the LoRepository
loTypeKey - the identifier for the Lo Type
loStateKey - the identifier for the Lo State
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the LoRepository
Throws:
DoesNotExistException - loRepositoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoByIdList

@Transactional(readOnly=true)
public List<LoInfo> getLoByIdList(List<String> loIds,
                                                        ContextInfo contextInfo)
                           throws InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException
Specified by:
getLoByIdList in interface LearningObjectiveService
Throws:
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategories

@Transactional(readOnly=true)
public List<LoCategoryInfo> getLoCategories(String loRepositoryKey,
                                                                  ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException
Specified by:
getLoCategories in interface LearningObjectiveService
Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategoriesForLo

@Transactional(readOnly=true)
public List<LoCategoryInfo> getLoCategoriesForLo(String loId,
                                                                       ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException
Specified by:
getLoCategoriesForLo in interface LearningObjectiveService
Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategory

@Transactional(readOnly=true)
public LoCategoryInfo getLoCategory(String loCategoryId,
                                                          ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException
Description copied from interface: LearningObjectiveService
Retrieves a single LoCategory by an LoCategory Id.

Specified by:
getLoCategory in interface LearningObjectiveService
Parameters:
loCategoryId - the identifier for the LoCategory to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoCategory requested
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request

getLoCategoriesByIds

public List<LoCategoryInfo> getLoCategoriesByIds(List<String> loCategoryIds,
                                                 ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoCategories from a list of LoCategory Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:
getLoCategoriesByIds in interface LearningObjectiveService
Parameters:
loCategoryIds - a list of LoCategory identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories
Throws:
DoesNotExistException - an loCategoryId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryIds, an Id in the loCategoryIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoryIdsByType

public List<String> getLoCategoryIdsByType(String loCategoryTypeKey,
                                           ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoCategory Ids by LoCategory Type.

Specified by:
getLoCategoryIdsByType in interface LearningObjectiveService
Parameters:
loCategoryTypeKey - an identifier for an LoCategory Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategory identifiers matching loCategoryTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoriesByLo

public List<LoCategoryInfo> getLoCategoriesByLo(String loId,
                                                ContextInfo contextInfo)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoCategories by Lo.

Specified by:
getLoCategoriesByLo in interface LearningObjectiveService
Parameters:
loId - an identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoCategoryIds

public List<String> searchForLoCategoryIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                           ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoCategories that meet the given search criteria.

Specified by:
searchForLoCategoryIds in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategory identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoCategories

public List<LoCategoryInfo> searchForLoCategories(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                                  ContextInfo contextInfo)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for LoCategories that meet the given search criteria.

Specified by:
searchForLoCategories in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByLoCategory

@Transactional(readOnly=true)
public List<LoInfo> getLosByLoCategory(String loCategoryId,
                                                             ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException
Description copied from interface: LearningObjectiveService
Retrieves a list of Los by LoCategory.

Specified by:
getLosByLoCategory in interface LearningObjectiveService
Parameters:
loCategoryId - an identifier for the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the LoCategory
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request

searchForLoIds

public List<String> searchForLoIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                   ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for Los that meet the given search criteria.

Specified by:
searchForLoIds in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Lo identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLos

public List<LoInfo> searchForLos(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                 ContextInfo contextInfo)
                          throws InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException
Description copied from interface: LearningObjectiveService
Searches for Los that meet the given search criteria.

Specified by:
searchForLos in interface LearningObjectiveService
Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

removeLoCategoryFromLo

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo removeLoCategoryFromLo(String loCategoryId,
                                                                                                                                           String loId,
                                                                                                                                           ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException
Description copied from interface: LearningObjectiveService
Removes a LoCategory from a Lo

Specified by:
removeLoCategoryFromLo in interface LearningObjectiveService
Parameters:
loCategoryId - the identifier for the LoCategory
loId - the identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loCategoryId or loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId, loId, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
UnsupportedActionException - loCategoryId and loId are not in the same repository

updateLo

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoInfo updateLo(String loId,
                                                                                                                         LoInfo loInfo,
                                                                                                                         ContextInfo contextInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException,
                       VersionMismatchException
Description copied from interface: LearningObjectiveService
Updates an existing Lo. The Lo Id, Type, and Meta information may not be changed.

Specified by:
updateLo in interface LearningObjectiveService
Parameters:
loId - the identifier for the Lo to be updated
loInfo - the new data for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated Lo
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loId is not found
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - loId, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

updateLoCategory

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoCategoryInfo updateLoCategory(String loCategoryId,
                                                                                                                                         LoCategoryInfo loCategoryInfo,
                                                                                                                                         ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       VersionMismatchException
Description copied from interface: LearningObjectiveService
Updates an existing LoCategory. The LoCategory Id, Type, and Meta information may not be changed.

Specified by:
updateLoCategory in interface LearningObjectiveService
Parameters:
loCategoryId - the identifier for the LoCategory to be updated
loCategoryInfo - the new data for the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoCategory
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loCategoryId is not found
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - loCategoryId, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

validateLo

public List<ValidationResultInfo> validateLo(String validationType,
                                             LoInfo loInfo,
                                             ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException
Description copied from interface: LearningObjectiveService
Validates an Lo. Depending on the value of validationType, this validation could be limited to tests on just the current Lo and its directly contained sub-objects or expanded to perform all tests related to this Lo. If an identifier is present for the Lo (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Lo can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the Lo with the given data can be created.

Specified by:
validateLo in interface LearningObjectiveService
Parameters:
validationType - the identifier for the Lo Type to be validated
loInfo - the Lo to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loTypeKey is not found
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loTypeKey, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request

validateLoCategory

public List<ValidationResultInfo> validateLoCategory(String validationType,
                                                     LoCategoryInfo loCategoryInfo,
                                                     ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException
Description copied from interface: LearningObjectiveService
Validates an LoCategory. Depending on the value of validationType, this validation could be limited to tests on just the current LoCategory and its directly contained sub-objects or expanded to perform all tests related to this LoCategory. If an identifier is present for the LoCategory (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LoCategory can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoCategory with the given data can be created.

Specified by:
validateLoCategory in interface LearningObjectiveService
Parameters:
validationType - the identifier for the LoCategory Type to be validated
loCategoryInfo - the LoCategory to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loCategoryTypeKey is not found
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loCategoryTypeKey, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request

validateLoLoRelation

public List<ValidationResultInfo> validateLoLoRelation(String validationType,
                                                       LoLoRelationInfo loLoRelationInfo,
                                                       ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException
Description copied from interface: LearningObjectiveService
Validates an LoLoRelation. Depending on the value of validationType, this validation could be limited to tests on just the current LoLoRelation and its directly contained sub-objects or expanded to perform all tests related to this LoLoRelation. If an identifier is present for the LoLoRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LoLoRelation can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoLoRelation with the given data can be created.

Specified by:
validateLoLoRelation in interface LearningObjectiveService
Parameters:
validationType - the identifier for the LoLoRelation Type to be validated
loLoRelationInfo - the LoLoRelation to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loLoRelationTypeKey is not found
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loLoRelationTypeKey, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request

getObjectStructure

public ObjectStructureDefinition getObjectStructure(String objectTypeKey,
                                                    ContextInfo contextInfo)

getSearchCriteriaType

public SearchCriteriaTypeInfo getSearchCriteriaType(String searchCriteriaTypeKey)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException
Description copied from interface: SearchService
Retrieves information about a particular search criteria type.

Specified by:
getSearchCriteriaType in interface SearchService
Parameters:
searchCriteriaTypeKey - identifier of the search criteria type
Returns:
information on the search criteria type
Throws:
DoesNotExistException - specified searchCriteriaTypeKey not found
InvalidParameterException - invalid searchCriteriaTypeKey
MissingParameterException - searchCriteriaTypeKey not specified
OperationFailedException - unable to complete request

getSearchCriteriaTypes

public List<SearchCriteriaTypeInfo> getSearchCriteriaTypes()
                                                    throws OperationFailedException
Description copied from interface: SearchService
Retrieves the list of search criteria types known by this service.

Specified by:
getSearchCriteriaTypes in interface SearchService
Returns:
list of search criteria type information
Throws:
OperationFailedException - unable to complete request

getSearchResultType

public SearchResultTypeInfo getSearchResultType(String searchResultTypeKey)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException
Description copied from interface: SearchService
Retrieves information about a particular search result type. Search result types describe the return structure for a search.

Specified by:
getSearchResultType in interface SearchService
Parameters:
searchResultTypeKey - identifier of the search result type
Returns:
information on the search result type
Throws:
DoesNotExistException - specified searchResultTypeKey not found
InvalidParameterException - invalid searchResultTypeKey
MissingParameterException - searchResultTypeKey not specified
OperationFailedException - unable to complete request

getSearchResultTypes

public List<SearchResultTypeInfo> getSearchResultTypes()
                                                throws OperationFailedException
Description copied from interface: SearchService
Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.

Specified by:
getSearchResultTypes in interface SearchService
Returns:
list of search result type information
Throws:
OperationFailedException - unable to complete request

getSearchType

public SearchTypeInfo getSearchType(String searchTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException
Description copied from interface: SearchService
Retrieves information about a particular search type.

Specified by:
getSearchType in interface SearchService
Parameters:
searchTypeKey - identifier of the search type
Returns:
information on the search type
Throws:
DoesNotExistException - specified searchTypeKey not found
InvalidParameterException - invalid searchTypeKey
MissingParameterException - searchTypeKey not specified
OperationFailedException - unable to complete request

getSearchTypes

public List<SearchTypeInfo> getSearchTypes()
                                    throws OperationFailedException
Description copied from interface: SearchService
Retrieves the list of search types known by this service.

Specified by:
getSearchTypes in interface SearchService
Returns:
list of search type information
Throws:
OperationFailedException - unable to complete request

getSearchTypesByCriteria

public List<SearchTypeInfo> getSearchTypesByCriteria(String searchCriteriaTypeKey)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException
Description copied from interface: SearchService
Retrieves the list of search types which use criteria in the specified format.

Specified by:
getSearchTypesByCriteria in interface SearchService
Parameters:
searchCriteriaTypeKey - identifier of the search criteria
Returns:
list of search type information
Throws:
DoesNotExistException - specified searchCriteriaTypeKey not found
InvalidParameterException - invalid searchCriteriaTypeKey
MissingParameterException - searchCriteriaTypeKey not specified
OperationFailedException - unable to complete request

getSearchTypesByResult

public List<SearchTypeInfo> getSearchTypesByResult(String searchResultTypeKey)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException
Description copied from interface: SearchService
Retrieves the list of search types which return results in the specified format.

Specified by:
getSearchTypesByResult in interface SearchService
Parameters:
searchResultTypeKey - identifier of the search result type
Returns:
list of search type information
Throws:
DoesNotExistException - specified searchResultTypeKey not found
InvalidParameterException - invalid searchResultTypeKey
MissingParameterException - searchResultTypeKey not specified
OperationFailedException - unable to complete request

createLoLoRelation

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoLoRelationInfo createLoLoRelation(String loLoRelationTypeKey,
                                                                                                                                             LoLoRelationInfo loLoRelationInfo,
                                                                                                                                             ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException
Description copied from interface: LearningObjectiveService
Creates a new LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be set in the supplied data object.

Specified by:
createLoLoRelation in interface LearningObjectiveService
Parameters:
loLoRelationTypeKey - the identifier for the Type of LoLoRelation to be created
loLoRelationInfo - the data with which to create the LoLoRelation
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoLoRelation
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loLoRelationTypeKey does not exist or is not supported
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - loLoRelationTypeKey, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

getLoLoRelation

@Transactional(readOnly=true)
public LoLoRelationInfo getLoLoRelation(String loLoRelationId,
                                                              ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a single LoLoRelation by an LoLoRelation Id.

Specified by:
getLoLoRelation in interface LearningObjectiveService
Parameters:
loLoRelationId - the identifier for the LoLoRelation to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoLoRelation requested
Throws:
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoLoRelationsByLoId

@Transactional(readOnly=true)
public List<LoLoRelationInfo> getLoLoRelationsByLoId(String loId,
                                                                           ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoLoRelations by Lo.

Specified by:
getLoLoRelationsByLoId in interface LearningObjectiveService
Parameters:
loId - an identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByRelatedLoId

@Transactional(readOnly=true)
public List<LoInfo> getLosByRelatedLoId(String relatedLoId,
                                                              String loLoRelationTypeKey,
                                                              ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of Los by related Lo.

Specified by:
getLosByRelatedLoId in interface LearningObjectiveService
Parameters:
relatedLoId - an identifier for the related Lo
loLoRelationTypeKey - the identifier for the LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the related Lo
Throws:
DoesNotExistException - relatedLoId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - relatedLoId, loLoRelationTypeKey, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getRelatedLosByLoId

@Transactional(readOnly=true)
public List<LoInfo> getRelatedLosByLoId(String loId,
                                                              String loLoRelationTypeKey,
                                                              ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of related Los by Lo.

Specified by:
getRelatedLosByLoId in interface LearningObjectiveService
Parameters:
loId - an identifier for the Lo
loLoRelationTypeKey - the identifier for the LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of related Los for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

updateLoLoRelation

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoLoRelationInfo updateLoLoRelation(String loLoRelationId,
                                                                                                                                             LoLoRelationInfo loLoRelationInfo,
                                                                                                                                             ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException,
                                           VersionMismatchException
Description copied from interface: LearningObjectiveService
Updates an existing LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be changed.

Specified by:
updateLoLoRelation in interface LearningObjectiveService
Parameters:
loLoRelationId - the identifier for the LoLoRelation to be updated
loLoRelationInfo - the new data for the LoLoRelation
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoLoRelation
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - loLoRelationId, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLoLoRelation

public StatusInfo deleteLoLoRelation(String loLoRelationId,
                                     ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
Description copied from interface: LearningObjectiveService
Deletes an existing LoLoRelation.

Specified by:
deleteLoLoRelation in interface LearningObjectiveService
Parameters:
loLoRelationId - the identifier for the LoLoRelation to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLoCategory

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public LoCategoryInfo createLoCategory(String loCategoryTypeKey,
                                                                                                                                         LoCategoryInfo loCategoryInfo,
                                                                                                                                         ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       ReadOnlyException
Description copied from interface: LearningObjectiveService
Creates a new LoCategory. The LoCategory Id, Type, and Meta information may not be set in the supplied data object.

Specified by:
createLoCategory in interface LearningObjectiveService
Parameters:
loCategoryTypeKey - the identifier for the Type of LoCategory to be created
loCategoryInfo - the data with which to create the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoCategory
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loCategoryTypeKey does not exist or is not supported
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - loCategoryTypeKey, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

getLoCategoryType

@Transactional(readOnly=true)
public LoCategoryTypeInfo getLoCategoryType(String loCategoryTypeKey,
                                                                  ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException
Specified by:
getLoCategoryType in interface LearningObjectiveService
Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategoryTypes

@Transactional(readOnly=true)
public List<LoCategoryTypeInfo> getLoCategoryTypes()
                                            throws OperationFailedException
Specified by:
getLoCategoryTypes in interface LearningObjectiveService
Throws:
OperationFailedException

getLosByRepository

@Transactional(readOnly=true)
public List<LoInfo> getLosByRepository(String loRepositoryKey,
                                                             String loTypeKey,
                                                             String loStateKey)
                                throws InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException
Specified by:
getLosByRepository in interface LearningObjectiveService
Throws:
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategoriesByLoRepository

public List<LoCategoryInfo> getLoCategoriesByLoRepository(String loRepositoryKey,
                                                          ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException
Description copied from interface: LearningObjectiveService
Retrieves a list of LoCategories by their associated repository key

Specified by:
getLoCategoriesByLoRepository in interface LearningObjectiveService
Parameters:
loRepositoryKey - a list of LoCategory identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories
Throws:
DoesNotExistException - an loCategoryId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryIds, an Id in the loCategoryIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

search

public SearchResult search(SearchRequest searchRequest)
                    throws MissingParameterException
Specified by:
search in interface SearchService
Throws:
MissingParameterException


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