org.kuali.student.core.statement.service
Interface StatementService

All Superinterfaces:

DictionaryService, SearchService

All Known Implementing Classes:

StatementServiceImpl

public interface StatementService
extends DictionaryService, SearchService

Method Summary

RefStatementRelationInfo	createRefStatementRelation(RefStatementRelationInfo refStatementRelationInfo) Creates a relationship between a statement and an object.
ReqComponentInfo	createReqComponent(String reqComponentType, ReqComponentInfo reqComponentInfo) Creates a requirement component.
StatementInfo	createStatement(String statementType, StatementInfo statementInfo) Create a statement.
StatementTreeViewInfo	createStatementTreeView(StatementTreeViewInfo statementTreeViewInfo) Creates an entire Statement Tree.
StatusInfo	deleteRefStatementRelation(String refStatementRelationId) Removes a relationship between a statement and an object.
StatusInfo	deleteReqComponent(String reqComponentId) Deletes a requirement component
StatusInfo	deleteStatement(String statementId) Deletes a statement
StatusInfo	deleteStatementTreeView(String statementId) Deletes the entire statement tree
String	getNaturalLanguageForRefStatementRelation(String refStatementRelationId, String nlUsageTypeKey, String language) Retrieves the natural language translation for a particular object statement relationship in a particular context for a particular language.
String	getNaturalLanguageForReqComponent(String reqComponentId, String nlUsageTypeKey, String language) Translates and retrieves a requirement component for a specific usuage type (context) and language into natural language.
String	getNaturalLanguageForStatement(String statementId, String nlUsageTypeKey, String language) Translates and retrieves a statement for a specific usuage type (context) and language into natural language.
NlUsageTypeInfo	getNlUsageType(String nlUsageTypeKey) Retrieves information about the specified natural language usage type.
List<NlUsageTypeInfo>	getNlUsageTypes() Retrieves the list of natural language usage types known by the service.
List<String>	getRefObjectSubTypes(String objectTypeKey) Retrieves the list of types for a given base type which can be connected to a document.
List<String>	getRefObjectTypes() Retrieves the list of base types which can be connected to a document.
RefStatementRelationInfo	getRefStatementRelation(String refStatementRelationId) Retrieves a object statement relationship by its identifier.
List<RefStatementRelationInfo>	getRefStatementRelationsByRef(String refObjectTypeKey, String refObjectId) Retrieves a list of object statement relationships for a particular object.
List<RefStatementRelationInfo>	getRefStatementRelationsByStatement(String statementId) Retrieves a list of object statement relationships for a particular statement.
RefStatementRelationTypeInfo	getRefStatementRelationType(String refStatementRelationTypeKey) Retrieves information for a specified type of relationship between a statement and object.
List<RefStatementRelationTypeInfo>	getRefStatementRelationTypes() Retrieves the list of all types of relationships between statements and other objects.
List<String>	getRefStatementRelationTypesForRefObjectSubType(String refSubTypeKey) Retrieves the list of types of object statement relationships which are allowed to be used for a subtype of object.
ReqComponentInfo	getReqComponent(String reqComponentId) Retrieves a requirement component by its identifier
List<ReqComponentInfo>	getReqComponentsByType(String reqComponentTypeKey) Retrieves a list of requirement components of a particular type.
ReqComponentTypeInfo	getReqComponentType(String reqComponentTypeKey) Retrieves information for a specified fetchReqComponent Types
List<ReqComponentTypeInfo>	getReqComponentTypes() Retrieves the list of requirement component types known by this service.
List<ReqComponentTypeInfo>	getReqComponentTypesForStatementType(String statementTypeKey) Retrieves the list of types of requirement components which are allowed to be used in a type of statement.
StatementInfo	getStatement(String statementId) Retrieves a statement by its identifier
List<StatementInfo>	getStatementsByType(String statementTypeKey) Retrieves a list of statements of a particular Type
List<StatementInfo>	getStatementsUsingReqComponent(String reqComponentId) Retrieves a list of statements that use a particular requirement component.
List<StatementInfo>	getStatementsUsingStatement(String statementId) Retrieves a list of child statements that include a particular statement.
StatementTreeViewInfo	getStatementTreeView(String statementId) Retrieves a view of a statement by its identifier with its referenced statements and requirement components expanded
StatementTreeViewInfo	getStatementTreeViewForNlUsageType(String statementId, String nlUsageTypeKey, String language) Retrieves a view of a statement by its identifier with its referenced statements and requirement components expanded and translated
StatementTypeInfo	getStatementType(String statementTypeKey) Retrieves information for a specified type of statement
List<StatementTypeInfo>	getStatementTypes() Retrieves the list of all types of statements.
List<String>	getStatementTypesForRefStatementRelationType(String refStatementRelationTypeKey) Retrieves the list of statement types which are allowed to be used for a specified type of object statement relationship.
List<String>	getStatementTypesForStatementType(String statementTypeKey) Retrieves the list of statement types which are allowed to be used in a statement type.
String	translateReqComponentToNL(ReqComponentInfo reqComponentInfo, String nlUsageTypeKey, String language) Translates a particular requirement component to natural language for a particular context in a given language.
String	translateStatementTreeViewToNL(StatementTreeViewInfo statementTreeViewInfo, String nlUsageTypeKey, String language) Translates a statement tree view to natural language for a particular context in a particular language.
RefStatementRelationInfo	updateRefStatementRelation(String refStatementRelationId, RefStatementRelationInfo refStatementRelationInfo) Updates a relationship between an object and statement.
ReqComponentInfo	updateReqComponent(String reqComponentId, ReqComponentInfo reqComponentInfo) Updates a requirement component
StatementInfo	updateStatement(String statementId, StatementInfo statementInfo) Updates a statement
StatementTreeViewInfo	updateStatementTreeView(String statementId, StatementTreeViewInfo statementTreeViewInfo) Updates an entire Statement Tree.
List<ValidationResultInfo>	validateRefStatementRelation(String validationType, RefStatementRelationInfo refStatementRelationInfo) Validates a refStatementRelation.
List<ValidationResultInfo>	validateReqComponent(String validationType, ReqComponentInfo reqComponentInfo) Validates a ReqComponent.
List<ValidationResultInfo>	validateStatement(String validationType, StatementInfo statementInfo) Validates a statement.

Methods inherited from interface org.kuali.student.common.dictionary.service.DictionaryService

getObjectStructure, getObjectTypes

Methods inherited from interface org.kuali.student.common.search.service.SearchService

getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Method Detail

getRefObjectTypes

List<String> getRefObjectTypes()
                               throws OperationFailedException

Retrieves the list of base types which can be connected to a document.

Returns:

The list of types which can be connected to a document

Throws:

OperationFailedException - Unable to complete request

getRefObjectSubTypes

List<String> getRefObjectSubTypes(String objectTypeKey)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException

Retrieves the list of types for a given base type which can be connected to a document.

Parameters:

objectTypeKey - Reference Type Identifier

Returns:

The list of types for the given base type which can be connected to a document

Throws:

OperationFailedException - Unable to complete request

DoesNotExistException

InvalidParameterException

MissingParameterException

getNlUsageTypes

List<NlUsageTypeInfo> getNlUsageTypes()
                                      throws OperationFailedException

Retrieves the list of natural language usage types known by the service.

Returns:

List of natural language usage type information

Throws:

OperationFailedException - Unable to complete request

getNlUsageType

NlUsageTypeInfo getNlUsageType(String nlUsageTypeKey)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Retrieves information about the specified natural language usage type.

Parameters:

nlUsageTypeKey - Natural language usage type identifier

Returns:

Information about a type of natural language usage

Throws:

DoesNotExistException - nlUsageType not found

InvalidParameterException - Invalid nlUsageTypeKey

MissingParameterException - Missing nlUsageTypeKey

OperationFailedException - Unable to complete request

createRefStatementRelation

RefStatementRelationInfo createRefStatementRelation(RefStatementRelationInfo refStatementRelationInfo)
                                                    throws AlreadyExistsException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Creates a relationship between a statement and an object.

Parameters:

refStatementRelationInfo -

Returns:

New object statement relationship

Throws:

AlreadyExistsException - connection between object and statement already exists

DoesNotExistException - E.g. cluId, statementId, refStatementRelationType not found

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

PermissionDeniedException - Authorization failure

updateRefStatementRelation

RefStatementRelationInfo updateRefStatementRelation(String refStatementRelationId,
                                                    RefStatementRelationInfo refStatementRelationInfo)
                                                    throws DataValidationErrorException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           VersionMismatchException

Updates a relationship between an object and statement.

Parameters:

refStatementRelationId - Identifier of the object statement relationship to be updated

refStatementRelationInfo - Information about the object statement relationship to be updated

Returns:

Updated object statement relationship information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - refStatementRelation not found

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - Unable to complete request

PermissionDeniedException - Authorization failure

VersionMismatchException - The action was attempted on an out of date version.

deleteRefStatementRelation

StatusInfo deleteRefStatementRelation(String refStatementRelationId)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a relationship between a statement and an object.

Parameters:

refStatementRelationId - Object Statement Relationship identifier

Returns:

Status

Throws:

DoesNotExistException - RefStatementRelation not found

InvalidParameterException - Invalid refStatementRelationId

MissingParameterException - RefStatementRelationId not specified

OperationFailedException - Unable to complete request

PermissionDeniedException - Authorization failure

validateRefStatementRelation

List<ValidationResultInfo> validateRefStatementRelation(String validationType,
                                                        RefStatementRelationInfo refStatementRelationInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException

Validates a refStatementRelation. 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 relationship (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or 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.

Parameters:

validationType - Identifier of the extent of validation

refStatementRelationInfo - Object statement relationship information to be tested

Returns:

Results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - Invalid validationTypeKey, refStatementRelationInfo

MissingParameterException - Missing validationTypeKey, refStatementRelationInfo

OperationFailedException - Unable to complete request

getRefStatementRelation

RefStatementRelationInfo getRefStatementRelation(String refStatementRelationId)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Retrieves a object statement relationship by its identifier.

Parameters:

refStatementRelationId - Object statement relationship identifier

Returns:

Object statement relationship information

Throws:

DoesNotExistException - RefStatementRelation not found

InvalidParameterException - Invalid refStatementRelationId

MissingParameterException - RefStatementRelationId not specified

OperationFailedException - Unable to complete request

getRefStatementRelationsByRef

List<RefStatementRelationInfo> getRefStatementRelationsByRef(String refObjectTypeKey,
                                                             String refObjectId)
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException

Retrieves a list of object statement relationships for a particular object.

Parameters:

refObjectTypeKey - Reference type

refObjectId - Reference identifier

Returns:

List of object statement relationships for a particular object

Throws:

DoesNotExistException - Object not found

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

getRefStatementRelationsByStatement

List<RefStatementRelationInfo> getRefStatementRelationsByStatement(String statementId)
                                                                   throws DoesNotExistException,
                                                                          InvalidParameterException,
                                                                          MissingParameterException,
                                                                          OperationFailedException

Retrieves a list of object statement relationships for a particular statement.

Parameters:

statementId - Statement identifier

Returns:

List of object statement relationships for a particular statement

Throws:

DoesNotExistException - Statement not found

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

getNaturalLanguageForStatement

String getNaturalLanguageForStatement(String statementId,
                                      String nlUsageTypeKey,
                                      String language)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException

Translates and retrieves a statement for a specific usuage type (context) and language into natural language.

If language is null default language is used.

An StatementInfo can either have a list of StatementInfos as children or a list of ReqComponentInfos but not both. This means that all leaf nodes must be ReqComponentInfos.

Parameters:

statementId - Statement to translate

nlUsageTypeKey - Natural language usage type key (context)

language - Translation language

Throws:

DoesNotExistException - Statement not found

InvalidParameterException - Invalid nlUsageTypeKey

MissingParameterException - Missing statementId or nlUsageTypeKey

OperationFailedException - Unable to complete request

VersionMismatchException - The action was attempted on an out of date version.

getNaturalLanguageForRefStatementRelation

String getNaturalLanguageForRefStatementRelation(String refStatementRelationId,
                                                 String nlUsageTypeKey,
                                                 String language)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Retrieves the natural language translation for a particular object statement relationship in a particular context for a particular language.

Parameters:

refStatementRelationId - Object statement relationship identifier

nlUsageTypeKey - Context for the natural language translation

language - Language to use for the natural language translation

Returns:

Natural language translation for a particular object statement relationship in a particular context

Throws:

DoesNotExistException - Object statement relationship not found

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

getNaturalLanguageForReqComponent

String getNaturalLanguageForReqComponent(String reqComponentId,
                                         String nlUsageTypeKey,
                                         String language)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException

Translates and retrieves a requirement component for a specific usuage type (context) and language into natural language.

If language is null default language is used.

Parameters:

reqComponentId - Requirement component to translate

nlUsageTypeKey - Natural language usage type key (context)

language - Translation language

Throws:

DoesNotExistException - ReqComponent not found

InvalidParameterException - Invalid nlUsageTypeKey

MissingParameterException - Missing reqComponentId or nlUsageTypeKey

OperationFailedException - Unable to complete request

VersionMismatchException - The action was attempted on an out of date version.

translateStatementTreeViewToNL

String translateStatementTreeViewToNL(StatementTreeViewInfo statementTreeViewInfo,
                                      String nlUsageTypeKey,
                                      String language)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException

Translates a statement tree view to natural language for a particular context in a particular language. This may include statements and/or requirement components which have not yet been persisted to the service.

Parameters:

statementTreeViewInfo - Statement tree view

nlUsageTypeKey - Context for the natural language translation

language - Language to use for the natural language translation

Returns:

Natural language translation for a particular statement in a particular context

Throws:

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

translateReqComponentToNL

String translateReqComponentToNL(ReqComponentInfo reqComponentInfo,
                                 String nlUsageTypeKey,
                                 String language)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Translates a particular requirement component to natural language for a particular context in a given language. This may be used for requirement components which have not yet been persisted through the service.

Parameters:

reqComponentInfo - Requirement component

nlUsageTypeKey - Context for the natural language translation

language - Language to use for the natural language translation

Returns:

Natural language translation for a particular requirement component in a particular context

Throws:

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters not specified

OperationFailedException - Unable to complete request

validateReqComponent

List<ValidationResultInfo> validateReqComponent(String validationType,
                                                ReqComponentInfo reqComponentInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Validates a ReqComponent. 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 organization (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the organization can be shifted to the new values. If an identifier is not present or 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.

Parameters:

validationType - identifier of the extent of validation

reqComponentInfo - reqComponent information to be tested.

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, reqComponentInfo

MissingParameterException - missing validationTypeKey, reqComponentInfo

OperationFailedException - unable to complete request

validateStatement

List<ValidationResultInfo> validateStatement(String validationType,
                                             StatementInfo statementInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Validates a statement. 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 statement (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the statement can be shifted to the new values. If an identifier is not present or 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.

Parameters:

validationType - identifier of the extent of validation

statementInfo - statement information to be tested.

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, statementInfo

MissingParameterException - missing validationTypeKey, statementInfo

OperationFailedException - unable to complete request

getStatement

StatementInfo getStatement(String statementId)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Retrieves a statement by its identifier

Parameters:

statementId - statement identifier

Returns:

statementInfo statement information

Throws:

DoesNotExistException - statement not found

InvalidParameterException - invalid statementId

MissingParameterException - statementId not specified

OperationFailedException - unable to complete request

getStatementsByType

List<StatementInfo> getStatementsByType(String statementTypeKey)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Retrieves a list of statements of a particular Type

Parameters:

statementTypeKey - statementType identifier

Returns:

list of statements using the specified type

Throws:

DoesNotExistException - statementTypeKey not found

InvalidParameterException - invalid statementTypeKey

MissingParameterException - statementTypeKey not specified

OperationFailedException - unable to complete request

getReqComponent

ReqComponentInfo getReqComponent(String reqComponentId)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Retrieves a requirement component by its identifier

Parameters:

reqComponentId - requirement component identifier

Returns:

reqComponentInfo requirement component information

Throws:

DoesNotExistException - reqComponent not found

InvalidParameterException - invalid reqComponentId

MissingParameterException - reqComponentId not specified

OperationFailedException - unable to complete request

getReqComponentsByType

List<ReqComponentInfo> getReqComponentsByType(String reqComponentTypeKey)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Retrieves a list of requirement components of a particular type.

Parameters:

reqComponentTypeKey - identifier for a type of requirement component

Returns:

reqComponentInfoList A list of requirementComponents

Throws:

DoesNotExistException - reqComponentTypeKey not found

InvalidParameterException - invalid reqComponentTypeKey

MissingParameterException - reqComponentTypeKey not specified

OperationFailedException - unable to complete request

getStatementsUsingReqComponent

List<StatementInfo> getStatementsUsingReqComponent(String reqComponentId)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Retrieves a list of statements that use a particular requirement component. Note: The reference may not be direct, but through an intermediate object definition (ex. nested statements).

Parameters:

reqComponentId - requirement component identifier

Returns:

statementInfoList list of statements using the specified requirement component

Throws:

DoesNotExistException - reqComponentId not found

InvalidParameterException - invalid reqComponentId

MissingParameterException - reqComponentId not specified

OperationFailedException - unable to complete request

getStatementsUsingStatement

List<StatementInfo> getStatementsUsingStatement(String statementId)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Retrieves a list of child statements that include a particular statement. Note: The reference may not be direct, but through an intermediate object definition (e.g. nested statements).

Parameters:

statementId - statement identifier

Returns:

List of child statements using the specified statement

Throws:

DoesNotExistException - Statement not found

InvalidParameterException - Invalid statementId

MissingParameterException - statementId not specified

OperationFailedException - Unable to complete request

createReqComponent

ReqComponentInfo createReqComponent(String reqComponentType,
                                    ReqComponentInfo reqComponentInfo)
                                    throws AlreadyExistsException,
                                           DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Creates a requirement component.

Parameters:

reqComponentType - identifier of the type of requirement component

reqComponentInfo - information about the requirement component

Returns:

information about the newly created requirement component

Throws:

AlreadyExistsException - Requirement Component already exists

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - reqComponentType not found

InvalidParameterException - invalid reqComponentType, reqComponentInfo

MissingParameterException - missing reqComponentType, reqComponentInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteReqComponent

StatusInfo deleteReqComponent(String reqComponentId)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Deletes a requirement component

Parameters:

reqComponentId - identifier of the requirement component to delete

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - reqComponentId not found

InvalidParameterException - invalid reqComponentId

MissingParameterException - missing reqComponentId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createStatement

StatementInfo createStatement(String statementType,
                              StatementInfo statementInfo)
                              throws AlreadyExistsException,
                                     DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Create a statement.

Parameters:

statementType - identifier of the type of statement

statementInfo - information about the statement

Returns:

information about the newly created statement

Throws:

AlreadyExistsException - statement already exists

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - statementType not found

InvalidParameterException - invalid statementType, statementInfo

MissingParameterException - missing statementType, statementInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateStatement

StatementInfo updateStatement(String statementId,
                              StatementInfo statementInfo)
                              throws CircularReferenceException,
                                     DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     VersionMismatchException

Updates a statement

Parameters:

statementId - identifier of the statement to be updated

statementInfo - information about the statement to be updated

Returns:

the updated statement information

Throws:

CircularReferenceException - included statement references the current statement

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - statement not found

InvalidParameterException - invalid statementId, statementInfo

MissingParameterException - missing statementId, statementInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

deleteStatement

StatusInfo deleteStatement(String statementId)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Deletes a statement

Parameters:

statementId - identifier of the Statement to delete

Returns:

statusInfo status of the operation (success or failure)

Throws:

DoesNotExistException - statement not found

InvalidParameterException - invalid statementId

MissingParameterException - missing statementId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getStatementType

StatementTypeInfo getStatementType(String statementTypeKey)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Retrieves information for a specified type of statement

Parameters:

statementTypeKey - statement type identifier

Returns:

statement type information

Throws:

DoesNotExistException - statementTypeKey not found

InvalidParameterException - invalid statementTypeKey

MissingParameterException - missing statementTypeKey

OperationFailedException - unable to complete request

getStatementTypes

List<StatementTypeInfo> getStatementTypes()
                                          throws OperationFailedException

Retrieves the list of all types of statements.

Returns:

List of types of statements

Throws:

OperationFailedException - Unable to complete request

getStatementTypesForStatementType

List<String> getStatementTypesForStatementType(String statementTypeKey)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Retrieves the list of statement types which are allowed to be used in a statement type. This controls the nesting of statements.

Parameters:

statementTypeKey - Identifier for a type of statement

Returns:

List of statement type

Throws:

DoesNotExistException - statementTypeKey not found

InvalidParameterException - Invalid statementTypeKey

MissingParameterException - Missing statementTypeKey

OperationFailedException - Unable to complete request

getReqComponentTypes

List<ReqComponentTypeInfo> getReqComponentTypes()
                                                throws OperationFailedException

Retrieves the list of requirement component types known by this service.

Returns:

list of requirement component types

Throws:

OperationFailedException - unable to complete request

getReqComponentType

ReqComponentTypeInfo getReqComponentType(String reqComponentTypeKey)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException

Retrieves information for a specified fetchReqComponent Types

Parameters:

reqComponentTypeKey - reqComponent Type Key

Returns:

Requirement component type information

Throws:

DoesNotExistException - reqComponentTypeKey not found

InvalidParameterException - invalid reqComponentTypeKey

MissingParameterException - missing reqComponentTypeKey

OperationFailedException - unable to complete request

getReqComponentTypesForStatementType

List<ReqComponentTypeInfo> getReqComponentTypesForStatementType(String statementTypeKey)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException

Retrieves the list of types of requirement components which are allowed to be used in a type of statement.

Parameters:

statementTypeKey - identifier for a type of statement

Returns:

list of types of requirement components

Throws:

DoesNotExistException - statementTypeKey not found

InvalidParameterException - invalid statementTypeKey

MissingParameterException - missing statementTypeKey

OperationFailedException - unable to complete request

getRefStatementRelationTypes

List<RefStatementRelationTypeInfo> getRefStatementRelationTypes()
                                                                throws OperationFailedException

Retrieves the list of all types of relationships between statements and other objects.

Returns:

List of object statement relation types

Throws:

OperationFailedException - Unable to complete request

getRefStatementRelationType

RefStatementRelationTypeInfo getRefStatementRelationType(String refStatementRelationTypeKey)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException

Retrieves information for a specified type of relationship between a statement and object.

Parameters:

refStatementRelationTypeKey - Object statement relation type identifier

Returns:

Object statement relation type information

Throws:

DoesNotExistException - refStatementRelationTypeKey not found

InvalidParameterException - Invalid refStatementRelationTypeKey

MissingParameterException - Missing refStatementRelationTypeKey

OperationFailedException - Unable to complete request

getStatementTypesForRefStatementRelationType

List<String> getStatementTypesForRefStatementRelationType(String refStatementRelationTypeKey)
                                                          throws DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException

Retrieves the list of statement types which are allowed to be used for a specified type of object statement relationship.

Parameters:

refStatementRelationTypeKey - Identifier for a type of object statement relationship

Returns:

List of statement types

Throws:

DoesNotExistException - refStatementRelationTypeKey not found

InvalidParameterException - Invalid refStatementRelationTypeKey

MissingParameterException - Missing refStatementRelationTypeKey

OperationFailedException - Unable to complete request

getRefStatementRelationTypesForRefObjectSubType

List<String> getRefStatementRelationTypesForRefObjectSubType(String refSubTypeKey)
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException

Retrieves the list of types of object statement relationships which are allowed to be used for a subtype of object.

Parameters:

refSubTypeKey - Identifier for the subtype of object

Returns:

Throws:

DoesNotExistException - refSubType not found

InvalidParameterException - Invalid refSubTypeKey

MissingParameterException - Missing refSubTypeKey

OperationFailedException - Unable to complete request

updateReqComponent

ReqComponentInfo updateReqComponent(String reqComponentId,
                                    ReqComponentInfo reqComponentInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           VersionMismatchException

Updates a requirement component

Parameters:

reqComponentId - identifier of the requirement component to be updated

reqComponentInfo - information about the requirement component to be updated

Returns:

the updated requirement component information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - Requirement Component not found

InvalidParameterException - invalid reqComponentId, reqComponentInfo

MissingParameterException - missing reqComponentId, reqComponentInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

getStatementTreeView

StatementTreeViewInfo getStatementTreeView(String statementId)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException

Retrieves a view of a statement by its identifier with its referenced statements and requirement components expanded

Parameters:

statementId - statement identifier

Returns:

view of statement information with the referenced statements and requirement components expanded

Throws:

DoesNotExistException - statement not found

InvalidParameterException - invalid statementId

MissingParameterException - statementId not specified

OperationFailedException - unable to complete request

getStatementTreeViewForNlUsageType

StatementTreeViewInfo getStatementTreeViewForNlUsageType(String statementId,
                                                         String nlUsageTypeKey,
                                                         String language)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException

Retrieves a view of a statement by its identifier with its referenced statements and requirement components expanded and translated

Parameters:

statementId - statement identifier

nlUsageTypeKey - Natural language usage type identifier

language - Translation language

Returns:

view of statement information with the referenced statements and requirement components expanded

Throws:

DoesNotExistException - statement not found

InvalidParameterException - invalid statementId

MissingParameterException - statementId not specified

OperationFailedException - unable to complete request

updateStatementTreeView

StatementTreeViewInfo updateStatementTreeView(String statementId,
                                              StatementTreeViewInfo statementTreeViewInfo)
                                              throws CircularReferenceException,
                                                     DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     VersionMismatchException

Updates an entire Statement Tree. Fails unless everything can be done. Updates Statements, RequirementComponents and any relations between them. If there are "deletes", the relations are removed, but the object is not deleted unless used no where else

Parameters:

statementId - identifier of the statement to be updated

statementTreeViewInfo - The StatementTreeInfo to be updated

Returns:

the updated StatementTree information

Throws:

CircularRelationshipException - included statement references the current statement

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - Statement not found

InvalidParameterException - invalid statementId, statementTreeViewInfo

MissingParameterException - missing statementId, statementTreeViewInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

CircularReferenceException

createStatementTreeView

StatementTreeViewInfo createStatementTreeView(StatementTreeViewInfo statementTreeViewInfo)
                                              throws CircularReferenceException,
                                                     AlreadyExistsException,
                                                     DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Creates an entire Statement Tree. Fails unless everything can be done. Updates Statements, RequirementComponents and any relations between them. If there are "deletes", the relations are removed, but the object is not deleted unless used no where else

Parameters:

statementTreeViewInfo -

Returns:

Statement tree view

Throws:

CircularReferenceException - included statement references the current statement

AlreadyExistsException

DataValidationErrorException

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

deleteStatementTreeView

StatusInfo deleteStatementTreeView(String statementId)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes the entire statement tree

Parameters:

statementId -

Returns:

Status of delete

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException