EnumerationManagementService

• getEnumerations
• getEnumeration
• getEnumeratedValues
• validateEnumeratedValue
• updateEnumeratedValue
• deleteEnumeratedValue
• addEnumeratedValue

• EnumerationInfo
• ContextInfo
• EnumeratedValueInfo
• ValidationResultInfo
• StatusInfo

Method	getEnumerations
Description	Retrieves the list of meta information for the enumerations supported by this service.
Parameters	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	EnumerationInfoList		List of enumeration meta information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getEnumeration
Description	Retrieves meta information for a particular Enumeration. The meta information should describe constraints on the various fields comprising the enumeration as well as the allowed contexts.
Parameters	String	enumerationKey	identifier for the Enumeration
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	EnumerationInfo		Meta information about an enumeration
Errors	DoesNotExistException		enumerationKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing enumerationKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getEnumeratedValues
Description	Retrieves the list of values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
Parameters	String	enumerationKey	identifier for the Enumeration
	String	contextTypeKey	identifier for the enumeration context type
	String	contextValue	value for the enumeration context
	Date	contextDate	date and time to get the enumeration for
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	EnumeratedValueInfoList		List of Codes and Values
Errors	DoesNotExistException		enumerationKey not found
	InvalidParameterException		invalid contextValue, contextDate or contextInfo
	MissingParameterException		missing enumerationKey, contextTypeKey, contextValue, contextDate or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateEnumeratedValue
Description	Validates an EnumerationValue. 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 Process and a record is found for that identifier, the validation checks if the Process can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	enumerationKey	identifier for the Enumeration
	String	code	code identifying the value to be validated
	EnumeratedValueInfo	enumeratedValueInfo	the Room information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey, enumerationKey or code not found
	InvalidParameterException		invalid enumeratedValueInfo or contextInfo
	MissingParameterException		missing validationTypeKey, enumerationKey, code, enumeratedValueInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateEnumeratedValue
Description	Updates a value in a particular Enumeration. The pattern in this signature is different from most updates in that it is unlikely for multiple individuals or processes to be altering the same construct at the same time.
Parameters	String	enumerationKey	identifier for the Enumeration
	String	code	code identifying the value to be updated
	EnumeratedValueInfo	enumeratedValueInfo	updated information on the value
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	EnumeratedValueInfo		updated enumerated value
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		enumerationKey, code not found
	InvalidParameterException		invalid enumeratedValueInfo or contextInfo
	MissingParameterException		missing enumerationKey, code, enumeratedValueInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	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

Back to Operations

Method	deleteEnumeratedValue
Description	Removes a value from a particular Enumeration. This particular operation should be used sparingly, as removal of a value may lead to dangling references. It is suggested that standard procedure should be to update the expiration date for the value so that it is seen as expired.
Parameters	String	enumerationKey	Identifier for the Enumeration
	String	code	code identifying the value to be removed
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		Status of the operation (success, failed)
Errors	DoesNotExistException		enumerationKey, code not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing enumerationKey, code or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	addEnumeratedValue
Description	Adds a value to a particular Enumeration.
Parameters	String	enumerationKey	Identifier for the Enumeration
	String	code	code identifying the value to be added
	EnumeratedValueInfo	enumeratedValueInfo	Value to be added
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	EnumeratedValueInfo		Newly created enumerated value
Errors	AlreadyExistsException		combination of enumerationKey, code already exists
	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		enumerationKey not found
	InvalidParameterException		invalid enumeratedValueInfo or contextInfo
	MissingParameterException		missing enumerationKey, enumeratedValueInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at changing information designated as read only

Back to Operations