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:

• A sequence/array of:

  • 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]

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:

• A sequence/array of [:/../DataStructures#MethodDef: MethodDef]s, one for each of the disseminators on the object

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