com.highdeal.filter.hci

Class SearchResult

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.filter.hci.SearchResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

Direct Known Subclasses:

SearchAccessFromSubscriptionResult, SearchAccessResult, SearchAllBatchRatingGroupsResult, SearchMappingTableClassResult, SearchMappingTableResult, SearchRangeTableClassResult, SearchRangeTableResult, SearchSubscriberAccountResult, SearchSubscriberMappingTableResult, SearchSubscriberRangeTableResult, SearchSubscriptionFromAccessResult, SearchSubscriptionResult, SearchTierTableResult, SearchTranslationTableResult, SearchUserOperationResult

public abstract class SearchResult
extends HCIModelAdapter
implements OperationResult

This abstract Java class is a generic class for the results returned by all the search operations provided by the SAP CC system.

Note

Consider the direct known subclasses to have the list of the search operations that are available.

Implementation in Your Client Application

When developing your client application, use:

• getResult for obtaining the search result
• getResultType for obtaining the result type

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="SearchResult">
      <xs:sequence>
        <xs:any namespace="##targetNamespace" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
  <xs:attribute name="totalCount" type="xs:integer"/>
  <xs:attribute name="last" type="xs:string"/> <!-- The last element of the buffer -->
  <xs:attribute name="resultType" type="ResultTypeType"/>
  </xs:complexType>

  <xs:element name="itemID">
     <xs:complexType>
       <xs:attribute name="id" type="xs:string" use="required" />
     </xs:complexType>
  </xs:element>

<xs:simpleType name="ResultTypeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="ids"/> <!-- IDs of requested objects are returned -->
     <xs:enumeration value="attributes"/> <!-- Object attributes are returned -->
     <xs:enumeration value="objects"/><!-- Objects are returned -->
   </xs:restriction>
 </xs:simpleType>

Constructor Summary

Constructors

Constructor and Description
SearchResult(java.lang.String searchTagName) Builds an empty SearchResult object.

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	getLastID() Gets the last ID of the element list.
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	getResult() Gets the result according to the result type option (OBJECT_RESULT_TYPE or ATTRIBUTES_RESULT_TYPE).
int	getResultType() Returns the result type.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
int	getTotalCount() Gets the total count of targetted items; If this value is set to -1, it means that the total count was not required into the search operation and the current result contains all requested items.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChild(XMLMarshallable child, XMLOutputter output)
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setAttributeSetResult(java.util.Vector<AttributeSet> attributeSets) Sets the attribute sets result.
void	setIdResult(java.util.Vector<?> list) Sets the IDs result.
void	setLastID(java.lang.String id) Sets the last buffer element ID.
void	setObjectResult(java.util.Vector<XMLMarshallable> list) Sets the objects result.
void	setResultType(int val) INTERNAL USE ONLY - Sets the result type.
void	setTotalCount(int n) Sets the total count.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Constructor Detail

SearchResult

public SearchResult(java.lang.String searchTagName)

Builds an empty SearchResult object.

Method Detail

setObjectResult

public void setObjectResult(java.util.Vector<XMLMarshallable> list)

Sets the objects result.

Parameters:

list - The result objects

setIdResult

public void setIdResult(java.util.Vector<?> list)

Sets the IDs result.

Parameters:

list - The result IDs

setAttributeSetResult

public void setAttributeSetResult(java.util.Vector<AttributeSet> attributeSets)

Sets the attribute sets result.

Parameters:

attributeSets - The list of attribute sets

getResult

public java.util.Vector getResult()

Gets the result according to the result type option (OBJECT_RESULT_TYPE or ATTRIBUTES_RESULT_TYPE).

Returns:

The result list of objects or IDs

getTotalCount

public int getTotalCount()

Gets the total count of targetted items; If this value is set to -1, it means that the total count was not required into the search operation and the current result contains all requested items.

Returns:

The total count

setTotalCount

public void setTotalCount(int n)

Sets the total count.

Parameters:

n - The result number

getResultType

public int getResultType()

Returns the result type.

Returns:

The result type value (list of IDs or objects)

See Also:

SearchFilterModel.ID_RESULT_TYPE, SearchFilterModel.ATTRIBUTES_RESULT_TYPE, SearchFilterModel.OBJECT_RESULT_TYPE

setResultType

public void setResultType(int val)

INTERNAL USE ONLY - Sets the result type.

Parameters:

val - The new value of the result type

See Also:

SearchFilterModel.ID_RESULT_TYPE, SearchFilterModel.ATTRIBUTES_RESULT_TYPE, SearchFilterModel.OBJECT_RESULT_TYPE

getLastID

public java.lang.String getLastID()

Gets the last ID of the element list. This value is related to "from" value which has been set into search operation. This value can be reused if the client whishes to look for next "max" items.
If last is null it means that there is no more elements or no "max" attribute has been set into the related search operation.

Returns:

The last element unique ID of the buffer (Note : this ID is a String representation of IDs for which the type can differ - INTEGER by example -).

setLastID

public void setLastID(java.lang.String id)

Sets the last buffer element ID.

Parameters:

id - The ID of the last buffer element

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

Returns:

The operand reference of the operation result

getTagName

public java.lang.String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Specified by:

getTagName in interface ITagNameProvider

Returns:

The XML tag name

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

Specified by:

setAttributes in interface XMLMarshallable

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.

Specified by:

addCharacterData in interface XMLMarshallable

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.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Specified by:

marshalChildren in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the child objects into

marshalChild

public void marshalChild(XMLMarshallable child,
                         XMLOutputter output)