org.oclc.da.gdfr.registryprototype
Interface CollectionItem

All Superinterfaces:
java.lang.Cloneable, DataObject, StructuredDataObject
All Known Implementing Classes:
BasicStructuredObject, StubStructuredObject

public interface CollectionItem
extends StructuredDataObject


Method Summary
 AdminData getAdminData()
          Returns the admin data for the CollectionItem in an Xml String
 Content getPayload()
          Gets the data associated with the collection item.
 Ref getRef()
          Creates and returns a Ref based on this CollectionItem
 boolean setAdminData(AdminData data)
          Sets the admin data for the given CollectionItem
 boolean setPayload(Content data)
          Adds data to a CollectionItem
 
Methods inherited from interface org.oclc.da.gdfr.registryprototype.StructuredDataObject
getAttr, setAttr, setAttr, setAttr, setAttr
 
Methods inherited from interface org.oclc.da.gdfr.registryprototype.DataObject
getBytestream, setBytestream
 

Method Detail

getAdminData

AdminData getAdminData()
Returns the admin data for the CollectionItem in an Xml String

Returns:
An Xml String or null if any exceptions were caught

getPayload

Content getPayload()
Gets the data associated with the collection item. This includes both the content and the admin data.

Returns:
An Xml String or null if any exceptions were caught

getRef

Ref getRef()
Creates and returns a Ref based on this CollectionItem

Returns:
A Ref for this CollectionItem.

setAdminData

boolean setAdminData(AdminData data)
Sets the admin data for the given CollectionItem

Parameters:
data - Xml String representing the admin data
Returns:
True, if the update was successful, false otherwise.

setPayload

boolean setPayload(Content data)
Adds data to a CollectionItem

Parameters:
data - The data to be added
Returns:
True, if the update was successful, false otherwise.


Copyright © 2008 OCLC Online Computer Library Center, Inc.. All Rights Reserved.