org.gcube.common.core.informationsystem.publisher

Interface ISResource

public interface ISResource

Information System resource

Author:

Manuele Simi (ISTI-CNR)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ISResource.ISRESOURCETYPE

Method Summary

Methods

Modifier and Type	Method and Description
String	getCollection() Gets the collection in which the resource is registered.
Document	getDocument() Gets the payload of the resource
String	getID() Gets the identifier assigned to the resource
String	getName() Gets the resource name
ISResource.ISRESOURCETYPE	getType() Gets the resource type
void	setCollection(String collection) The collection in which the resource is registered.
void	setDocument(Document document) The payload of the resource
void	setID(String id) The identifier assigned to the resource
void	setName(String name) Sets the resource name
void	setType(ISResource.ISRESOURCETYPE type) Sets the resource type

Method Detail

setName

void setName(String name)

Sets the resource name

Parameters:

documentName - the resource name

setType

void setType(ISResource.ISRESOURCETYPE type)

Sets the resource type

Parameters:

type - the resource type

getType

ISResource.ISRESOURCETYPE getType()

Gets the resource type

getName

String getName()

Gets the resource name

Returns:

the resource name

setDocument

void setDocument(Document document)

The payload of the resource

Parameters:

document - the document

Throws:

InvalidISResourceParameterException

getDocument

Document getDocument()

Gets the payload of the resource

Returns:

the document

setCollection

void setCollection(String collection)

The collection in which the resource is registered. The name could be also a path where tokens are separated by a slash (e.g. mycollection/mychild)

Parameters:

collection - the collection name

getCollection

String getCollection()

Gets the collection in which the resource is registered.

Returns:

the collection full path

setID

void setID(String id)

The identifier assigned to the resource

Parameters:

id - the identifier

getID

String getID()

Gets the identifier assigned to the resource