com.highdeal.hci

Class InvalidDeletionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.hci.InvalidDeletionException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidDeletionException
extends OperationFailureException

Generic exception thrown by the SAP CC system when there is an attempt to delete something that cannot be deleted; The objects can have different types (master data, technical data, system configuration).

Note

For troubleshooting during the project implementation phase of SAP CC, see the SAP CC Error Code Reference documentation in the Core SDK or in SAP Help Portal.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidDeletionFault">
   <xs:complexType>
    <xs:sequence>
      <xs:element ref="cause" minOccurs="0" maxOccurs="1"/> <!-- Due to legacy use of this exception, no error may be provided -->
      <xs:element ref="causedBy" minOccurs="0" maxOccurs="unbounded"/>
    	<xs:element name="offerCode" minOccurs="0" maxOccurs="unbounded">
   		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
   		</xs:complexType>
		</xs:element>
    	<xs:element name="chargePlanCode" minOccurs="0" maxOccurs="unbounded">
   		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
   		</xs:complexType>
		</xs:element>
	   <xs:element name="chargeComponentCode" minOccurs="0" maxOccurs="unbounded">
         <xs:complexType>
             <xs:attribute name="code" type="xs:string"/>
         </xs:complexType>
     </xs:element>
     <xs:element name="pricingMacroCode" minOccurs="0" maxOccurs="unbounded">
     		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
     		</xs:complexType>
	   </xs:element>
     <xs:element name="refillLogicCode" minOccurs="0" maxOccurs="unbounded">
     		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
     		</xs:complexType>
	   </xs:element>
     <xs:element name="refillPlanCode" minOccurs="0" maxOccurs="unbounded">
     		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
     		</xs:complexType>
	   </xs:element>
     <xs:element name="exportableItemMappingCode" minOccurs="0" maxOccurs="unbounded">
     		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
     		</xs:complexType>
	   </xs:element>
     <xs:element name="chargedItemAggregationPolicyCode" minOccurs="0" maxOccurs="unbounded">
     		<xs:complexType>
    			<xs:attribute name="code" type="xs:string"/>
     		</xs:complexType>
	   </xs:element>
     <xs:element name="userLogin" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
              <xs:attribute name="login" type="xs:string"/>
          </xs:complexType>
     </xs:element>
     <xs:element name="allowanceLogicCode" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
              <xs:attribute name="code" type="xs:string"/>
          </xs:complexType>
     </xs:element>
     <xs:element name="allowancePlanCode" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
              <xs:attribute name="code" type="xs:string"/>
          </xs:complexType>
     </xs:element>
   </xs:sequence>
   <xs:attribute name="reason" type="deletionExceptionReason"/>
   <xs:attribute name="message" type="xs:string"/>
   <xs:attribute name="objectTypeStillReferenced" type="xs:string"/>
   <xs:attribute name="isOfferSubscribed" type="xs:boolean" default="false"/>
  </xs:complexType>
 </xs:element>

 <xs:simpleType name="deletionExceptionReason">
   <xs:restriction base="xs:string">
      <xs:enumeration value="does_not_exist"/>
      <xs:enumeration value="still_referenced"/>
      <xs:enumeration value="unresolved_pre_rating"/>
      <xs:enumeration value="unstopped_pending_sessions"/>
   </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvalidDeletionException.ObjectTypeStillReferenced This enumeration lists the types of an object that is still referenced in the SAP CC system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOES_NOT_EXIST 0: constant for an unknown object
static int	STILL_REFERENCED 1: constant for an object that is still referenced
static int	UNRESOLVED_PRE_RATING 2: constant for unresolved prerating; Prerating is deprecated since version 2.0 of SAP CC.
static int	UNSTOPPED_PENDING_SESSION 3: constant for remaining sessions

Constructor Summary

Constructors

Constructor and Description
InvalidDeletionException() Constructs an empty exception.
InvalidDeletionException(int reason, java.lang.String message) Constructs an exception with the reason of the exception and the specified detail message.
InvalidDeletionException(int reason, java.lang.String message, IError error) Constructs an exception with the reason of the exception and the specified detail message.
InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, java.lang.String message) Constructs an exception with a STILL_REFERENCED reason, an object type, and a message.
InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, java.lang.String message, IError error) Constructs an exception with a STILL_REFERENCED reason, an object type, and a message.

Method Summary

Modifier and Type	Method and Description
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 object, the child representing the marshallable object which must be added to the element.
java.util.Vector<java.lang.String>	getAllowanceLogicCodes() Returns the list of allowance logic codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getAllowancePlanCodes() Returns the list of allowance plan codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getChargeComponentCodes() Returns the list of charge component codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getChargedItemAggregationPolicyCodes() Returns the list of Charged Item Aggregation Policy codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getChargePlanCodes() Returns the list of charge plan codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getExportableItemMappingCodes() Returns the list of exportable item mapping codes, referencing the entity to be deleted.
IError	getIError() Gets the error contained in this Exception
java.lang.String	getMessage() Returns the message of the exception.
InvalidDeletionException.ObjectTypeStillReferenced	getObjectTypeStillReferenced() Returns the object type that is still referenced.
java.util.Vector<java.lang.String>	getOfferCodes() Returns the list of offer codes, referencing the entity to be deleted.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.util.Vector<java.lang.String>	getPricingMacroCodes() Returns the list of pricing macro codes, referencing the entity to be deleted.
int	getReason() Returns the reason of the exception.
java.util.Vector<java.lang.String>	getRefillLogicCodes() Returns the list of refill logic codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getRefillPlanCodes() Returns the list of refill plan codes, referencing the entity to be deleted.
java.util.Vector<java.lang.String>	getUserLogins() Returns the list of user logins, referencing the entity to be deleted.
boolean	isOfferSubscribed() Returns true in case of deletion of subscribed offer, else false.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setError(IError error) Sets the error contained in this Exception
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 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

DOES_NOT_EXIST

public static final int DOES_NOT_EXIST

0: constant for an unknown object

See Also:

Constant Field Values

STILL_REFERENCED

public static final int STILL_REFERENCED

1: constant for an object that is still referenced

See Also:

Constant Field Values

UNRESOLVED_PRE_RATING

public static final int UNRESOLVED_PRE_RATING

2: constant for unresolved prerating; Prerating is deprecated since version 2.0 of SAP CC.

See Also:

Constant Field Values

UNSTOPPED_PENDING_SESSION

public static final int UNSTOPPED_PENDING_SESSION

3: constant for remaining sessions

See Also:

Constant Field Values

Constructor Detail

InvalidDeletionException

public InvalidDeletionException()

Constructs an empty exception.

InvalidDeletionException

public InvalidDeletionException(int reason,
                                java.lang.String message)

Constructs an exception with the reason of the exception and the specified detail message.

Parameters:

reason - The reason of the exception

message - The detail message

InvalidDeletionException

public InvalidDeletionException(int reason,
                                java.lang.String message,
                                IError error)

Constructs an exception with the reason of the exception and the specified detail message.

Parameters:

reason - The reason of the exception

message - The detail message

error - The error associated to this exception

InvalidDeletionException

public InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced,
                                java.lang.String message)

Constructs an exception with a STILL_REFERENCED reason, an object type, and a message.

Parameters:

message - The detail message

objectTypeStillReferenced - The type of object that is still referenced

InvalidDeletionException

public InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced,
                                java.lang.String message,
                                IError error)

Constructs an exception with a STILL_REFERENCED reason, an object type, and a message.

Parameters:

message - The detail message

objectTypeStillReferenced - The type of object that is still referenced

Method Detail

getReason

public int getReason()

Returns the reason of the exception.

Returns:

The reason of the exception

setReason

public void setReason(int reason)

Sets the reason of the exception.

Parameters:

reason - The reason of the invalid deletion

getMessage

public java.lang.String getMessage()

Returns the message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message of the exception

setMessage

public void setMessage(java.lang.String message)

Sets the message of the exception.

Parameters:

message - The message of the exception

getIError

public IError getIError()

Gets the error contained in this Exception

Returns:

The error contained in this exception

setError

public void setError(IError error)

Sets the error contained in this Exception

Parameters:

error - The error contained in this 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 in case of deletion of subscribed offer

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

getChargePlanCodes

public java.util.Vector<java.lang.String> getChargePlanCodes()

Returns the list of charge plan codes, referencing the entity to be deleted.

Returns:

The list of charge plan codes, referencing the entity to be deleted

getChargeComponentCodes

public java.util.Vector<java.lang.String> getChargeComponentCodes()

Returns the list of charge component codes, referencing the entity to be deleted.

Returns:

The list of charge component codes, referencing the entity to be deleted

getExportableItemMappingCodes

public java.util.Vector<java.lang.String> getExportableItemMappingCodes()

Returns the list of exportable item mapping codes, referencing the entity to be deleted.

Returns:

The list of exportable item mapping codes, referencing the entity to be deleted

getRefillPlanCodes

public java.util.Vector<java.lang.String> getRefillPlanCodes()

Returns the list of refill plan codes, referencing the entity to be deleted.

Returns:

The list of refill plan codes, referencing the entity to be deleted

getRefillLogicCodes

public java.util.Vector<java.lang.String> getRefillLogicCodes()

Returns the list of refill logic codes, referencing the entity to be deleted.

Returns:

The list of refill logic codes, referencing the entity to be deleted

getAllowancePlanCodes

public java.util.Vector<java.lang.String> getAllowancePlanCodes()

Returns the list of allowance plan codes, referencing the entity to be deleted.

Returns:

The list of allowance plan codes, referencing the entity to be deleted

getAllowanceLogicCodes

public java.util.Vector<java.lang.String> getAllowanceLogicCodes()

Returns the list of allowance logic codes, referencing the entity to be deleted.

Returns:

The list of allowance logic codes, referencing the entity to be deleted

getPricingMacroCodes

public java.util.Vector<java.lang.String> getPricingMacroCodes()

Returns the list of pricing macro codes, referencing the entity to be deleted.

Returns:

The list of pricing macro codes, referencing the entity to be deleted

getChargedItemAggregationPolicyCodes

public java.util.Vector<java.lang.String> getChargedItemAggregationPolicyCodes()

Returns the list of Charged Item Aggregation Policy codes, referencing the entity to be deleted.

Returns:

The list of Charged Item Aggregation Policy codes, referencing the entity to be deleted

getUserLogins

public java.util.Vector<java.lang.String> getUserLogins()

Returns the list of user logins, referencing the entity to be deleted.

Returns:

The list of user logins, referencing the entity to be deleted

getObjectTypeStillReferenced

public InvalidDeletionException.ObjectTypeStillReferenced getObjectTypeStillReferenced()

Returns the object type that is still referenced.

Returns:

The still referenced object type

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

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

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, including its children.

Parameters:

output - The XML output to marshal the object into

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result