fr.gouv.culture.oai
Interface OAIRequest

All Superinterfaces:
org.xml.sax.ContentHandler, org.apache.avalon.framework.context.Contextualizable, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.LogEnabled, OAIObject, org.apache.excalibur.xml.sax.XMLConsumer, org.apache.cocoon.xml.XMLConsumer, org.apache.excalibur.xml.sax.XMLizable, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer
All Known Implementing Classes:
OAIRequestImpl

public interface OAIRequest
extends OAIObject

Defines the essentials of an oai request


Nested Class Summary
 
Nested classes inherited from class fr.gouv.culture.oai.OAIObject
OAIObject.Node
 
Field Summary
static java.lang.String PARAM_NAME_GRANULARITY
           
static java.lang.String PARAM_NAME_USE_OAI_LAST_HARVEST_DATE
           
static java.lang.String URL_CHARACTER_AMPERSAND
           
static java.lang.String URL_CHARACTER_EQUALS
           
static java.lang.String URL_CHARACTER_QUESTION_MARK
           
static java.lang.String URL_PARAM_NAME_FROM
           
static java.lang.String URL_PARAM_NAME_IDENTIFIER
           
static java.lang.String URL_PARAM_NAME_METADATA_PREFIX
           
static java.lang.String URL_PARAM_NAME_RESUMPTION_TOKEN
           
static java.lang.String URL_PARAM_NAME_SET
           
static java.lang.String URL_PARAM_NAME_UNTIL
           
static java.lang.String URL_PARAM_NAME_VERB
           
static int VERB_GET_RECORD
           
static int VERB_IDENTIFY
           
static int VERB_LIST_IDENTIFIERS
           
static int VERB_LIST_METADATA_FORMATS
           
static int VERB_LIST_RECORDS
           
static int VERB_LIST_SETS
           
static java.lang.String VERB_STRING_GET_RECORD
           
static java.lang.String VERB_STRING_IDENTIFY
           
static java.lang.String VERB_STRING_LIST_IDENTIFIERS
           
static java.lang.String VERB_STRING_LIST_METADATA_FORMATS
           
static java.lang.String VERB_STRING_LIST_RECORDS
           
static java.lang.String VERB_STRING_LIST_SETS
           
static int VERB_UNKNOWN
           
static java.lang.String verbId
           
 
Fields inherited from interface fr.gouv.culture.oai.OAIObject
HTTP_HEADER_NAME_FROM, HTTP_HEADER_NAME_USER_AGENT, NUMBER_RECORDS_PER_RESPONSE, STRING_DATEFORMAT_GRANULARITY_DAY, STRING_DATEFORMAT_GRANULARITY_SECOND
 
Method Summary
 java.lang.String getFrom()
          Gets the parameter of the request
 java.lang.String getGranularity()
          Gets the parameter of the request
 java.lang.String getIdentifier()
          Gets the parameter of the request
 java.lang.String getMetadataPrefix()
          Gets the parameter of the request
 java.lang.String getRepositoryURL()
          Gets the repository url of this request
 org.apache.cocoon.environment.Request getRequest()
          Gets the request
 java.lang.String getRequestURL()
          Gets the url of this request
 java.lang.String getResumptionToken()
          Sets the parameters of the request
 java.lang.String getSetIdentifier()
          Gets the parameter of the request
 java.lang.String getUntil()
          Gets the parameter of the request
 boolean getUseLastHarvestDate()
          Gets the parameter of the request
 int getVerb()
          Gets the verb int value
 java.lang.String getVerbId()
          Gets the verb int value
 java.lang.String getVerbString()
          Returns the the verb name
 void setFrom(java.lang.String fromDate)
          Sets the parameter of the request
 void setGranularity(java.lang.String granularity)
          Sets the parameter of the request
 void setIdentifier(java.lang.String identifier)
          Sets the parameter of the request
 void setMetadataPrefix(java.lang.String metadataPrefix)
          Sets the parameter of the request
 void setRepositoryURL(java.lang.String url)
          Sets the repository url of this request
 void setRequest(org.apache.cocoon.environment.Request coocoonRequest)
          Sets the request
 void setRequestURL(java.lang.String url)
          Sets the url of this request
 void setResumptionToken(java.lang.String resumptionToken)
          Sets the parameter of the request
 void setSetIdentifier(java.lang.String setIdentifier)
          Sets the parameter of the request
 void setUntil(java.lang.String untilDate)
          Sets the parameter of the request
 void setUseLastHarvestDate(boolean useLastHarvestDate)
          Sets the parameter of the request
 void setVerb(int verb)
          Sets the verb int value
 void setVerbId(java.lang.String verbId)
          Sets the verb int value
 void setVerbString(java.lang.String verbString)
          Set's the the verb name
 void toSAX(org.xml.sax.ContentHandler handler, boolean sendRequestParams)
          Sends the appropriate SAX event reprensentation of the request for an oai response to the provide handler
 
Methods inherited from interface org.apache.avalon.framework.logger.LogEnabled
enableLogging
 
Methods inherited from interface org.apache.avalon.framework.context.Contextualizable
contextualize
 
Methods inherited from interface org.apache.excalibur.xml.sax.XMLizable
toSAX
 
Methods inherited from interface org.xml.sax.ContentHandler
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping
 
Methods inherited from interface org.xml.sax.ext.LexicalHandler
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity
 
Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer
 

Field Detail

VERB_UNKNOWN

public static final int VERB_UNKNOWN
See Also:
Constant Field Values

VERB_IDENTIFY

public static final int VERB_IDENTIFY
See Also:
Constant Field Values

VERB_STRING_IDENTIFY

public static final java.lang.String VERB_STRING_IDENTIFY
See Also:
Constant Field Values

VERB_LIST_SETS

public static final int VERB_LIST_SETS
See Also:
Constant Field Values

VERB_STRING_LIST_SETS

public static final java.lang.String VERB_STRING_LIST_SETS
See Also:
Constant Field Values

VERB_LIST_METADATA_FORMATS

public static final int VERB_LIST_METADATA_FORMATS
See Also:
Constant Field Values

VERB_STRING_LIST_METADATA_FORMATS

public static final java.lang.String VERB_STRING_LIST_METADATA_FORMATS
See Also:
Constant Field Values

VERB_LIST_IDENTIFIERS

public static final int VERB_LIST_IDENTIFIERS
See Also:
Constant Field Values

VERB_STRING_LIST_IDENTIFIERS

public static final java.lang.String VERB_STRING_LIST_IDENTIFIERS
See Also:
Constant Field Values

VERB_LIST_RECORDS

public static final int VERB_LIST_RECORDS
See Also:
Constant Field Values

VERB_STRING_LIST_RECORDS

public static final java.lang.String VERB_STRING_LIST_RECORDS
See Also:
Constant Field Values

VERB_GET_RECORD

public static final int VERB_GET_RECORD
See Also:
Constant Field Values

VERB_STRING_GET_RECORD

public static final java.lang.String VERB_STRING_GET_RECORD
See Also:
Constant Field Values

verbId

public static final java.lang.String verbId

PARAM_NAME_USE_OAI_LAST_HARVEST_DATE

public static final java.lang.String PARAM_NAME_USE_OAI_LAST_HARVEST_DATE
See Also:
Constant Field Values

PARAM_NAME_GRANULARITY

public static final java.lang.String PARAM_NAME_GRANULARITY
See Also:
Constant Field Values

URL_CHARACTER_QUESTION_MARK

public static final java.lang.String URL_CHARACTER_QUESTION_MARK
See Also:
Constant Field Values

URL_CHARACTER_AMPERSAND

public static final java.lang.String URL_CHARACTER_AMPERSAND
See Also:
Constant Field Values

URL_CHARACTER_EQUALS

public static final java.lang.String URL_CHARACTER_EQUALS
See Also:
Constant Field Values

URL_PARAM_NAME_VERB

public static final java.lang.String URL_PARAM_NAME_VERB
See Also:
Constant Field Values

URL_PARAM_NAME_IDENTIFIER

public static final java.lang.String URL_PARAM_NAME_IDENTIFIER
See Also:
Constant Field Values

URL_PARAM_NAME_FROM

public static final java.lang.String URL_PARAM_NAME_FROM
See Also:
Constant Field Values

URL_PARAM_NAME_UNTIL

public static final java.lang.String URL_PARAM_NAME_UNTIL
See Also:
Constant Field Values

URL_PARAM_NAME_SET

public static final java.lang.String URL_PARAM_NAME_SET
See Also:
Constant Field Values

URL_PARAM_NAME_METADATA_PREFIX

public static final java.lang.String URL_PARAM_NAME_METADATA_PREFIX
See Also:
Constant Field Values

URL_PARAM_NAME_RESUMPTION_TOKEN

public static final java.lang.String URL_PARAM_NAME_RESUMPTION_TOKEN
See Also:
Constant Field Values
Method Detail

setRepositoryURL

public void setRepositoryURL(java.lang.String url)
Sets the repository url of this request


getRepositoryURL

public java.lang.String getRepositoryURL()
Gets the repository url of this request


setRequestURL

public void setRequestURL(java.lang.String url)
Sets the url of this request


getRequestURL

public java.lang.String getRequestURL()
Gets the url of this request


setRequest

public void setRequest(org.apache.cocoon.environment.Request coocoonRequest)
Sets the request


getRequest

public org.apache.cocoon.environment.Request getRequest()
Gets the request


setVerb

public void setVerb(int verb)
Sets the verb int value


getVerb

public int getVerb()
Gets the verb int value


setVerbId

public void setVerbId(java.lang.String verbId)
Sets the verb int value


getVerbId

public java.lang.String getVerbId()
Gets the verb int value


getIdentifier

public java.lang.String getIdentifier()
Gets the parameter of the request


setIdentifier

public void setIdentifier(java.lang.String identifier)
Sets the parameter of the request


getMetadataPrefix

public java.lang.String getMetadataPrefix()
Gets the parameter of the request


setMetadataPrefix

public void setMetadataPrefix(java.lang.String metadataPrefix)
Sets the parameter of the request


getUseLastHarvestDate

public boolean getUseLastHarvestDate()
Gets the parameter of the request


setUseLastHarvestDate

public void setUseLastHarvestDate(boolean useLastHarvestDate)
Sets the parameter of the request


getGranularity

public java.lang.String getGranularity()
Gets the parameter of the request


setGranularity

public void setGranularity(java.lang.String granularity)
Sets the parameter of the request


getFrom

public java.lang.String getFrom()
Gets the parameter of the request


setFrom

public void setFrom(java.lang.String fromDate)
Sets the parameter of the request


getUntil

public java.lang.String getUntil()
Gets the parameter of the request


setUntil

public void setUntil(java.lang.String untilDate)
Sets the parameter of the request


getSetIdentifier

public java.lang.String getSetIdentifier()
Gets the parameter of the request


setSetIdentifier

public void setSetIdentifier(java.lang.String setIdentifier)
Sets the parameter of the request


getResumptionToken

public java.lang.String getResumptionToken()
Sets the parameters of the request


setResumptionToken

public void setResumptionToken(java.lang.String resumptionToken)
Sets the parameter of the request


getVerbString

public java.lang.String getVerbString()
Returns the the verb name


setVerbString

public void setVerbString(java.lang.String verbString)
Set's the the verb name


toSAX

public void toSAX(org.xml.sax.ContentHandler handler,
                  boolean sendRequestParams)
           throws org.xml.sax.SAXException
Sends the appropriate SAX event reprensentation of the request for an oai response to the provide handler

Parameters:
handler - The handler to feed
sendRequestParams - Whether or not the request params should be sent as attributes (according to error state)
Throws:
org.xml.sax.SAXException


Copyright © 2000-2003 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.