TypeService

Name	Type
Version	1.0 (Dev)
Included Services
Java Package	org.kuali.student.r2.core.class1.type.service

Main Message Structures

Method getType

Description Gets the Type identified by a type Key.

Parameters String typeKey Key of the type

ContextInfo contextInfo Context information containing the principalId
and locale information about the caller of service
operation

Return TypeInfo the type requested

Errors DoesNotExistException typeKey not found

InvalidParameterException contextInfo is not valid

MissingParameterException typeKey or contextInfo is
missing or null

OperationFailedException unable to complete request

PermissionDeniedException an authorization failure occurred

Method	getType
Description	Gets the Type identified by a type Key.
Parameters	String	typeKey	Key of the type
ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo	the type requested
Errors	DoesNotExistException	typeKey not found
InvalidParameterException	contextInfo is not valid
MissingParameterException	typeKey or contextInfo is missing or null
OperationFailedException	unable to complete request
PermissionDeniedException	an authorization failure occurred

Method	getTypesByKeys
Description	Retrieves a list of Types from a list of keys. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	typeKeys	a list of Type keys
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of Types
Errors	DoesNotExistException		a typeKey in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		typeKeys, a key in typeKeys, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getRefObjectUris
Description	Get a list of refObjectURI's that are known to this implementation of the service. A RefObjectURI is how objects are uniquely identified in Kuali STudent. A RefObjectURI is composed of two parts the name space of the service in which the object is defined and then the simple java name (no class path) of the object itself. For example: http://student.kuali.org/wsdl/luService/CluInfo
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of string refObjectURIs
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getTypesByRefObjectUri
Description	This method returns a list of TypeInfo that belong to a RefObjectUri. For e.g all types for CluInfo
Parameters	String	refObjectUri	a URI identifying the object e.g http://student.kuali.org/wsdl/luService/CluInfo
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of TypeInfo objects associated with the object
Errors	DoesNotExistException		refObjectURI not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		refObjectURI or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getTypesForGroupType
Description	Get the list of types that are in the group defined by this group type. This is a convenience method to retrieve TypeTypeRelations with a grouping relation filtering them to see if they are active and then fetching those types. Active is defined two ways: the state must be ACTIVE and today must be between the effective and expiration dates of the relationship. Note: The type itself may or may not be active but since that is returned consuming program is free to filter on that object. Should be functionally equivalent to calling the following: relations = getTypeTypeRelationsForOwnerAndType (type, GROUP) filterRelations (type=ACTIVE and today between effective and expiration return getTypes (filteredRelations) The relationship is captured unidirectionally from ownerType to relatedType.
Parameters	String	groupTypeKey	typeKey used to do the grouping
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of TypeInfo objects associated with the object
Errors	DoesNotExistException		refObjectURI not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		refObjectURI or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getAllowedTypesForType
Description	Get the list of Types that are allowed for another typeKey. This is a convenience method to retrieve TypeTypeRelations with allowed relation filtering them to see if they are active and then fetching those types. Active is defined two ways: the state must be ACTIVE and today must be between the effective and expiration dates of the relationship. Note: The type itself may or may not be active but since that is returned consuming program is free to filter on that object. Should be functionally equivalent to calling the following: relations = getTypeTypeRelationsForOwnerAndType (type, ALLOWED) filterRelations (type=ACTIVE and today between effective and expiration return getTypes (filteredRelations) The relationship is captured unidirectionally from ownerType to relatedType.
Parameters	String	ownerTypeKey	Type key of the owner in the relation
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		???
Errors	DoesNotExistException		ownerTypeKey
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		ownerTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	validateType
Description	Validates a Type. 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 Type. If an identifier is present for the Type and a record is found for that identifier, the validation checks if the Type can be shifted to the new values. If a an identifier is not present or a record does not exist, the validation checks if the Type with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	TypeInfo	typeInfo	the identifier for the Type to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey is not found
	InvalidParameterException		typeInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, typeInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	createType
Description	Creates a new Type. The Type Key and Meta information may not be set in the supplied data object.
Parameters	String	typeKey	a unique for the new Type
	TypeInfo	typeInfo	the data with which to create the Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		the new Type
Errors	AlreadyExistsException		typeKey already exists
	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		typeInfo or contextInfo is not valid
	MissingParameterException		typeKey, typeInfo, 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

Method	updateType
Description	Updates an existing Type. The Type Key and Meta information may not be changed.
Parameters	String	typeKey	the identifier for the Type to be updated
	TypeInfo	typeInfo	the new data for the Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		the updated Type
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		typeKey is not found
	InvalidParameterException		typeInfo or contextInfo is not valid
	MissingParameterException		typeKey, typeInfo, 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
	VersionMismatchException		an optimistic locking failure or the action was attempted on an out of date version

Method	deleteType
Description	Deletes an existing Type.
Parameters	String	typeKey	the identifier for the Type to be deleted
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		the status of the operation. This must always be true.
Errors	DoesNotExistException		typeKey is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		typeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getTypeTypeRelation
Description	Gets the TypeTypeRelation identified by TypeTypeRelation Id.
Parameters	String	typeTypeRelationId	an identifier of the TypeTypeRelation
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeTypeRelationInfo		the type type relation requested
Errors	DoesNotExistException		typeTypeRelationId not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		typeTypeRelationId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getTypeTypeRelationsByIds
Description	Retrieves a list of TypeTypeRelations from a list of Idss. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	typeTypeRelationIds	a list of TypeTypeRelation Ids
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeTypeRelationInfoList		a list of TypeTypeRelations
Errors	DoesNotExistException		a typeTypeRelationId in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		typeTypeRelationIds, a id in typeTypeRelationIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getTypeTypeRelationsByOwnerAndType
Description	This method retrieves all the TypeTypeRelation objects for a given ownerType and the TypeTypeRelationType. This is the reverse of getTypeTypeRelationsByRelatedTypeAndType.
Parameters	String	ownerTypeKey	Type key of the owner in the relation
	String	typeTypeRelationTypeKey	the identifier for the Type of the TypeTypeRelation
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeTypeRelationInfoList		List of TypeTypeRelations for a given ownerType
Errors	DoesNotExistException		ownerTypeKey or typeTypeRelationTypeKey not found
	InvalidParameterException		invalid ownerTypeKey or typeTypeRelationTypeKey
	MissingParameterException		missing ownerTypeKey, typeTypeRelationTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	validateTypeTypeRelation
Description	Validates a TypeTypeRelation. Depending on the value of validationType, this validation could be limited to tests on just the current TypeTypeRelation and its directly contained sub-objects or expanded to perform all tests related to this TypeTypeRelation. If an identifier is present for the TypeTypeRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the TypeTypeRelation can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	typeKey	the identifier for a type
	String	typePeerKey	the identifier for the type peer
	String	typeTypeRelationTypeKey	the identifier for the TypeTypeRelation Type
	TypeTypeRelationInfo	typeTypeRelationInfo	the TypeTypeRelation to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey, typeKey, typePeerKey, or typeTypeRelationTypeKey is not found
	InvalidParameterException		typeTypeRelationInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, typeKey, typePeerKey, typeTypeRelationTypeKey, typeTypeRelationInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	createTypeTypeRelation
Description	Creates a new TypeTypeRelation. The TypeTypeRelation Type indicates the type of relation between the two peer Types.
Parameters	String	typeTypeRelationTypeKey	the identifier for the new TypeTypeRelation
	String	ownerTypeKey	the owner of the relationship
	String	relatedTypeKey	the related type in the relationship
	TypeTypeRelationInfo	typeTypeRelationInfo	the relationship to be created
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeTypeRelationInfo		???
Errors	DoesNotExistException		typeKey, typePeerKey, or typeTypeRelationTypeKey is not found
	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		typeTypeRelationInfo or contextInfo is not valid
	MissingParameterException		typeTypeRelationId, typeKey, typePeer, typeTypeRelationTypeKey, typeTypeRelationInfo, 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

Method	updateTypeTypeRelation
Description	Updates a type Milestone Relationship. The TypeTypeRelation Id, Type, Type Keys, and Meta information may not be changed.
Parameters	String	typeTypeRelationId	the identifier for the TypeTypeRelation updated
	TypeTypeRelationInfo	typeTypeRelationInfo	the new data for the TypeTypeRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	TypeTypeRelationInfo		the updated TypeTypeRelation
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		typeTypeRelationId is not found
	InvalidParameterException		typeTypeRelationInfo or contextInfo is not valid
	MissingParameterException		typeTypeRelationId, typeTypeRelationInfo, 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
	VersionMismatchException		optimistic locking failure or the action was attempted on an out of date version

Method	deleteTypeTypeRelation
Description	Deletes an existing TypeTypeRelation.
Parameters	String	typeTypeRelationId	the identifier for the TypeTypeRelation to be deleted
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the delete operation. This must always be true.
Errors	DoesNotExistException		typeTypeRelationId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		typeTypeRelationId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred