com.collabnet.tracker.ws.handler
Class GetArtifactListHandler

java.lang.Object
  extended by com.collabnet.tracker.ws.handler.GetArtifactListHandler
All Implemented Interfaces:
DocumentHandler
public class GetArtifactListHandler
extends java.lang.Object
implements DocumentHandler

Handles getArtifactList requests. The format of the request document is: 

     <getArtifactList xmlns="urn:ws.tracker.collabnet.com">
         [query]
     </getArtifactList>
The response is of the type 
    <artifactList xmlns="urn:ws.tracker.collabnet.com">

For the XML [query], see QueryXMLHelper

For the XML format of the response, see ArtifactListXMLHelper.

The getArtifactList operation executes the query and returns the first n records. If the query results in more than n records then the getNextPage request can be used to retrieve them. (See GetNextPageHandler.)

The operation returns full artifact records. So the only thing that's worth specifying as part of the query xml is the sort order of artifacts.

Author:
sszego

Constructor Summary
GetArtifactListHandler()
           
 
Method Summary
 DocumentType[] getHandledDocumentTypes()
          Returns the {urn:ws.tracker.collabnet.com}getArtifactList document type.
 java.util.List getSchemaReferences(Callcontext context, XMLRequest request)
          Returns the schemas used by this handler.
 void handle(Callcontext context, XMLRequest request, XMLResponse response)
          Handles a {urn:ws.tracker.collabnet.com}getArtifactList request.
 void produceSchema(Callcontext context, XMLRequest request, SchemaVisitor visitor)
          Produces schema for <getArtifactList> and <artifactList> documents.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetArtifactListHandler

public GetArtifactListHandler()
Method Detail

handle

public void handle(Callcontext context,
                   XMLRequest request,
                   XMLResponse response)
            throws java.lang.Exception
Handles a {urn:ws.tracker.collabnet.com}getArtifactList request.

Specified by:
handle in interface DocumentHandler
Throws:
java.lang.Exception
See Also:
DocumentHandler.handle(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest, com.collabnet.core.ws.dispatcher.XMLResponse)

getSchemaReferences

public java.util.List getSchemaReferences(Callcontext context,
                                          XMLRequest request)
                                   throws SchemaReferenceException
Returns the schemas used by this handler.

Specified by:
getSchemaReferences in interface DocumentHandler
Throws:
SchemaReferenceException
See Also:
DocumentHandler.getSchemaReferences(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest)

getHandledDocumentTypes

public DocumentType[] getHandledDocumentTypes()
Returns the {urn:ws.tracker.collabnet.com}getArtifactList document type.

Specified by:
getHandledDocumentTypes in interface DocumentHandler
See Also:
DocumentHandler.getHandledDocumentTypes()

produceSchema

public void produceSchema(Callcontext context,
                          XMLRequest request,
                          SchemaVisitor visitor)
                   throws SchemaGenerationException
Produces schema for <getArtifactList> and <artifactList> documents.

Specified by:
produceSchema in interface DocumentHandler
Throws:
SchemaGenerationException
See Also:
DocumentHandler.produceSchema(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest, com.collabnet.core.xml.SchemaVisitor)