Package 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,Serializable
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:
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 ClassesModifier and TypeClassDescriptionstatic enumThisenumerationlists the types of an object that is still referenced in the SAP CC system. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int0: constant for an unknown objectstatic final int1: constant for an object that is still referencedstatic final int2: constant for unresolved prerating; Prerating is deprecated since version 2.0 of SAP CC.static final int3: constant for remaining sessions -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty exception.InvalidDeletionException(int reason, String message) Constructs an exception with the reason of the exception and the specified detail message.InvalidDeletionException(int reason, String message, IError error) Constructs an exception with the reason of the exception and the specified detail message.InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, String message) Constructs an exception with aSTILL_REFERENCEDreason, an object type, and a message.InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, String message, IError error) Constructs an exception with aSTILL_REFERENCEDreason, an object type, and a message. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds character data to the content element.voidaddChild(String tagName, XMLMarshallable child) Adds a child to the object, thechildrepresenting the marshallable object which must be added to the element.Returns the list of allowance logic codes, referencing the entity to be deleted.Returns the list of allowance plan codes, referencing the entity to be deleted.Returns the list of charge component codes, referencing the entity to be deleted.Returns the list of Charged Item Aggregation Policy codes, referencing the entity to be deleted.Returns the list of charge plan codes, referencing the entity to be deleted.Returns the list of exportable item mapping codes, referencing the entity to be deleted.Returns the message of the exception.Returns the object type that is still referenced.Returns the list of offer codes, referencing the entity to be deleted.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 isnull.Returns the list of pricing macro codes, referencing the entity to be deleted.intReturns the reason of the exception.Returns the list of refill logic codes, referencing the entity to be deleted.Returns the list of refill plan codes, referencing the entity to be deleted.Returns the list of user logins, referencing the entity to be deleted.booleanReturnstruein case of deletion of subscribed offer, elsefalse.voidmarshal(XMLOutputter output) Gives an XML representation of this object, including its children.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidvoidsetMessage(String message) Sets the message of the exception.voidsetOfferSubscribed(boolean isOfferSubscribed) Sets the offer as subscribed offer in case of offer deletion.voidsetReason(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
-
Field Details
-
DOES_NOT_EXIST
public static final int DOES_NOT_EXIST0: constant for an unknown object- See Also:
-
STILL_REFERENCED
public static final int STILL_REFERENCED1: constant for an object that is still referenced- See Also:
-
UNRESOLVED_PRE_RATING
public static final int UNRESOLVED_PRE_RATING2: constant for unresolved prerating; Prerating is deprecated since version 2.0 of SAP CC.- See Also:
-
UNSTOPPED_PENDING_SESSION
public static final int UNSTOPPED_PENDING_SESSION3: constant for remaining sessions- See Also:
-
-
Constructor Details
-
InvalidDeletionException
public InvalidDeletionException()Constructs an empty exception. -
InvalidDeletionException
Constructs an exception with the reason of the exception and the specified detail message.- Parameters:
reason- The reason of the exceptionmessage- The detail message
-
InvalidDeletionException
Constructs an exception with the reason of the exception and the specified detail message.- Parameters:
reason- The reason of the exceptionmessage- The detail messageerror- Theerrorassociated to this exception
-
InvalidDeletionException
public InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, String message) Constructs an exception with aSTILL_REFERENCEDreason, an object type, and a message.- Parameters:
message- The detail messageobjectTypeStillReferenced- The type of object that is still referenced
-
InvalidDeletionException
public InvalidDeletionException(InvalidDeletionException.ObjectTypeStillReferenced objectTypeStillReferenced, String message, IError error) Constructs an exception with aSTILL_REFERENCEDreason, an object type, and a message.- Parameters:
message- The detail messageobjectTypeStillReferenced- The type of object that is still referenced
-
-
Method Details
-
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
Returns the message of the exception.- Overrides:
getMessagein classThrowable- Returns:
- The message of the exception
-
setMessage
Sets the message of the exception.- Parameters:
message- The message of the exception
-
getIError
- Returns:
- The error contained in this exception
-
setError
- Parameters:
error- The error contained in this exception
-
isOfferSubscribed
public boolean isOfferSubscribed()Returnstruein case of deletion of subscribed offer, elsefalse.- Returns:
truein 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-truein case of deletion of subscribed offer
-
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
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
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
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
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
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
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
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
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
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
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
Returns the object type that is still referenced.- Returns:
- The still referenced object type
-
setAttributes
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- Parameters:
atts- TheXML attributesof the current element
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Parameters:
cData- The character data to be added
-
addChild
Description copied from interface:XMLMarshallableAdds a child to the object, thechildrepresenting the marshallable object which must be added to the element.- Parameters:
tagName- The name of tag for the childchild- The child to be added
-
marshal
Description copied from interface:XMLMarshallableGives an XML representation of this object, including its children.- Parameters:
output- TheXML outputto marshal the object into
-
getOperandReference
Description copied from interface:OperationResultGets 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 isnull.- Specified by:
getOperandReferencein interfaceOperationResult- Overrides:
getOperandReferencein classOperationFailureException- Returns:
- The operand reference of the operation result
-