SAP CC 1.0
API 4.2 (Core)

com.highdeal.hci
Class InvalidModificationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.highdeal.hci.OperationFailureException
              extended by com.highdeal.hci.InvalidModificationException
All Implemented Interfaces:
OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidModificationException
extends OperationFailureException

Generic exception thrown when there is an attempt to modify something in an invalid way.

See Also:
Serialized Form
XML Schema Fragment
<xs:element name="invalidModificationFault">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="offerCode" minOccurs="0" maxOccurs="unbounded">
   		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
   		</xs:complexType>
		</xs:element>
     </xs:sequence>
     <xs:attribute name="reason" type="modificationExceptionReason"/>
     <xs:attribute name="message" type="xs:string"/>
     <xs:attribute name="isOfferSubscribed" type="xs:boolean" default="false"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="modificationExceptionReason">
   <xs:restriction base="xs:string">
      <xs:enumeration value="does_not_exist"/>
      <xs:enumeration value="already_exist"/>
      <xs:enumeration value="invalid"/>
      <xs:enumeration value="still_referenced"/>
      <xs:enumeration value="cannot_initialize"/>
      <xs:enumeration value="owner_is_not_modifiable"/>
      <xs:enumeration value="unresolved_pre_rating"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary
static int ALREADY_EXIST
           
static int CANNOT_INITIALIZE
           
static int DOES_NOT_EXIST
           
static int INVALID
           
static int OWNER_IS_NOT_MODIFIABLE
           
static int STILL_REFERENCED
           
static int UNRESOLVED_PRE_RATING
           
 
Constructor Summary
InvalidModificationException()
          Constructs an empty exception.
InvalidModificationException(int reason, java.lang.String message)
          Constructs an exception with a reason and a message.
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the objects, the child represents the marshallable object to be added into the content tree.
 java.lang.String getMessage()
           
 java.util.Vector<java.lang.String> getOfferCodes()
          Returns the list of offer codes, referencing the entity to be deleted.
 int getReason()
           
 boolean isOfferSubscribed()
          Returns true in case of deletion of subscribed offer, else false.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, and of its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the tag beeing processed.
 void setMessage(java.lang.String message)
          Sets the message of the exception.
 void setOfferSubscribed(boolean isOfferSubscribed)
          Sets the offer as subscribed offer in case of offer deletion.
 void setReason(int reason)
          Sets the reason of the exception.
 
Methods inherited from class com.highdeal.hci.OperationFailureException
getOperandReference
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DOES_NOT_EXIST

public static final int DOES_NOT_EXIST
See Also:
Constant Field Values

ALREADY_EXIST

public static final int ALREADY_EXIST
See Also:
Constant Field Values

INVALID

public static final int INVALID
See Also:
Constant Field Values

CANNOT_INITIALIZE

public static final int CANNOT_INITIALIZE
See Also:
Constant Field Values

OWNER_IS_NOT_MODIFIABLE

public static final int OWNER_IS_NOT_MODIFIABLE
See Also:
Constant Field Values

UNRESOLVED_PRE_RATING

public static final int UNRESOLVED_PRE_RATING
See Also:
Constant Field Values

STILL_REFERENCED

public static final int STILL_REFERENCED
See Also:
Constant Field Values
Constructor Detail

InvalidModificationException

public InvalidModificationException()
Constructs an empty exception.


InvalidModificationException

public InvalidModificationException(int reason,
                                    java.lang.String message)
Constructs an exception with a reason and a message.

Parameters:
reason - The reason of the exception.
message - The message.
Method Detail

getReason

public int getReason()

setReason

public void setReason(int reason)
Sets the reason of the exception.

Parameters:
reason - The reason of the invalid modification.

getMessage

public java.lang.String getMessage()
Overrides:
getMessage in class java.lang.Throwable

setMessage

public void setMessage(java.lang.String message)
Sets the message of the exception.

Parameters:
message - The message for the exception.

isOfferSubscribed

public boolean isOfferSubscribed()
Returns true in case of deletion of subscribed offer, else false.

Returns:
true in case of deletion of subscribed offer.

setOfferSubscribed

public void setOfferSubscribed(boolean isOfferSubscribed)
Sets the offer as subscribed offer in case of offer deletion.

Parameters:
isOfferSubscribed - true if the offer has been subscribed, false otherwise.

getOfferCodes

public java.util.Vector<java.lang.String> getOfferCodes()
Returns the list of offer codes, referencing the entity to be deleted.

Returns:
The list of offer codes, referencing the entity to be deleted.

setAttributes

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the tag beeing processed.

Parameters:
atts - the XML attributes of the current tag.

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.

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
Description copied from interface: XMLMarshallable
Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

Parameters:
tagName - the name of tag for the child.
child - the child to be added.

marshal

public void marshal(XMLOutputter output)
Description copied from interface: XMLMarshallable
Gives an XML representation of this object, and of its children.

Parameters:
output - the XML output to marshall the object into.

SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.