...
- RepositoryInfo** String repositoryName - The name of the Repository. Set in fedora.fcfg. Default "Fedora Repository"
- String repositoryVersion - The version of Fedora running. Fedora 3.0 returns "3.0"
- String repositoryBaseURL - The repository base url set in fedora.fcfg. Default "http://localhost:8080/fedora"
- String repositoryPIDNamespace - The prefix to use for newly generated PIDs
- String defaultExportFormat
- String OAINamespace - The oai namespace. Default "example.org"
_String\[\] adminEmailList_ \ - The email to the administrator. Default "bob@example.org" and "sally@example.org". Defined in fedora.fcfg.Wiki Markup - String samplePID - An example pid, to show how to refer to objects. "doms:100"
- String sampleOAIIdentifier - An example oai identifier, to show how to refer to records. Example: "oai:example.org:doms:100"
- String sampleSearchURL - The url to the search service for the repository. Default "http://localhost:8080/fedora/search"
- String sampleAccessURL - The url to an example object in the repository. Default "http://localhost:8080/fedora/get/demo:5"
- String sampleOAIURL - The url to an oai record. Default "http://localhost:8080/fedora/oai?verb=Identify"
_String\[\] retainPIDs_ \ - The list of pid prefixes, that cause the pid to not be autogenerated.Wiki Markup
Object Access Methods
findObjects
Anchor | ||||
---|---|---|---|---|
|
Lists the specified fields of each object matching the given criteria.
Input parameters:
_String\[\] resultfields_ The names of the fields to String[] resultfields The names of the fields to return.Wiki Markup - int maxResults The maximum number of results to return in one FieldSearchResult. Further results can be queried with the resumeFindObjects method.
- FieldSearchQuery query: The terms or conditions for the search. Either terms or conditions are used, not both.
- String terms: The search termsunmigrated-wiki-markup
- _Condition\[\] conditions_: The conditions on the results
- String property: The property to condition. Possible fields are the same as for resultfields.
- Operator operator: Possible values are: "has", "eq", "lt", "le", "gt" and "ge"
- String value: The value the constrained property must adhere to
...
- FieldSearchResult** ListSession listsession The information nessesary for resuming the search.
- String token: The token to be used in resumeFindObjects
- int cursor: The index of the first object in this resultlist, in the complete resultlist.
- int completeListSize: The size of the complete resultlist.
- String expirationDate: The expirationdate for the token. The last time when the search can be resumed.
- _ObjectFields\[\] resultlist_: the specified fields of each object matching the given criteria.
- String pid Only set if the relevant field was set in resultfields
- String label Only set if the relevant field was set in resultfields
- String state Only set if the relevant field was set in resultfields
- String ownerId Only set if the relevant field was set in resultfields
- String cDate Only set if the relevant field was set in resultfields
- String mDate Only set if the relevant field was set in resultfields
- String dcmDate Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] title_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] creator_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] subject_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] description_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] publisher_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] contributor_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] date_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] type_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] format_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] identifier_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] source_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] language_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] relation_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] coverage_ Only set if the relevant field was set in resultfields
- String[] title Only set if the relevant field was set in resultfields
- String[] creator Only set if the relevant field was set in resultfields
- String[] subject Only set if the relevant field was set in resultfields
- String[] description Only set if the relevant field was set in resultfields
- String[] publisher Only set if the relevant field was set in resultfields
- String[] contributor Only set if the relevant field was set in resultfields
- String[] date Only set if the relevant field was set in resultfields
- String[] type Only set if the relevant field was set in resultfields
- String[] format Only set if the relevant field was set in resultfields
- String[] identifier Only set if the relevant field was set in resultfields
- String[] source Only set if the relevant field was set in resultfields
- String[] language Only set if the relevant field was set in resultfields
- String[] relation Only set if the relevant field was set in resultfields
- String[] coverage Only set if the relevant field was set in resultfields
- String[] rights Only set if the relevant field was set in
_String\[\] rights_ Only set if the relevant field was set in resultfieldsWiki Markup
Note:
The only way to get the Object State (or OwnerID) is via a findObjects call. Use these parameters to query the state of a object.
...
- _String\[\] resultfields_ = \ ["pid", "state"\]
- int maxResults = null
- FieldSearchQuery query:
- unmigrated-wiki-markup
- _Condition\[\] conditions_:
- String property: "pid"
- Operator operator: "eq"
- String value: "The pid of the object you want to find"
- _Condition\[\] conditions_:
...
- FieldSearchResult** ListSession listsession The information nessesary for resuming the search.
- String token: The token to be used in resumeFindObjects
- int cursor: The index of the first object in this resultlist, in the complete resultlist.
- int completeListSize: The size of the complete resultlist.
- String expirationDate: The expirationdate for the token. The last time when the search can be resumed.
- _ObjectFields\[\] resultlist_: the specified fields of each object matching the given criteria.
- String pid Only set if the relevant field was set in resultfields
- String label Only set if the relevant field was set in resultfields
- String state Only set if the relevant field was set in resultfields
- String ownerId Only set if the relevant field was set in resultfields
- String cDate Only set if the relevant field was set in resultfields
- String mDate Only set if the relevant field was set in resultfields
- String dcmDate Only set if the relevant field was set in resultfields
_String\[\] title_ Only set if the relevant field was set in resultfieldsunmigrated-wiki-markup_Wiki Markup - String\[\] creator_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] subject_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] description_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] publisher_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] contributor_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] date_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] type_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] format_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] identifier_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] source_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] language_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] relation_ Only set if the relevant field was set in resultfields
Wiki Markup _String\[\] coverage_ Only set if the relevant field was set in resultfields
- set in resultfields
- String[] subject Only set if the relevant field was set in resultfields
- String[] description Only set if the relevant field was set in resultfields
- String[] publisher Only set if the relevant field was set in resultfields
- String[] contributor Only set if the relevant field was set in resultfields
- String[] date Only set if the relevant field was set in resultfields
- String[] type Only set if the relevant field was set in resultfields
- String[] format Only set if the relevant field was set in resultfields
- String[] identifier Only set if the relevant field was set in resultfields
- String[] source Only set if the relevant field was set in resultfields
- String[] language Only set if the relevant field was set in resultfields
- String[] relation Only set if the relevant field was set in resultfields
- String[] coverage Only set if the relevant field was set in resultfields
- String[] rights Only set if the relevant field was set in
_String\[\] rights_ Only set if the relevant field was set in resultfieldsWiki Markup
getObjectHistory
Anchor | ||||
---|---|---|---|---|
|
...
- String pid The pid of the object.
Returns:
...
- _String\[\]_ An array containing the list of timestamps indicating when changes were made to the object.
getObjectProfile
Anchor | ||||
---|---|---|---|---|
|
...
- ObjectProfile Contains these fields
- String pid The pid of the object
- String objLabel The label of the object
_String\[\] objModels_ The pids of the content models of the objectWiki Markup - String objCreateDate The creation date
- String objLastModDate The last modification time
- String objDissIndexViewURL The REST url for the Dissemination index, as known from the built in search service
- String objItemIndexViewURL The REST url for the Datastream index, as known from the built in search service
...
- MIMETypedStream** String MIMEType The mimetype of the stream
- unmigrated-wiki-markup
- _byte\[\] stream_ The contents of the Streamunmigrated-wiki-markup
- _Property\[\] header_ The header will be empty, or if applicable, contain the http header as name/value pairs.
- String name
- String value
listDatastreams
...
- 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 datastream definition object, containing the following values
- String ID The datastream id - "DC" for the DC datastream
- String label The datastream label
- String MIMEType The mimetype of the datastream, if any
...
- 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.unmigrated-wiki-markup
- _Property\[\] parameters_ name-value pairs.
- String name
- String value
- String asOfDateTime The versioning dateTime. If null, Fedora will use the most recent version.
...
- MIMETypedStream** String MIMEType The mimetype of the stream stream
- byte[] stream The contents of the Stream
- Property[] header The header will be empty, or if applicable, contain the http header as name/value
Wiki Markup _byte\[\] stream_ The contents of the Stream
_Property\[\] header_ The header will be empty, or if applicable, contain the http header as name/value pairs.Wiki Markup - String name
- String value
listMethods
...
- 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_ The pid of the data object
- String serviceDefinitionPID The pid of the service definition object
- String methodName the name of the method
Wiki Markup - _MethodParmDef\[\] methodParmDefs_ An array of the method parameters
- 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.unmigrated-wiki-markup
- _String\[\] parmDomainValues_ If the parameter can be defined by the user, these are the possible values. If Null, the parameter can take any value. 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 The timestamp/version of the method definition
...