|
⇤ ← Revision 1 as of 2008-10-16 15:02:04
Size: 4175
Comment:
|
Size: 4141
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| === API-A (Fedora Access service API) === | = API-A (Fedora Access service API) = |
| Line 4: | Line 4: |
| ==== describeRepository ==== | == describeRepository == |
| Line 15: | Line 15: |
| ==== getDatastreamDissemination ==== | == getDatastreamDissemination == |
| Line 31: | Line 31: |
| ==== getDissemination ==== | == getDissemination == |
| Line 49: | Line 49: |
| ==== getObjectHistory ==== | == getObjectHistory == |
| Line 63: | Line 63: |
| ==== getObjectProfile ==== | == getObjectProfile == |
| Line 78: | Line 78: |
| ==== listDatastreams ==== | == listDatastreams == |
| Line 93: | Line 93: |
| ==== listMethods ==== | == listMethods == |
| Line 105: | Line 105: |
API-A (Fedora Access service API)
Anchor(anchor_describeRepository)
describeRepository
Gets information that describes the repository.
Returns:
RepositoryInfo A data structure that contains key metadata describing the Fedora repository server including repository name, version, base URL, pid namespace, and sample request URLs. (See definition of [#anchor_RepositoryInfo RepositoryInfo] under Data structures below)
Throws:
java.rmi.RemoteException
Anchor(anchor_getDatastreamDissemination)
getDatastreamDissemination
Gets the content of a datastream.
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:
MIMETypedStream The datastream as a mime-typed stream. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)
Throws:
java.rmi.RemoteException
Anchor(anchor_getDissemination)
getDissemination
Disseminates the content produced by executing the method specified in the service definition associated the specified digital object.
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:
MIMETypedStream A MIME-typed stream containing the result of the dissemination. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)
Throws:
java.rmi.RemoteException
Anchor(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(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 The ObjectProfile of the object. (See definition of [#anchor_ObjectProfile ObjectProfile] under Data structures below)
Throws:
java.rmi.RemoteException
Anchor(anchor_listDatastreams)
listDatastreams
Lists the datastreams of an 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:
DatastreamDef[] A sequence of DatastreamDefs. (See definition of [#anchor_DatastreamDef DatastreamDef] under Data structures below)
Throws:
java.rmi.RemoteException
listMethods
Lists all the methods that the object supports.
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:
ObjectMethodsDef[] A sequence of ObjectMethodsDefs. (See definition of [#anchor_ObjectMethodsDef ObjectMethodsDef] under Data structures below)
Throws:
java.rmi.RemoteException