com.highdeal.filter.hci

Class InvalidSearchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.filter.hci.InvalidSearchException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidSearchException
extends OperationFailureException

Exception thrown when an invalid search exception occurred in the SAP CC system.

Reasons

• Invalid name
• Invalid constraint
• Invalid constraint type
• Invalid type for constraint
• No additional information
• No counter
• Database failure
• Invalid specific formula
• Malformed model
• Unexpected filter
• Unexpected formula
• Mandatory formula
• Forbidden formula

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidSearchFault">
   <xs:complexType>
     <xs:attribute name="reason" type="InvalidSearchReasonType"/>
     <xs:attribute name="attribute" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="InvalidSearchReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalidName"/>
     <xs:enumeration value="invalidConstraint"/>
     <xs:enumeration value="invalidConstraintType"/>
     <xs:enumeration value="invalidTypeForConstraint"/>
     <xs:enumeration value="noAdditionalInfo"/>
     <xs:enumeration value="noCounter"/>
     <xs:enumeration value="databaseFailure"/>
     <xs:enumeration value="invalidSpecificFormula"/>
     <xs:enumeration value="malformedModel"/>
     <xs:enumeration value="unexpectedFilter"/>
     <xs:enumeration value="unexpectedFormula"/>
     <xs:enumeration value="mandatoryFormula"/>
     <xs:enumeration value="forbiddenFormula"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABASE_FAILURE 5: Database failure exception.
static int	FORBIDDEN_FORMULA 12: The specific formula is forbidden for this search operation API.
static int	INTERNAL_ERROR -1: Other internal reasons.
static int	INVALID_CONSTRAINT 1: The search attribute description constraint is invalid.
static int	INVALID_NAME 0: The search attribute description name is invalid.
static int	INVALID_SPECIFIC_FORMULA 6: Invalid specific formula.
static int	INVALID_TYPE 2: Invalid type for search criteria.
static int	INVALID_TYPE_FOR_CONSTRAINT 3: The type for the attribute description constraint is not valid.
static int	MALFORMED_MODEL 8: Malformed filter model.
static int	MANDATORY_FORMULA 11: The specific formula is mandatory for this search operation API.
static int	SCOPE_HAS_NO_ADDITIONAL_INFO 4: The scope has no additional info to search in.
static int	SCOPE_HAS_NO_COUNTER 7: The scope has no counter to search in.
static int	UNEXPECTED_FILTER 9: Unexpected filter for the used search operation API.
static int	UNEXPECTED_FORMULA 10: Unexpected specific formula for this search operation API.

Constructor Summary

Constructors

Constructor and Description
InvalidSearchException() Builds an InvalidSearchException.
InvalidSearchException(int reason) Builds an InvalidSearchException.
InvalidSearchException(int reason, java.lang.String attribute) Builds an InvalidSearchException.
InvalidSearchException(int reason, java.lang.String attribute, java.lang.Exception exc) Builds an InvalidSearchException.

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.lang.String	getAttribute() Returns the faulty attribute description name.
java.lang.String	getMessage() Gets the message.
int	getReason() Returns the reason of the exception.
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.
java.lang.String	toString() Returns the reason of the exception in readable format.

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

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_NAME

public static final int INVALID_NAME

0: The search attribute description name is invalid.

See Also:

Constant Field Values

INVALID_CONSTRAINT

public static final int INVALID_CONSTRAINT

1: The search attribute description constraint is invalid.

See Also:

Constant Field Values

INVALID_TYPE

public static final int INVALID_TYPE

2: Invalid type for search criteria.

See Also:

Constant Field Values

INVALID_TYPE_FOR_CONSTRAINT

public static final int INVALID_TYPE_FOR_CONSTRAINT

3: The type for the attribute description constraint is not valid.

See Also:

Constant Field Values

SCOPE_HAS_NO_ADDITIONAL_INFO

public static final int SCOPE_HAS_NO_ADDITIONAL_INFO

4: The scope has no additional info to search in.

See Also:

Constant Field Values

DATABASE_FAILURE

public static final int DATABASE_FAILURE

5: Database failure exception.

See Also:

Constant Field Values

INVALID_SPECIFIC_FORMULA

public static final int INVALID_SPECIFIC_FORMULA

6: Invalid specific formula.

See Also:

Constant Field Values

SCOPE_HAS_NO_COUNTER

public static final int SCOPE_HAS_NO_COUNTER

7: The scope has no counter to search in.

See Also:

Constant Field Values

MALFORMED_MODEL

public static final int MALFORMED_MODEL

8: Malformed filter model.

See Also:

Constant Field Values

UNEXPECTED_FILTER

public static final int UNEXPECTED_FILTER

9: Unexpected filter for the used search operation API.

See Also:

Constant Field Values

UNEXPECTED_FORMULA

public static final int UNEXPECTED_FORMULA

10: Unexpected specific formula for this search operation API.

See Also:

Constant Field Values

MANDATORY_FORMULA

public static final int MANDATORY_FORMULA

11: The specific formula is mandatory for this search operation API.

See Also:

Constant Field Values

FORBIDDEN_FORMULA

public static final int FORBIDDEN_FORMULA

12: The specific formula is forbidden for this search operation API.

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

-1: Other internal reasons.

See Also:

Constant Field Values

Constructor Detail

InvalidSearchException

public InvalidSearchException()

Builds an InvalidSearchException.

InvalidSearchException

public InvalidSearchException(int reason)

Builds an InvalidSearchException.

Parameters:

reason - The reason of the exception

InvalidSearchException

public InvalidSearchException(int reason,
                              java.lang.String attribute)

Builds an InvalidSearchException.

Parameters:

reason - The reason of the exception

attribute - The attribute of the bad search

InvalidSearchException

public InvalidSearchException(int reason,
                              java.lang.String attribute,
                              java.lang.Exception exc)

Builds an InvalidSearchException.

Parameters:

reason - The reason of the exception

attribute - The attribute of the bad search

Method Detail

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

getReason

public int getReason()

Returns the reason of the exception.

Returns:

The reason of the exception

getAttribute

public java.lang.String getAttribute()

Returns the faulty attribute description name.

Returns:

The name of the faulty attribute description name

toString

public java.lang.String toString()

Returns the reason of the exception in readable format.

Overrides:

toString in class java.lang.Throwable

Returns:

A string describing the reason of the exception

getMessage

public java.lang.String getMessage()

Gets the message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message