xsd:string addDatastream(
xsd:string pid,
xsd:string dsID,
fedora-types:ArrayOfString altIDs,
xsd:string dsLabel,
xsd:boolean versionable,
xsd:string MIMEType,
xsd:string formatURI,
xsd:string dsLocation,
xsd:string controlGroup,
xsd:string dsState,
xsd:string logMessage
)
Creates a new datastream in the object.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream (64 characters max).
If given as null, Fedora will generate an id for you.altIDs - alternate identifiers for the datastream, if any.dsLabel - the label for the datastream.versionable - whether Fedora should maintain old versions of the datastream when it is modified,
or it should just over-write the old content.MIMEType - the mime type.formatURI - the format URI (a more granular format identifier than mime type). Optional.dsLocation - the location of the datastream. The content will be retrieved from this location.controlGroup - the control group. This must be one of "X", "M", "R", or "E".dsState - the initial state of the datastream.logMessage - a log message.Returns:
xsd:string addDisseminator(
xsd:string pid,
xsd:string bDefPid,
xsd:string bMechPid,
xsd:string dissLabel,
fedora-types:DatastreamBindingMap bindingMap,
xsd:string dissState,
xsd:string logMessage
)
Creates a disseminator in the object.
Parameters:
pid - the pid of the object.bDefPid - the pid of the behavior definition object.bMechPid - the pid of the behavior mechanism object.dissLabel - the label of the disseminator.bindingMap - the binding map.dissState - the initial state of the disseminator.logMessage - a log message.Returns:
fedora-types:UserInfo describeUser(
xsd:string id
)
Gets key information about the named user.
Parameters:
id - the id of the user.Returns:
xsd:base64Binary export(
xsd:string pid,
xsd:string format,
xsd:string context
)
Exports the entire digital object in the specified XML format ("foxml1.0" or "metslikefedora1"), and encoded appropriately for the specified export context ("public", "migrate", or "archive").
Parameters:
pid - format - the desired XML format of the export file, either
"foxml1.0" for Fedora Object XML (FOXML) or "metslikefedora1"
for METS (Fedora extension of METS).context - the export context, which indicates the intended
use of the export file. Valid options are (1) "public" which produces an
export file that is appropriate for use outside of the repository (all datastream
content can be obtained via public callback URLs), (2) "migrate" which produces
an export file that is appropriate for migrating an object from one Fedora repository
to another, or (3)"archive" which produces an export file that is a standalone entity,
where all datastream content is inlines (XML inline and binary base64-encoded inline).
Note that the "archive" option is not available in Fedora 2.0.Returns:
xsd:base64Binary exportObject(
xsd:string pid
)
DEPRECATED IN FEDORA 2.0. USE export.
Parameters:
pid - the pid of the object.Returns:
fedora-types:Datastream getDatastream(
xsd:string pid,
xsd:string dsID,
xsd:string asOfDateTime
)
Gets a datastream in an object.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.asOfDateTime - the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.Returns:
fedora-types:ArrayOfDatastream getDatastreamHistory(
xsd:string pid,
xsd:string dsID
)
Gets all versions of a datastream, sorted from most to least recent.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.Returns:
fedora-types:ArrayOfDatastream getDatastreams(
xsd:string pid,
xsd:string asOfDateTime,
xsd:string dsState
)
Gets all the datastreams in an object as of a certain date/time and in a certain state.
Parameters:
pid - the pid of the object.asOfDateTime - the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.dsState - the state of the datastreams to get, null for all states.Returns:
fedora-types:Disseminator getDisseminator(
xsd:string pid,
xsd:string dissID,
xsd:string asOfDateTime
)
Gets a disseminator in an object.
Parameters:
pid - the pid of the object.dissID - the ID of the disseminator.asOfDateTime - the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.Returns:
fedora-types:ArrayOfDisseminator getDisseminatorHistory(
xsd:string pid,
xsd:string dissID
)
Gets the creation dates of each version of a disseminator.
Parameters:
pid - the pid of the object.dissID - the ID of the disseminator.Returns:
fedora-types:ArrayOfDisseminator getDisseminators(
xsd:string pid,
xsd:string asOfDateTime,
xsd:string dissState
)
Gets all disseminators in an object.
Parameters:
pid - the pid of the object.asOfDateTime - the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.dissState - the state of the disseminatorss to get, null for all states.Returns:
fedora-types:ArrayOfString getNextPID(
numPids,
xsd:string pidNamespace
)
Retrieves the specified number of next available pid(s) for a given pid namespace.
Parameters:
numPids - the number of pids requested.pidNamespace - the namespace of the requested pid(s).Returns:
xsd:base64Binary getObjectXML(
xsd:string pid
)
Gets the XML portion of the entire METS-encoded digital object for external use (viewing, editing, moving to another repository). XML metadata datastreams will be included inline, content datastreams will not be included, and external datastreams will be referenced by url.
Parameters:
pid - the pid of the object.Returns:
xsd:string ingest(
xsd:base64Binary XML,
xsd:string format,
xsd:string logMessage
)
Creates a new digital object in the repository, given the data in the provided XML document, and a format indentifier for the XML document format. The valid formats are currently: "foxml1.0" and "metslikefedora1". The object's initial state will be A (active). If the XML document does not specify the OBJID attribute of the root element, the repository will generate and return a new pid for the object resulting from this request. That pid will have the namespace of the repository. If the XML document specifies a pid, it will be assigned to the digital object provided that 1) it conforms to the Fedora pid Syntax, 2) it uses a namespace that matches the "retainPIDs" value configured for the repository, and 3) it does not collide with an existing pid of an object in the repository.
Parameters:
XML - the digital object in an XML submission format.format - the XML format of the submissionlogMessage - a log message.Returns:
xsd:string ingestObject(
xsd:base64Binary METSXML,
xsd:string logMessage
)
DEPRECATED IN FEDORA 2.0. USE ingest. Creates a new digital object in the repository, given the data in the provided XML document, and a format indentifier for the METS document format. The object's initial state will be A (active). If the XML document does not specify a pid in the OBJID attribute of the root element, the repository will generate and return a new pid for the object resulting from this request. That pid will have the namespace of the repository. If the XML document specifies a pid, it will be assigned to the digital object provided that 1) it conforms to the Fedora pid Syntax, 2) it uses a namespace that matches the "retainPIDs" value configured for the repository, and 3) it does not collide with an existing pid of an object in the repository.
Parameters:
METSXML - the digital object in the METS (Fedora Extension) XML submission format.logMessage - a log message.Returns:
xsd:string modifyDatastreamByReference(
xsd:string pid,
xsd:string dsID,
fedora-types:ArrayOfString altIDs,
xsd:string dsLabel,
xsd:boolean versionable,
xsd:string MIMEType,
xsd:string formatURI,
xsd:string dsLocation,
xsd:string dsState,
xsd:string logMessage,
xsd:boolean force
)
Modifies an existing datastream in an object, by reference.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.altIDs - alternate identifiers for the datastream, if any.dsLabel - the label for the datastream.versionable - whether Fedora should maintain old versions of the
datastream when it is modified, or it should just over-write the
old content.MIMEType - the mime type.formatURI - the format URI (a more granular format identifier than mime type). Optional.dsLocation - the url to the datastream.dsState - the state of the datastream.logMessage - a message about the change.force - whether to force the change even if it would break a data contract.Returns:
xsd:string modifyDatastreamByValue(
xsd:string pid,
xsd:string dsID,
fedora-types:ArrayOfString altIDs,
xsd:string dsLabel,
xsd:boolean versionable,
xsd:string MIMEType,
xsd:string formatURI,
xsd:base64Binary dsContent,
xsd:string dsState,
xsd:string logMessage,
xsd:boolean force
)
Modifies an existing datastream in an object, by value.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.altIDs - alternate identifiers for the datastream, if any.dsLabel - the label for the datastream.versionable - whether Fedora should maintain old versions of the
datastream when it is modified, or it should just over-write the
old content.MIMEType - the mime type.formatURI - the format URI (a more granular format identifier
than mime type). Optional.dsContent - the content of the datastream.dsState - the state of the datastream.logMessage - a message about the change.force - whether to force the change even if it would break a data contract.Returns:
xsd:string modifyDisseminator(
xsd:string pid,
xsd:string dissID,
xsd:string bMechPid,
xsd:string dissLabel,
fedora-types:DatastreamBindingMap bindingMap,
xsd:string dissState,
xsd:string logMessage,
xsd:boolean force
)
Modifies a disseminator in the object.
Parameters:
pid - the pid of the object.dissID - the ID of the disseminator.bMechPid - the pid of the behavior mechanism object.dissLabel - the label of the disseminator.bindingMap - the binding map.dissState - the state of the disseminator.logMessage - a message about the change.force - whether to force the change even if it would break a data contract.Returns:
xsd:string modifyObject(
xsd:string pid,
xsd:string state,
xsd:string label,
xsd:string logMessage
)
Changes the state and/or label of the object.
Parameters:
pid - the pid of the object.state - the new state, A, I or D. Null means leave unchanged.label - the new label. Null means leave unchanged.logMessage - a log message.Returns:
fedora-types:ArrayOfDateTimeString purgeDatastream(
xsd:string pid,
xsd:string dsID,
xsd:string endDT,
xsd:string logMessage,
xsd:boolean force
)
Permanently removes one or more versions of a datastream from an object.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.endDT - the (inclusive) ending date-time stamp of the range. If
null, this is taken to be the greatest possible value, and thus,
the entire version history of the datastream will be purged.logMessage - an explanation of the purge.force - whether to force the change even if it would break a data contract.Returns:
fedora-types:ArrayOfDateTimeString purgeDisseminator(
xsd:string pid,
xsd:string dissID,
xsd:string endDT,
xsd:string logMessage
)
Permanently removes one or more versions of a disseminator from an object.
Parameters:
pid - the pid of the object.dissID - the ID of the disseminator.endDT - the (inclusive) ending date-time stamp of the range. If
null, this is taken to be the greatest possible value.logMessage - an explanation of the purge.Returns:
xsd:string purgeObject(
xsd:string pid,
xsd:string logMessage,
xsd:boolean force
)
Permanently removes an object from the repository.
Parameters:
pid - the pid of the object.logMessage - an explanation of the purge.force - whether to force the change even if it would break a dependency.Returns:
xsd:string setDatastreamState(
xsd:string pid,
xsd:string dsID,
xsd:string dsState,
xsd:string logMessage
)
Sets the state of a datastream to the specified state value.
Parameters:
pid - the pid of the object.dsID - the ID of the datastream.dsState - the state to be set on the datastream.logMessage - a message about the change.Returns:
xsd:string setDisseminatorState(
xsd:string pid,
xsd:string dissID,
xsd:string dissState,
xsd:string logMessage
)
Sets the state of a disseminator to the specified value.
Parameters:
pid - the pid of the object.dissID - the ID of the disseminator.dissState - the state to be set on the disseminator.logMessage - a message about the change.Returns: