com.highdeal.pnr.hci

Class InvalidSubscriberDataImportErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.hci.OperationFailureErrorException

com.highdeal.pnr.hci.InvalidSubscriberDataImportErrorException

All Implemented Interfaces:

IErrorException, IXMLMarshallable, OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidSubscriberDataImportErrorException
extends OperationFailureErrorException

Generic exception thrown when there is an attempt to import something which is not valid.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidSubscriberDataImportFault">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="cause" minOccurs="1" maxOccurs="1"/>
       <xs:element ref="causedBy" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="category" type="InvalidSubscriberDataImportCategoryType" use="required"/>
     <xs:attribute name="id" type="xs:string" use="optional"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="InvalidSubscriberDataImportCategoryType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="invalid"/>
      <xs:enumeration value="doesNotExist"/>
   </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory This enumeration represents the categories of errors which can occur when importing subscriber data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The name of the exception.

Fields inherited from class com.highdeal.hci.OperationFailureErrorException

CAUSE_TAG_NAME, CAUSED_BY_TAG_NAME, MESSAGE_TAG_NAME

Constructor Summary

Constructors

Constructor and Description
InvalidSubscriberDataImportErrorException() Builds an empty InvalidSubscriberDataImportErrorException.
InvalidSubscriberDataImportErrorException(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category, IError error) Builds an InvalidSubscriberDataImportErrorException with a category and an error.
InvalidSubscriberDataImportErrorException(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category, java.lang.String id, IError error) Builds an InvalidSubscriberDataImportErrorException with a category, an object identifier and an error.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory	getCategory() Gets the category of the exception.
java.lang.String	getId() Gets the identifier of the object which cannot be imported.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCategory(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category) Sets the category of the exception.
void	setId(java.lang.String id) Sets the identifier of the object which cannot be imported.

Methods inherited from class com.highdeal.hci.OperationFailureErrorException

addChild, getError, getMessage, marshal, marshalChildren, marshalIError, setError, unmarshalIError

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The name of the exception.

See Also:

Constant Field Values

Constructor Detail

InvalidSubscriberDataImportErrorException

public InvalidSubscriberDataImportErrorException()

Builds an empty InvalidSubscriberDataImportErrorException.

InvalidSubscriberDataImportErrorException

public InvalidSubscriberDataImportErrorException(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category,
                                                 java.lang.String id,
                                                 IError error)

Builds an InvalidSubscriberDataImportErrorException with a category, an object identifier and an error.

Parameters:

category - the category of the exception

id - the identifier of the object to import

error - the error associated to the exception

InvalidSubscriberDataImportErrorException

public InvalidSubscriberDataImportErrorException(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category,
                                                 IError error)

Builds an InvalidSubscriberDataImportErrorException with a category and an error.

Parameters:

category - the category of the exception

error - the error associated to the exception

Method Detail

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

getTagName

public java.lang.String getTagName()

Description copied from class: OperationFailureErrorException

Gets the XML tag name of the HCI model.

Specified by:

getTagName in class OperationFailureErrorException

Returns:

The XML tag name

getCategory

public InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory getCategory()

Gets the category of the exception.

Returns:

the category of the exception

setCategory

public void setCategory(InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory category)

Sets the category of the exception.

Parameters:

category - the category of the exception

getId

public java.lang.String getId()

Gets the identifier of the object which cannot be imported.

Returns:

the identifier of the object which cannot be imported

setId

public void setId(java.lang.String id)

Sets the identifier of the object which cannot be imported.

Parameters:

id - the identifier of the object which cannot be imported