Package com.highdeal.hci

Provides support for all JAVA / XML APIs.

See:
Description

Interface Summary

CrossReferenceableOp	A CrossReferenceableOp is an extention of a Message operations in HighDeal Communication Infrastructure.
CrossReferenceableResult	The root interface for marshallables that can provide a cross-reference.
MessageAuthentication	A MessageAuthentication represents the authentication data used for given authentication scheme.
MessageContext	The message context is return by a MessageSender.asyncSend(com.highdeal.hci.MessageEnvelope, com.highdeal.hci.MessageListener) operation, it is used to cancel a message or retrieve results of the message when it is terminated.
MessageListener	This listener is notified each time an operation is completed, when the current operation notifies progress and when a message is completed.
MessageOperation	A MessageOperation is the root of all operations in HighDeal Communication Infrastructure.
MessageSender	The parent interface for all message senders.
OperationResult	The root interface for all the operation results.
ReferenceHandler	A reference handler is called when a reference has been solved.
Type	Helper interface that contains a collection of constants to manage types.
XMLAttributes	This interface allows to access to attributes of an XML tag.
XMLMapping	This interface allows to define a mapping between XML tags and Java classes.
XMLMarshallable	Base interface for objects that can be marshalled and unmarshalled.
XMLOutputter	Interface to output XML document in an event-based manner.

Class Summary

AuditModel	The AuditModel implements the description of audit as seen by the client applications.
AuthenticateUserOp	This operation allows to retrieve the permission of a user and to check his/her password.
AuthenticateUserResult	The authenticate user result returns the user definition. If the advanced password management feature is enabled, this result will also contain the time left before the expiration of the password of the user.
CreateAuditOp	The create audit operation allows to create a new audit.
CreateAuditResult	A create audit result gives the code and the reference of the audit that has been created.
CreateUserOp	The create user operation allows to create a user. If the advanced password management feature is enabled, a InvalidPasswordException will be thrown if the password of the user does not comply with the security requirements.
CreateUserResult	A create user result gives the login of the user that has been created.
DeleteAuditOp	The delete audit operation allows to remove an audit.
DeleteAuditResult	The delete audit result returns the reference and the code of the deleted audit.
DeleteUserOp	The delete user operation allows to remove a user.
DeleteUserOperationFromAuditOp	The delete user operation from audit operation allows to remove one or several user's operations extracted from filters of audit applied in a time period.
DeleteUserOperationFromAuditResult	The delete user operation result returns the reference and the code of the audit and the time period from which user's operations have been removed.
DeleteUserOperationFromFiltersOp	The delete user operation from filters allows to remove one or several user's operations extracted from filters applied in a time period.
DeleteUserOperationFromFiltersResult	The delete user operation from filters result returns the filters and the time period from which user's operation have been removed.
DeleteUserResult	The delete user result returns the login of the deleted user.
FileEnvelope	This class is used for save in and load from file a set of XMLMarshallable objects.
HCIMapping	This class implements the mapping for HighDeal Communication Infrastructure classes and XML tags.
MessageBody	A message body is a set of operations or a set of operation results.
MessageEnvelope	A message envelope contains a header and a body.
MessageHeader	A MessageHeader represents the header of a message.
MessageOriginator	A MessageOriginator represents the originator of a message.
MessageSenderFactory	Defines a factory API that enables client applications using HighDeal Communication Infrastructure to obtain a message sender.
ModifyAuditOp	The modify audit operation allows to modify an audit.
ModifyAuditResult	The modify audit result returns the reference and the code of the modified audit.
ModifyPasswordOp	The modify password operation allows a user to modify his password. A InvalidPasswordException will be thrown by this operation if the advanced password management feature is enabled and if the password does not comply with the security requirements.
ModifyPasswordResult	This class represents the result of the modify password operation.
ModifyUserOp	The modify user operation allows to modify a user.
ModifyUserResult	The modify user result returns the login of the user that has been modified.
RecurringDate
ReferenceResolver	A reference resolver treats the reference to update the reference handlers that subscribed to a reference.
SearchAuditsOp	The search audits operation allows to search an audit from a given code.
SearchAuditsResult	This class represents the result of the search audits operation.
SearchUserOp	This operation allows to search for a user.
SearchUserOperationFromAuditsOp	The search user operation from audits allows to extract user's operations from user's operation filters of audit applied in a time period.
SearchUserOperationFromAuditsResult	This class represents the result of the search user's operation from audits in a time period.
SearchUserOperationFromFiltersOp	The search user operation from filters operation allows to extract user's operations from filters applied in a time period.
SearchUserOperationFromFiltersResult	This class represents the result of the search user's operation from filters in a time period.
SearchUserResult	Result of a search user operation.
ServerFailureExceptionClientSideTranslator	This class is used in an internal way to translate non business exception comming from the server into a common representation which is the ServerFailureException.
SimpleMessageAuthentication	A SimpleMessageAuthentication represents the authentication data used for the "simple" schema, that is a password.
UserModel	This class represents a user of HighDeal Communication Infrastructure.
UserOperationFilterModel	The UserOperationFilterModel implements the user operation filter as seen by the client applications.
UserOperationModel	The UserOperationModel implements the user's operation as seen by the client applications.
XMLAttributesImpl	Implementation of HCI XML attributes from a SAX 2 parser.
XMLMappingList	Class used to merge different XML mappings into one.
XMLNode	Helper class that can be used during parsing of spurious tags.
XMLOutputterWriter	Implementation of an XMLOutputter using a writer.
XMLUnmarshaller	This class supports the HCI infrastructure and should not be used directly in your code.
XMLUtils	Collection of XML utilities methods.

Enum Summary

ExportSubscriberSubsDataException.ReasonType
MessageHeader.TransactionMode

Exception Summary

AlreadyExistException	Generic exception thrown when there is an attempt to create an entity with a unique code (such as a product or a business relationship) that already exists.
AuthenticationFailedException	Exception thrown when an error occurs during the authentication of the user. Possibles reasons are: the login supplied is incorrect. the password supplied does not match the password of the user. the user is locked. the password of the user has expired. The last error is only possible if the advanced password management feature is enabled.
BadConfigurationException	Exception class when a bad configuration parameter is given to a message sender factory.
BadMessageFormatException	Exception thrown when a message with a bad format is received.
CannotCancelException	Exception thrown when a message cannot be canceled.
CommunicationFailureException	Exception thrown when the communication between the client and the server fails.
DoesNotExistException	Generic exception thrown when there is an attempt to access something with a unique code (such as a product or a business relationship) that does not exist.
ExportSubscriberSubsDataException	Generic exception thrown when there is an attempt to export subscription data of a subscriber which is not valid.
IgnorableTagException	Exception thrown when a tag can be safely ignored in a mapping.
IncompatibleOperationException	Generic exception thrown when the operation is invalid in the context.
InvalidBuildEZTaxLogException	Exception thrown when the EZTax Log Builder fails.
InvalidCreationException	Generic exception thrown when there is an attempt to create something which is not valid.
InvalidDeletionException	Generic exception thrown when there is an attempt to delete something which can not be deleted.
InvalidExportException	Generic exception thrown when there is an attempt to export something which is not valid.
InvalidImportException	Generic exception thrown when there is an attempt to import something which is not valid.
InvalidModificationException	Generic exception thrown when there is an attempt to modify something in an invalid way.
InvalidPasswordException	Exception thrown when an error occurs during the modification of the password of a user. Possibles reasons are: the password is empty. the password contains the login of the user. the password is too short. the password does not contain all the required types of characters. the password has already been changed recently. the password has already been used recently. This exception will only be thrown if the advanced password management feature is enabled.
NotAuthorizedException	Generic exception thrown when the user is not allowed to perform this action for one of this following reason : operationNotAllowed : the user is not allowed to call this operation according to his role.
OperationCanceledException	This exception is thrown when the operation has been canceled by the user.
OperationFailureException	The root exception for all operations.
RetryableDatabaseException	Database exception thrown when a sql request returns an error like a deadlock or another that is retryable.
ServerFailureException	Exception thrown when a non business exception occurs into the Transactive server.
UnknownTagException	Exception thrown when a tag has no mapping.
XMLIllegalArgumentException	This class supports the HCI infrastructure and should not be used directly in your code.

Package com.highdeal.hci Description

Provides support for all JAVA / XML APIs.