Differences between revisions 10 and 11

API-A (Fedora Access service API)

Anchor(describeRepository)

describeRepository

Gets information that describes the repository.

Returns:

[:/../DataStructures#RepositoryInfo: RepositoryInfo]

Throws:

java.rmi.RemoteException

Anchor(getObjectProfile)

getObjectProfile

Gets the ObjectProfile of an object, which includes key metadata fields and URLs for the object Dissemination Index and the object Item Index. Can be thought of as a default view of the object.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

ObjectProfile Contains these fields
- String pid
- String objLabel
- String[] objModels
- String objCreateDate
- String objLastModDate
- String objDissIndexViewURL
- String objItemIndexViewURL

Throws:

java.rmi.RemoteException

Anchor(getObjectHistory)

getObjectHistory

Gets a list of timestamps that correspond to modification dates of components. This currently includes changes to Datastreams and disseminators.

Input parameters:

String pid The pid of the object.

Returns:

String[] An array containing the list of timestamps indicating when changes were made to the object.

Throws:

java.rmi.RemoteException

Anchor(listDatastreams)

listDatastreams

Lists the datastreams of an object. See also [#getDatastreamDissemination getDatastreamDissemination]

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

DatastreamDef[]
- String ID
- String label
- String MIMEType

Throws:

java.rmi.RemoteException

Anchor(getDatastreamDissemination)

getDatastreamDissemination

Gets the content of a datastream. See also [#listDatastreams listDatastreams]

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String asOfDateTime A dateTime indicating the version of the datastream to retrieve. If null, Fedora will use the most recent version.

Returns:

[:/../DataStructures#MIMETypedStream: MIMETypedStream] The header will be empty, or if applicable, contain the http header as name/value pairs.

Throws:

java.rmi.RemoteException

Anchor(listMethods)

listMethods

Lists all the methods that the object supports. See also [#getDissemination getDissemination]

Each method can take a number of paramethers. Each parameter for a method has a name, and a type. The possible values of a parameter depends on its type. It can be bound to a datastream in the object, it can have a hardcoded value or it can be defined by the caller.

Each parameter is defined to be passed by reference or passed by value.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

ObjectMethodDef[]
- String PID
- String serviceDefinitionPID
- String methodName
- MethodParmDef[] methodParmDefs
  - String parmName The name of the parameter.
  - String parmType The type of the parameter. Restricted to "fedora:datastreamInputType", "fedora:userInputType" or "fedora:defaultInputType"
  - String parmDefaultValue If the parmType is default, this is the value that will be used. Null if other type.
  - String[] parmDomainValues If the parameter can be defined by the user, these are the possible values. Null if other type.
  - boolean parmRequired False, if this parameter can be left out of a call.
  - String parmLabel The label for the parameter. Can be null.
  - String parmPassBy The method of passing the paramenter. Restricted to "URL_REF" (if the parameter is pass by reference - by an url) and "VALUE" (if the parameter is pass by value)
  - String asOfDate

Throws:

java.rmi.RemoteException

Anchor(getDissemination)

getDissemination

Disseminates the content produced by executing the method specified in the service definition associated the specified digital object. See also [#listMethods listMethods]

Input parameters:

String pid The pid of the object.
String serviceDefinitionPid The PID of the Service Definition object.
String methodName The name of the method to be executed.
Property[] parameters An array of name-value pairs.
String asOfDateTime The versioning dateTime. If null, Fedora will use the most recent version.

Returns:

[:/../DataStructures#MIMETypedStream: MIMETypedStream] The header will be empty, or if applicable, contain the http header as name/value pairs.

Throws:

java.rmi.RemoteException

-  ⇤ ← Revision 10 as of 2008-10-16 16:16:25 → 
  Size: 5494
  Editor: abr
  Comment:
+   ← Revision 11 as of 2008-10-16 16:17:35 → ⇥
  Size: 5313
  Editor: abr
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 64:
- *  A sequence/array of:
  * {{{DatastreamDef}}}
   * {{{String ID}}}
   * {{{String label}}}
   * {{{String MIMEType}}}
+ * {{{DatastreamDef[]}}}
  * {{{String ID}}}
  * {{{String label}}}
  * {{{String MIMEType}}}
 Line 109:
- *  A sequence/array of [:/../DataStructures#MethodDef: MethodDef]s, one for each of the disseminators on the object
 *  A sequence/array of:
  * {{{ObjectMethodDef}}}
   * {{{String PID}}}
   * {{{String serviceDefinitionPID}}}
   * {{{String methodName}}}
   * {{{MethodParmDef[] methodParmDefs}}}
    * {{{String parmName}}} The name of the parameter.
    * {{{String parmType}}} The type of the parameter. Restricted to "fedora:datastreamInputType", "fedora:userInputType" or "fedora:defaultInputType"
    * {{{String parmDefaultValue}}} If the parmType is default, this is the value that will be used. Null if other type.
    * {{{String[] parmDomainValues}}} If the parameter can be defined by the user, these are the possible values. Null if other type.
    * {{{boolean parmRequired}}} False, if this parameter can be left out of a call.
    * {{{String parmLabel}}} The label for the parameter. Can be null.
    * {{{String parmPassBy}}} The method of passing the paramenter. Restricted to "URL_REF" (if the parameter is pass by reference - by an url) and "VALUE" (if the parameter is pass by value)
    * {{{String asOfDate}}}
-Line 125:
+Line 110:
+ * {{{ObjectMethodDef[]}}}
  * {{{String PID}}}
  * {{{String serviceDefinitionPID}}}
  * {{{String methodName}}}
  * {{{MethodParmDef[] methodParmDefs}}}
   * {{{String parmName}}} The name of the parameter.
   * {{{String parmType}}} The type of the parameter. Restricted to "fedora:datastreamInputType", "fedora:userInputType" or "fedora:defaultInputType"
   * {{{String parmDefaultValue}}} If the parmType is default, this is the value that will be used. Null if other type.
   * {{{String[] parmDomainValues}}} If the parameter can be defined by the user, these are the possible values. Null if other type.
   * {{{boolean parmRequired}}} False, if this parameter can be left out of a call.
   * {{{String parmLabel}}} The label for the parameter. Can be null.
   * {{{String parmPassBy}}} The method of passing the paramenter. Restricted to "URL_REF" (if the parameter is pass by reference - by an url) and "VALUE" (if the parameter is pass by value)
   * {{{String asOfDate}}}