org.dataone.service.types.v1

Class ObjectLocationList

java.lang.Object

org.dataone.service.types.v1.ObjectLocationList

All Implemented Interfaces:

Serializable

public class ObjectLocationList
extends Object
implements Serializable

An *ObjectLocationList* is the structure returned from the :func:`CNRead.resolve` method of the CN REST interface. It provides a list of locations from which the specified object can be retrieved. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ObjectLocationList">
   <xs:sequence>
     <xs:element type="ns:Identifier" name="identifier" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:ObjectLocation" name="objectLocation" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectLocationList()

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectLocation(ObjectLocation item) Add a 'objectLocation' element item.
void	clearObjectLocationList() Remove all 'objectLocation' element items.
Identifier	getIdentifier() Get the 'identifier' element value.
ObjectLocation	getObjectLocation(int index) Get 'objectLocation' element item by position.
List<ObjectLocation>	getObjectLocationList() Get the list of 'objectLocation' element items.
void	setIdentifier(Identifier identifier) Set the 'identifier' element value.
void	setObjectLocationList(List<ObjectLocation> list) Set the list of 'objectLocation' element items.
int	sizeObjectLocationList() Get the number of 'objectLocation' element items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectLocationList

public ObjectLocationList()

Method Detail

getIdentifier

public Identifier getIdentifier()

Get the 'identifier' element value. The :term:`identifier` of the object being resolved.

Returns:

value

setIdentifier

public void setIdentifier(Identifier identifier)

Set the 'identifier' element value. The :term:`identifier` of the object being resolved.

Parameters:

identifier -

getObjectLocationList

public List<ObjectLocation> getObjectLocationList()

Get the list of 'objectLocation' element items. List of nodes from which the object can be retrieved

Returns:

list

setObjectLocationList

public void setObjectLocationList(List<ObjectLocation> list)

Set the list of 'objectLocation' element items. List of nodes from which the object can be retrieved

Parameters:

list -

sizeObjectLocationList

public int sizeObjectLocationList()

Get the number of 'objectLocation' element items.

Returns:

count

addObjectLocation

public void addObjectLocation(ObjectLocation item)

Add a 'objectLocation' element item.

Parameters:

item -

getObjectLocation

public ObjectLocation getObjectLocation(int index)

Get 'objectLocation' element item by position.

Parameters:

index -

Returns:

item

clearObjectLocationList

public void clearObjectLocationList()

Remove all 'objectLocation' element items.